chan_agent.c

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 1999 - 2012, Digium, Inc.
 *
 * Mark Spencer <markster@digium.com>
 *
 * See http://www.asterisk.org for more information about
 * the Asterisk project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */


/*! \file
 * 
 * \brief Implementation of Agents (proxy channel)
 *
 * \author Mark Spencer <markster@digium.com>
 *
 * This file is the implementation of Agents modules.
 * It is a dynamic module that is loaded by Asterisk. 
 * \par See also
 * \arg \ref Config_agent
 *
 * \ingroup channel_drivers
 */
/*** MODULEINFO
        <depend>chan_local</depend>
        <depend>res_monitor</depend>
   <support_level>core</support_level>
 ***/

#include "asterisk.h"

ASTERISK_FILE_VERSION(__FILE__, "$Revision: 359451 $")

#include <sys/socket.h>
#include <fcntl.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/signal.h>

#include "asterisk/lock.h"
#include "asterisk/channel.h"
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/sched.h"
#include "asterisk/io.h"
#include "asterisk/acl.h"
#include "asterisk/callerid.h"
#include "asterisk/file.h"
#include "asterisk/cli.h"
#include "asterisk/app.h"
#include "asterisk/musiconhold.h"
#include "asterisk/manager.h"
#include "asterisk/features.h"
#include "asterisk/utils.h"
#include "asterisk/causes.h"
#include "asterisk/astdb.h"
#include "asterisk/devicestate.h"
#include "asterisk/monitor.h"
#include "asterisk/stringfields.h"
#include "asterisk/event.h"
#include "asterisk/data.h"

/*** DOCUMENTATION
   <application name="AgentLogin" language="en_US">
      <synopsis>
         Call agent login.
      </synopsis>
      <syntax>
         <parameter name="AgentNo" />
         <parameter name="options">
            <optionlist>
               <option name="s">
                  <para>silent login - do not announce the login ok segment after
                  agent logged on/off</para>
               </option>
            </optionlist>
         </parameter>
      </syntax>
      <description>
         <para>Asks the agent to login to the system. Always returns <literal>-1</literal>.
         While logged in, the agent can receive calls and will hear a <literal>beep</literal>
         when a new call comes in. The agent can dump the call by pressing the star key.</para>
      </description>
      <see-also>
         <ref type="application">Queue</ref>
         <ref type="application">AddQueueMember</ref>
         <ref type="application">RemoveQueueMember</ref>
         <ref type="application">PauseQueueMember</ref>
         <ref type="application">UnpauseQueueMember</ref>
         <ref type="function">AGENT</ref>
         <ref type="filename">agents.conf</ref>
         <ref type="filename">queues.conf</ref>
      </see-also>
   </application>
   <application name="AgentMonitorOutgoing" language="en_US">
      <synopsis>
         Record agent's outgoing call.
      </synopsis>
      <syntax>
         <parameter name="options">
            <optionlist>
               <option name="d">
                  <para>make the app return <literal>-1</literal> if there is an error condition.</para>
               </option>
               <option name="c">
                  <para>change the CDR so that the source of the call is
                  <literal>Agent/agent_id</literal></para>
               </option>
               <option name="n">
                  <para>don't generate the warnings when there is no callerid or the
                  agentid is not known. It's handy if you want to have one context
                  for agent and non-agent calls.</para>
               </option>
            </optionlist>
         </parameter>
      </syntax>
      <description>
         <para>Tries to figure out the id of the agent who is placing outgoing call based on
         comparison of the callerid of the current interface and the global variable
         placed by the AgentCallbackLogin application. That's why it should be used only
         with the AgentCallbackLogin app. Uses the monitoring functions in chan_agent
         instead of Monitor application. That has to be configured in the
         <filename>agents.conf</filename> file.</para>
         <para>Normally the app returns <literal>0</literal> unless the options are passed.</para>
      </description>
      <see-also>
         <ref type="filename">agents.conf</ref>
      </see-also>
   </application>
   <function name="AGENT" language="en_US">
      <synopsis>
         Gets information about an Agent
      </synopsis>
      <syntax argsep=":">
         <parameter name="agentid" required="true" />
         <parameter name="item">
            <para>The valid items to retrieve are:</para>
            <enumlist>
               <enum name="status">
                  <para>(default) The status of the agent (LOGGEDIN | LOGGEDOUT)</para>
               </enum>
               <enum name="password">
                  <para>The password of the agent</para>
               </enum>
               <enum name="name">
                  <para>The name of the agent</para>
               </enum>
               <enum name="mohclass">
                  <para>MusicOnHold class</para>
               </enum>
               <enum name="channel">
                  <para>The name of the active channel for the Agent (AgentLogin)</para>
               </enum>
               <enum name="fullchannel">
                  <para>The untruncated name of the active channel for the Agent (AgentLogin)</para>
               </enum>
            </enumlist>
         </parameter>
      </syntax>
      <description></description>
   </function>
   <manager name="Agents" language="en_US">
      <synopsis>
         Lists agents and their status.
      </synopsis>
      <syntax>
         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
      </syntax>
      <description>
         <para>Will list info about all possible agents.</para>
      </description>
   </manager>
   <manager name="AgentLogoff" language="en_US">
      <synopsis>
         Sets an agent as no longer logged in.
      </synopsis>
      <syntax>
         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
         <parameter name="Agent" required="true">
            <para>Agent ID of the agent to log off.</para>
         </parameter>
         <parameter name="Soft">
            <para>Set to <literal>true</literal> to not hangup existing calls.</para>
         </parameter>
      </syntax>
      <description>
         <para>Sets an agent as no longer logged in.</para>
      </description>
   </manager>
 ***/

static const char tdesc[] = "Call Agent Proxy Channel";
static const char config[] = "agents.conf";

static const char app[] = "AgentLogin";
static const char app3[] = "AgentMonitorOutgoing";

static char moh[80] = "default";

#define AST_MAX_AGENT   80                          /*!< Agent ID or Password max length */
#define AST_MAX_BUF  256
#define AST_MAX_FILENAME_LEN  256

static const char pa_family[] = "Agents";          /*!< Persistent Agents astdb family */
#define PA_MAX_LEN 2048                             /*!< The maximum length of each persistent member agent database entry */

#define DEFAULT_ACCEPTDTMF '#'
#define DEFAULT_ENDDTMF '*'

static ast_group_t group;
static int autologoff;
static int wrapuptime;
static int ackcall;
static int endcall;
static int multiplelogin = 1;
static int autologoffunavail = 0;
static char acceptdtmf = DEFAULT_ACCEPTDTMF;
static char enddtmf = DEFAULT_ENDDTMF;

static int maxlogintries = 3;
static char agentgoodbye[AST_MAX_FILENAME_LEN] = "vm-goodbye";

static int recordagentcalls = 0;
static char recordformat[AST_MAX_BUF] = "";
static char recordformatext[AST_MAX_BUF] = "";
static char urlprefix[AST_MAX_BUF] = "";
static char savecallsin[AST_MAX_BUF] = "";
static int updatecdr = 0;
static char beep[AST_MAX_BUF] = "beep";

#define GETAGENTBYCALLERID "AGENTBYCALLERID"

enum {
   AGENT_FLAG_ACKCALL = (1 << 0),
   AGENT_FLAG_AUTOLOGOFF = (1 << 1),
   AGENT_FLAG_WRAPUPTIME = (1 << 2),
   AGENT_FLAG_ACCEPTDTMF = (1 << 3),
   AGENT_FLAG_ENDDTMF = (1 << 4),
};

/*! \brief Structure representing an agent.  */
struct agent_pvt {
   ast_mutex_t lock;              /*!< Channel private lock */
   int dead;                      /*!< Poised for destruction? */
   int pending;                   /*!< Not a real agent -- just pending a match */
   int abouttograb;               /*!< About to grab */
   int autologoff;                /*!< Auto timeout time */
   int ackcall;                   /*!< ackcall */
   int deferlogoff;               /*!< Defer logoff to hangup */
   char acceptdtmf;
   char enddtmf;
   time_t loginstart;             /*!< When agent first logged in (0 when logged off) */
   time_t start;                  /*!< When call started */
   struct timeval lastdisc;       /*!< When last disconnected */
   int wrapuptime;                /*!< Wrapup time in ms */
   ast_group_t group;             /*!< Group memberships */
   int acknowledged;              /*!< Acknowledged */
   char moh[80];                  /*!< Which music on hold */
   char agent[AST_MAX_AGENT];     /*!< Agent ID */
   char password[AST_MAX_AGENT];  /*!< Password for Agent login */
   char name[AST_MAX_AGENT];
   int app_lock_flag;
   ast_cond_t app_complete_cond;
   ast_cond_t login_wait_cond;
   volatile int app_sleep_cond;   /**< Sleep condition for the login app */
   struct ast_channel *owner;     /**< Agent */
   char logincallerid[80];        /**< Caller ID they had when they logged in */
   struct ast_channel *chan;      /**< Channel we use */
   unsigned int flags;            /**< Flags show if settings were applied with channel vars */
   AST_LIST_ENTRY(agent_pvt) list;  /**< Next Agent in the linked list. */
};

#define DATA_EXPORT_AGENT(MEMBER)            \
   MEMBER(agent_pvt, autologoff, AST_DATA_INTEGER)    \
   MEMBER(agent_pvt, ackcall, AST_DATA_BOOLEAN)    \
   MEMBER(agent_pvt, deferlogoff, AST_DATA_BOOLEAN)   \
   MEMBER(agent_pvt, wrapuptime, AST_DATA_MILLISECONDS)  \
   MEMBER(agent_pvt, acknowledged, AST_DATA_BOOLEAN)  \
   MEMBER(agent_pvt, name, AST_DATA_STRING)     \
   MEMBER(agent_pvt, password, AST_DATA_PASSWORD)     \
   MEMBER(agent_pvt, acceptdtmf, AST_DATA_CHARACTER)  \
   MEMBER(agent_pvt, logincallerid, AST_DATA_STRING)

AST_DATA_STRUCTURE(agent_pvt, DATA_EXPORT_AGENT);

static AST_LIST_HEAD_STATIC(agents, agent_pvt); /*!< Holds the list of agents (loaded form agents.conf). */

#define CHECK_FORMATS(ast, p) do { \
   if (p->chan) {\
      if (ast->nativeformats != p->chan->nativeformats) { \
         char tmp1[256], tmp2[256]; \
         ast_debug(1, "Native formats changing from '%s' to '%s'\n", ast_getformatname_multiple(tmp1, sizeof(tmp1), ast->nativeformats), ast_getformatname_multiple(tmp2, sizeof(tmp2), p->chan->nativeformats)); \
         /* Native formats changed, reset things */ \
         ast->nativeformats = p->chan->nativeformats; \
         ast_debug(1, "Resetting read to '%s' and write to '%s'\n", ast_getformatname_multiple(tmp1, sizeof(tmp1), ast->readformat), ast_getformatname_multiple(tmp2, sizeof(tmp2), ast->writeformat));\
         ast_set_read_format(ast, ast->readformat); \
         ast_set_write_format(ast, ast->writeformat); \
      } \
      if (p->chan->readformat != ast->rawreadformat && !p->chan->generator)  \
         ast_set_read_format(p->chan, ast->rawreadformat); \
      if (p->chan->writeformat != ast->rawwriteformat && !p->chan->generator) \
         ast_set_write_format(p->chan, ast->rawwriteformat); \
   } \
} while(0)

/*! \brief Cleanup moves all the relevant FD's from the 2nd to the first, but retains things
   properly for a timingfd XXX This might need more work if agents were logged in as agents or other
   totally impractical combinations XXX */

#define CLEANUP(ast, p) do { \
   int x; \
   if (p->chan) { \
      for (x=0;x<AST_MAX_FDS;x++) {\
         if (x != AST_TIMING_FD) \
            ast_channel_set_fd(ast, x, p->chan->fds[x]); \
      } \
      ast_channel_set_fd(ast, AST_AGENT_FD, p->chan->fds[AST_TIMING_FD]); \
   } \
} while(0)

/*--- Forward declarations */
static struct ast_channel *agent_request(const char *type, format_t format, const struct ast_channel *requestor, void *data, int *cause);
static int agent_devicestate(void *data);
static int agent_digit_begin(struct ast_channel *ast, char digit);
static int agent_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
static int agent_call(struct ast_channel *ast, char *dest, int timeout);
static int agent_hangup(struct ast_channel *ast);
static int agent_answer(struct ast_channel *ast);
static struct ast_frame *agent_read(struct ast_channel *ast);
static int agent_write(struct ast_channel *ast, struct ast_frame *f);
static int agent_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
static int agent_sendtext(struct ast_channel *ast, const char *text);
static int agent_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
static int agent_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct ast_channel *bridge);
static char *complete_agent_logoff_cmd(const char *line, const char *word, int pos, int state);
static struct ast_channel* agent_get_base_channel(struct ast_channel *chan);
static int agent_set_base_channel(struct ast_channel *chan, struct ast_channel *base);
static int agent_logoff(const char *agent, int soft);

/*! \brief Channel interface description for PBX integration */
static const struct ast_channel_tech agent_tech = {
   .type = "Agent",
   .description = tdesc,
   .capabilities = -1,
   .requester = agent_request,
   .devicestate = agent_devicestate,
   .send_digit_begin = agent_digit_begin,
   .send_digit_end = agent_digit_end,
   .call = agent_call,
   .hangup = agent_hangup,
   .answer = agent_answer,
   .read = agent_read,
   .write = agent_write,
   .write_video = agent_write,
   .send_html = agent_sendhtml,
   .send_text = agent_sendtext,
   .exception = agent_read,
   .indicate = agent_indicate,
   .fixup = agent_fixup,
   .bridged_channel = agent_bridgedchannel,
   .get_base_channel = agent_get_base_channel,
   .set_base_channel = agent_set_base_channel,
};

/*!
 * \brief Locks the owning channel for a LOCKED pvt while obeying locking order. The pvt
 * must enter this function locked and will be returned locked, but this function will
 * unlock the pvt for a short time, so it can't be used while expecting the pvt to remain
 * static. If function returns a non NULL channel, it will need to be unlocked and
 * unrefed once it is no longer needed.
 *
 * \param pvt Pointer to the LOCKED agent_pvt for which the owner is needed
 * \ret locked channel which owns the pvt at the time of completion. NULL if not available.
 */
static struct ast_channel *agent_lock_owner(struct agent_pvt *pvt)
{
   struct ast_channel *owner;

   for (;;) {
      if (!pvt->owner) { /* No owner. Nothing to do. */
         return NULL;
      }

      /* If we don't ref the owner, it could be killed when we unlock the pvt. */
      owner = ast_channel_ref(pvt->owner);

      /* Locking order requires us to lock channel, then pvt. */
      ast_mutex_unlock(&pvt->lock);
      ast_channel_lock(owner);
      ast_mutex_lock(&pvt->lock);

      /* Check if owner changed during pvt unlock period */
      if (owner != pvt->owner) { /* Channel changed. Unref and do another pass. */
         ast_channel_unlock(owner);
         owner = ast_channel_unref(owner);
      } else { /* Channel stayed the same. Return it. */
         return owner;
      }
   }
}

/*!
 * Adds an agent to the global list of agents.
 *
 * \param agent A string with the username, password and real name of an agent. As defined in agents.conf. Example: "13,169,John Smith"
 * \param pending If it is pending or not.
 * @return The just created agent.
 * \sa agent_pvt, agents.
 */
static struct agent_pvt *add_agent(const char *agent, int pending)
{
   char *parse;
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(agt);
      AST_APP_ARG(password);
      AST_APP_ARG(name);
   );
   char *password = NULL;
   char *name = NULL;
   char *agt = NULL;
   struct agent_pvt *p;

   parse = ast_strdupa(agent);

   /* Extract username (agt), password and name from agent (args). */
   AST_STANDARD_APP_ARGS(args, parse);

   if(args.argc == 0) {
      ast_log(LOG_WARNING, "A blank agent line!\n");
      return NULL;
   }

   if(ast_strlen_zero(args.agt) ) {
      ast_log(LOG_WARNING, "An agent line with no agentid!\n");
      return NULL;
   } else
      agt = args.agt;

   if(!ast_strlen_zero(args.password)) {
      password = args.password;
      while (*password && *password < 33) password++;
   }
   if(!ast_strlen_zero(args.name)) {
      name = args.name;
      while (*name && *name < 33) name++;
   }
   
   /* Are we searching for the agent here ? To see if it exists already ? */
   AST_LIST_TRAVERSE(&agents, p, list) {
      if (!pending && !strcmp(p->agent, agt))
         break;
   }
   if (!p) {
      // Build the agent.
      if (!(p = ast_calloc(1, sizeof(*p))))
         return NULL;
      ast_copy_string(p->agent, agt, sizeof(p->agent));
      ast_mutex_init(&p->lock);
      ast_cond_init(&p->app_complete_cond, NULL);
      ast_cond_init(&p->login_wait_cond, NULL);
      p->app_lock_flag = 0;
      p->app_sleep_cond = 1;
      p->group = group;
      p->pending = pending;
      AST_LIST_INSERT_TAIL(&agents, p, list);
   }
   
   ast_copy_string(p->password, password ? password : "", sizeof(p->password));
   ast_copy_string(p->name, name ? name : "", sizeof(p->name));
   ast_copy_string(p->moh, moh, sizeof(p->moh));
   if (!ast_test_flag(p, AGENT_FLAG_ACKCALL)) {
      p->ackcall = ackcall;
   }
   if (!ast_test_flag(p, AGENT_FLAG_AUTOLOGOFF)) {
      p->autologoff = autologoff;
   }
   if (!ast_test_flag(p, AGENT_FLAG_ACCEPTDTMF)) {
      p->acceptdtmf = acceptdtmf;
   }
   if (!ast_test_flag(p, AGENT_FLAG_ENDDTMF)) {
      p->enddtmf = enddtmf;
   }

   /* If someone reduces the wrapuptime and reloads, we want it
    * to change the wrapuptime immediately on all calls */
   if (!ast_test_flag(p, AGENT_FLAG_WRAPUPTIME) && p->wrapuptime > wrapuptime) {
      struct timeval now = ast_tvnow();
      /* XXX check what is this exactly */

      /* We won't be pedantic and check the tv_usec val */
      if (p->lastdisc.tv_sec > (now.tv_sec + wrapuptime/1000)) {
         p->lastdisc.tv_sec = now.tv_sec + wrapuptime/1000;
         p->lastdisc.tv_usec = now.tv_usec;
      }
   }
   p->wrapuptime = wrapuptime;

   if (pending)
      p->dead = 1;
   else
      p->dead = 0;
   return p;
}

/*!
 * Deletes an agent after doing some clean up.
 * Further documentation: How safe is this function ? What state should the agent be to be cleaned.
 * \param p Agent to be deleted.
 * \returns Always 0.
 */
static int agent_cleanup(struct agent_pvt *p)
{
   struct ast_channel *chan = NULL;
   ast_mutex_lock(&p->lock);
   chan = p->owner;
   p->owner = NULL;
   chan->tech_pvt = NULL;
   /* Release ownership of the agent to other threads (presumably running the login app). */
   p->app_sleep_cond = 1;
   p->app_lock_flag = 0;
   ast_cond_signal(&p->app_complete_cond);
   if (chan) {
      chan = ast_channel_release(chan);
   }
   if (p->dead) {
      ast_mutex_unlock(&p->lock);
      ast_mutex_destroy(&p->lock);
      ast_cond_destroy(&p->app_complete_cond);
      ast_cond_destroy(&p->login_wait_cond);
      ast_free(p);
        }
   return 0;
}

static int check_availability(struct agent_pvt *newlyavailable, int needlock);

static int agent_answer(struct ast_channel *ast)
{
   ast_log(LOG_WARNING, "Huh?  Agent is being asked to answer?\n");
   return -1;
}

static int __agent_start_monitoring(struct ast_channel *ast, struct agent_pvt *p, int needlock)
{
   char tmp[AST_MAX_BUF],tmp2[AST_MAX_BUF], *pointer;
   char filename[AST_MAX_BUF];
   int res = -1;
   if (!p)
      return -1;
   if (!ast->monitor) {
      snprintf(filename, sizeof(filename), "agent-%s-%s",p->agent, ast->uniqueid);
      /* substitute . for - */
      if ((pointer = strchr(filename, '.')))
         *pointer = '-';
      snprintf(tmp, sizeof(tmp), "%s%s", savecallsin, filename);
      ast_monitor_start(ast, recordformat, tmp, needlock, X_REC_IN | X_REC_OUT);
      ast_monitor_setjoinfiles(ast, 1);
      snprintf(tmp2, sizeof(tmp2), "%s%s.%s", urlprefix, filename, recordformatext);
#if 0
      ast_verbose("name is %s, link is %s\n",tmp, tmp2);
#endif
      if (!ast->cdr)
         ast->cdr = ast_cdr_alloc();
      ast_cdr_setuserfield(ast, tmp2);
      res = 0;
   } else
      ast_log(LOG_ERROR, "Recording already started on that call.\n");
   return res;
}

static int agent_start_monitoring(struct ast_channel *ast, int needlock)
{
   return __agent_start_monitoring(ast, ast->tech_pvt, needlock);
}

static struct ast_frame *agent_read(struct ast_channel *ast)
{
   struct agent_pvt *p = ast->tech_pvt;
   struct ast_frame *f = NULL;
   static struct ast_frame answer_frame = { AST_FRAME_CONTROL, { AST_CONTROL_ANSWER } };
   int cur_time = time(NULL);
   struct ast_channel *owner;

   ast_mutex_lock(&p->lock);
   owner = agent_lock_owner(p);

   CHECK_FORMATS(ast, p);
   if (!p->start) {
      p->start = cur_time;
   }
   if (p->chan) {
      ast_copy_flags(p->chan, ast, AST_FLAG_EXCEPTION);
      p->chan->fdno = (ast->fdno == AST_AGENT_FD) ? AST_TIMING_FD : ast->fdno;
      f = ast_read(p->chan);
   } else
      f = &ast_null_frame;
   if (!f) {
      /* If there's a channel, make it NULL */
      if (p->chan) {
         p->chan->_bridge = NULL;
         p->chan = NULL;
         ast_devstate_changed(AST_DEVICE_UNAVAILABLE, "Agent/%s", p->agent);
         p->acknowledged = 0;
      }
   } else {
      /* if acknowledgement is not required, and the channel is up, we may have missed
         an AST_CONTROL_ANSWER (if there was one), so mark the call acknowledged anyway */
      if (!p->ackcall && !p->acknowledged && p->chan && (p->chan->_state == AST_STATE_UP)) {
         p->acknowledged = 1;
      }

      if (!p->acknowledged) {
         int howlong = cur_time - p->start;
         if (p->autologoff && (howlong >= p->autologoff)) {
            ast_log(LOG_NOTICE, "Agent '%s' didn't answer/confirm within %d seconds (waited %d)\n", p->name, p->autologoff, howlong);
            if (owner || p->chan) {
               if (owner) {
                  ast_softhangup(owner, AST_SOFTHANGUP_EXPLICIT);
                  ast_channel_unlock(owner);
                  owner = ast_channel_unref(owner);
               }

               while (p->chan && ast_channel_trylock(p->chan)) {
                  DEADLOCK_AVOIDANCE(&p->lock);
               }
               if (p->chan) {
                  ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
                  ast_channel_unlock(p->chan);
               }
            }
         }
      }
      switch (f->frametype) {
      case AST_FRAME_CONTROL:
         if (f->subclass.integer == AST_CONTROL_ANSWER) {
            if (p->ackcall) {
               ast_verb(3, "%s answered, waiting for '%c' to acknowledge\n", p->chan->name, p->acceptdtmf);
               /* Don't pass answer along */
               ast_frfree(f);
               f = &ast_null_frame;
            } else {
               p->acknowledged = 1;
               /* Use the builtin answer frame for the 
                  recording start check below. */
               ast_frfree(f);
               f = &answer_frame;
            }
         }
         break;
      case AST_FRAME_DTMF_BEGIN:
         /*ignore DTMF begin's as it can cause issues with queue announce files*/
         if((!p->acknowledged && f->subclass.integer == p->acceptdtmf) || (f->subclass.integer == p->enddtmf && endcall)){
            ast_frfree(f);
            f = &ast_null_frame;
         }
         break;
      case AST_FRAME_DTMF_END:
         if (!p->acknowledged && (f->subclass.integer == p->acceptdtmf)) {
            ast_verb(3, "%s acknowledged\n", p->chan->name);
            p->acknowledged = 1;
            ast_frfree(f);
            f = &answer_frame;
         } else if (f->subclass.integer == p->enddtmf && endcall) {
            /* terminates call */
            ast_frfree(f);
            f = NULL;
         }
         break;
      case AST_FRAME_VOICE:
      case AST_FRAME_VIDEO:
         /* don't pass voice or video until the call is acknowledged */
         if (!p->acknowledged) {
            ast_frfree(f);
            f = &ast_null_frame;
         }
      default:
         /* pass everything else on through */
         break;
      }
   }

   if (owner) {
      ast_channel_unlock(owner);
      owner = ast_channel_unref(owner);
   }

   CLEANUP(ast,p);
   if (p->chan && !p->chan->_bridge) {
      if (strcasecmp(p->chan->tech->type, "Local")) {
         p->chan->_bridge = ast;
         if (p->chan)
            ast_debug(1, "Bridge on '%s' being set to '%s' (3)\n", p->chan->name, p->chan->_bridge->name);
      }
   }
   ast_mutex_unlock(&p->lock);
   if (recordagentcalls && f == &answer_frame)
      agent_start_monitoring(ast,0);
   return f;
}

static int agent_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen)
{
   struct agent_pvt *p = ast->tech_pvt;
   int res = -1;
   ast_mutex_lock(&p->lock);
   if (p->chan) 
      res = ast_channel_sendhtml(p->chan, subclass, data, datalen);
   ast_mutex_unlock(&p->lock);
   return res;
}

static int agent_sendtext(struct ast_channel *ast, const char *text)
{
   struct agent_pvt *p = ast->tech_pvt;
   int res = -1;
   ast_mutex_lock(&p->lock);
   if (p->chan) 
      res = ast_sendtext(p->chan, text);
   ast_mutex_unlock(&p->lock);
   return res;
}

static int agent_write(struct ast_channel *ast, struct ast_frame *f)
{
   struct agent_pvt *p = ast->tech_pvt;
   int res = -1;
   CHECK_FORMATS(ast, p);
   ast_mutex_lock(&p->lock);
   if (!p->chan) 
      res = 0;
   else {
      if ((f->frametype != AST_FRAME_VOICE) ||
          (f->frametype != AST_FRAME_VIDEO) ||
          (f->subclass.codec == p->chan->writeformat)) {
         res = ast_write(p->chan, f);
      } else {
         ast_debug(1, "Dropping one incompatible %s frame on '%s' to '%s'\n", 
            f->frametype == AST_FRAME_VOICE ? "audio" : "video",
            ast->name, p->chan->name);
         res = 0;
      }
   }
   CLEANUP(ast, p);
   ast_mutex_unlock(&p->lock);
   return res;
}

static int agent_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
{
   struct agent_pvt *p = newchan->tech_pvt;
   ast_mutex_lock(&p->lock);
   if (p->owner != oldchan) {
      ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
      ast_mutex_unlock(&p->lock);
      return -1;
   }
   p->owner = newchan;
   ast_mutex_unlock(&p->lock);
   return 0;
}

static int agent_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen)
{
   struct agent_pvt *p = ast->tech_pvt;
   int res = -1;
   ast_mutex_lock(&p->lock);
   if (p->chan && !ast_check_hangup(p->chan)) {
      while (ast_channel_trylock(p->chan)) {
         int res;
         if ((res = ast_channel_unlock(ast))) {
            ast_log(LOG_ERROR, "chan_agent bug! Channel was not locked upon entry to agent_indicate: %s\n", strerror(res));
            ast_mutex_unlock(&p->lock);
            return -1;
         }
         usleep(1);
         ast_channel_lock(ast);
      }
      res = p->chan->tech->indicate ? p->chan->tech->indicate(p->chan, condition, data, datalen) : -1;
      ast_channel_unlock(p->chan);
   } else
      res = 0;
   ast_mutex_unlock(&p->lock);
   return res;
}

static int agent_digit_begin(struct ast_channel *ast, char digit)
{
   struct agent_pvt *p = ast->tech_pvt;
   ast_mutex_lock(&p->lock);
   if (p->chan) {
      ast_senddigit_begin(p->chan, digit);
   }
   ast_mutex_unlock(&p->lock);
   return 0;
}

static int agent_digit_end(struct ast_channel *ast, char digit, unsigned int duration)
{
   struct agent_pvt *p = ast->tech_pvt;
   ast_mutex_lock(&p->lock);
   if (p->chan) {
      ast_senddigit_end(p->chan, digit, duration);
   }
   ast_mutex_unlock(&p->lock);
   return 0;
}

static int agent_call(struct ast_channel *ast, char *dest, int timeout)
{
   struct agent_pvt *p = ast->tech_pvt;
   int res = -1;
   int newstate=0;
   struct ast_channel *chan;

   ast_mutex_lock(&p->lock);
   p->acknowledged = 0;

   if (p->pending) {
      ast_log(LOG_DEBUG, "Pretending to dial on pending agent\n");
      ast_mutex_unlock(&p->lock);
      ast_setstate(ast, AST_STATE_DIALING);
      return 0;
   }

   if (!p->chan) {
      ast_log(LOG_DEBUG, "Agent disconnected while we were connecting the call\n");
      ast_mutex_unlock(&p->lock);
      return res;
   }
   ast_verb(3, "agent_call, call to agent '%s' call on '%s'\n", p->agent, p->chan->name);
   ast_debug(3, "Playing beep, lang '%s'\n", p->chan->language);
   
   chan = p->chan;
   ast_mutex_unlock(&p->lock);

   res = ast_streamfile(chan, beep, chan->language);
   ast_debug(3, "Played beep, result '%d'\n", res);
   if (!res) {
      res = ast_waitstream(chan, "");
      ast_debug(3, "Waited for stream, result '%d'\n", res);
   }
   
   ast_mutex_lock(&p->lock);
   if (!p->chan) {
      /* chan went away while we were streaming, this shouldn't be possible */
      res = -1;
   }

   if (!res) {
      res = ast_set_read_format(p->chan, ast_best_codec(p->chan->nativeformats));
      ast_debug(3, "Set read format, result '%d'\n", res);
      if (res)
         ast_log(LOG_WARNING, "Unable to set read format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
   } else {
      /* Agent hung-up */
      p->chan = NULL;
      ast_devstate_changed(AST_DEVICE_UNAVAILABLE, "Agent/%s", p->agent);
   }

   if (!res) {
      res = ast_set_write_format(p->chan, ast_best_codec(p->chan->nativeformats));
      ast_debug(3, "Set write format, result '%d'\n", res);
      if (res)
         ast_log(LOG_WARNING, "Unable to set write format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
   }
   if(!res) {
      /* Call is immediately up, or might need ack */
      if (p->ackcall) {
         newstate = AST_STATE_RINGING;
      } else {
         newstate = AST_STATE_UP;
         if (recordagentcalls)
            agent_start_monitoring(ast, 0);
         p->acknowledged = 1;
      }
      res = 0;
   }
   CLEANUP(ast, p);
   ast_mutex_unlock(&p->lock);
   if (newstate)
      ast_setstate(ast, newstate);
   return res;
}

/*! \brief return the channel or base channel if one exists.  This function assumes the channel it is called on is already locked */
struct ast_channel* agent_get_base_channel(struct ast_channel *chan)
{
   struct agent_pvt *p = NULL;
   struct ast_channel *base = chan;

   /* chan is locked by the calling function */
   if (!chan || !chan->tech_pvt) {
      ast_log(LOG_ERROR, "whoa, you need a channel (0x%ld) with a tech_pvt (0x%ld) to get a base channel.\n", (long)chan, (chan)?(long)chan->tech_pvt:(long)NULL);
      return NULL;
   }
   p = chan->tech_pvt;
   if (p->chan) 
      base = p->chan;
   return base;
}

int agent_set_base_channel(struct ast_channel *chan, struct ast_channel *base)
{
   struct agent_pvt *p = NULL;
   
   if (!chan || !base) {
      ast_log(LOG_ERROR, "whoa, you need a channel (0x%ld) and a base channel (0x%ld) for setting.\n", (long)chan, (long)base);
      return -1;
   }
   p = chan->tech_pvt;
   if (!p) {
      ast_log(LOG_ERROR, "whoa, channel %s is missing his tech_pvt structure!!.\n", chan->name);
      return -1;
   }
   p->chan = base;
   return 0;
}

static int agent_hangup(struct ast_channel *ast)
{
   struct agent_pvt *p = ast->tech_pvt;
   struct ast_channel *indicate_chan = NULL;
   char *tmp_moh; /* moh buffer for indicating after unlocking p */

   if (p->pending) {
      AST_LIST_LOCK(&agents);
      AST_LIST_REMOVE(&agents, p, list);
      AST_LIST_UNLOCK(&agents);
   }

   ast_mutex_lock(&p->lock);
   p->owner = NULL;
   ast->tech_pvt = NULL;
   p->app_sleep_cond = 1;
   p->acknowledged = 0;

   /* Release ownership of the agent to other threads (presumably running the login app). */
   p->app_lock_flag = 0;
   ast_cond_signal(&p->app_complete_cond);

   /* if they really are hung up then set start to 0 so the test
    * later if we're called on an already downed channel
    * doesn't cause an agent to be logged out like when
    * agent_request() is followed immediately by agent_hangup()
    * as in apps/app_chanisavail.c:chanavail_exec()
    */

   ast_debug(1, "Hangup called for state %s\n", ast_state2str(ast->_state));
   if (p->start && (ast->_state != AST_STATE_UP)) {
      p->start = 0;
   } else
      p->start = 0;
   if (p->chan) {
      p->chan->_bridge = NULL;
      /* If they're dead, go ahead and hang up on the agent now */
      if (p->dead) {
         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
      } else if (p->loginstart) {
         indicate_chan = ast_channel_ref(p->chan);
         tmp_moh = ast_strdupa(p->moh);
      }
   }
   ast_mutex_unlock(&p->lock);

   if (indicate_chan) {
      ast_indicate_data(indicate_chan, AST_CONTROL_HOLD,
         S_OR(tmp_moh, NULL),
         !ast_strlen_zero(tmp_moh) ? strlen(tmp_moh) + 1 : 0);
      indicate_chan = ast_channel_unref(indicate_chan);
   }

   /* Only register a device state change if the agent is still logged in */
   if (!p->loginstart) {
      p->logincallerid[0] = '\0';
   } else {
      ast_devstate_changed(AST_DEVICE_NOT_INUSE, "Agent/%s", p->agent);
   }

   if (p->abouttograb) {
      /* Let the "about to grab" thread know this isn't valid anymore, and let it
         kill it later */
      p->abouttograb = 0;
   } else if (p->dead) {
      ast_mutex_destroy(&p->lock);
      ast_cond_destroy(&p->app_complete_cond);
      ast_cond_destroy(&p->login_wait_cond);
      ast_free(p);
   } else {
      if (p->chan) {
         /* Not dead -- check availability now */
         ast_mutex_lock(&p->lock);
         /* Store last disconnect time */
         p->lastdisc = ast_tvadd(ast_tvnow(), ast_samp2tv(p->wrapuptime, 1000));
         ast_mutex_unlock(&p->lock);
      }
   }
   return 0;
}

static int agent_cont_sleep( void *data )
{
   struct agent_pvt *p;
   int res;

   p = (struct agent_pvt *)data;

   ast_mutex_lock(&p->lock);
   res = p->app_sleep_cond;
   if (p->lastdisc.tv_sec) {
      if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0) 
         res = 1;
   }
   ast_mutex_unlock(&p->lock);

   if (!res)
      ast_debug(5, "agent_cont_sleep() returning %d\n", res );

   return res;
}

static int agent_ack_sleep(void *data)
{
   struct agent_pvt *p;
   int res=0;
   int to = 1000;
   struct ast_frame *f;

   /* Wait a second and look for something */

   p = (struct agent_pvt *) data;
   if (!p->chan) 
      return -1;

   for(;;) {
      to = ast_waitfor(p->chan, to);
      if (to < 0) 
         return -1;
      if (!to) 
         return 0;
      f = ast_read(p->chan);
      if (!f) 
         return -1;
      if (f->frametype == AST_FRAME_DTMF)
         res = f->subclass.integer;
      else
         res = 0;
      ast_frfree(f);
      ast_mutex_lock(&p->lock);
      if (!p->app_sleep_cond) {
         ast_mutex_unlock(&p->lock);
         return 0;
      } else if (res == p->acceptdtmf) {
         ast_mutex_unlock(&p->lock);
         return 1;
      }
      ast_mutex_unlock(&p->lock);
      res = 0;
   }
   return res;
}

static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct ast_channel *bridge)
{
   struct agent_pvt *p = bridge->tech_pvt;
   struct ast_channel *ret = NULL;

   if (p) {
      if (chan == p->chan)
         ret = bridge->_bridge;
      else if (chan == bridge->_bridge)
         ret = p->chan;
   }

   ast_debug(1, "Asked for bridged channel on '%s'/'%s', returning '%s'\n", chan->name, bridge->name, ret ? ret->name : "<none>");
   return ret;
}

/*! \brief Create new agent channel */
static struct ast_channel *agent_new(struct agent_pvt *p, int state, const char *linkedid)
{
   struct ast_channel *tmp;
#if 0
   if (!p->chan) {
      ast_log(LOG_WARNING, "No channel? :(\n");
      return NULL;
   }
#endif   
   if (p->pending)
      tmp = ast_channel_alloc(0, state, 0, 0, "", p->chan ? p->chan->exten:"", p->chan ? p->chan->context:"", linkedid, 0, "Agent/P%s-%d", p->agent, (int) ast_random() & 0xffff);
   else
      tmp = ast_channel_alloc(0, state, 0, 0, "", p->chan ? p->chan->exten:"", p->chan ? p->chan->context:"", linkedid, 0, "Agent/%s", p->agent);
   if (!tmp) {
      ast_log(LOG_WARNING, "Unable to allocate agent channel structure\n");
      return NULL;
   }

   tmp->tech = &agent_tech;
   if (p->chan) {
      tmp->nativeformats = p->chan->nativeformats;
      tmp->writeformat = p->chan->writeformat;
      tmp->rawwriteformat = p->chan->writeformat;
      tmp->readformat = p->chan->readformat;
      tmp->rawreadformat = p->chan->readformat;
      ast_string_field_set(tmp, language, p->chan->language);
      ast_copy_string(tmp->context, p->chan->context, sizeof(tmp->context));
      ast_copy_string(tmp->exten, p->chan->exten, sizeof(tmp->exten));
      /* XXX Is this really all we copy form the originating channel?? */
   } else {
      tmp->nativeformats = AST_FORMAT_SLINEAR;
      tmp->writeformat = AST_FORMAT_SLINEAR;
      tmp->rawwriteformat = AST_FORMAT_SLINEAR;
      tmp->readformat = AST_FORMAT_SLINEAR;
      tmp->rawreadformat = AST_FORMAT_SLINEAR;
   }
   /* Safe, agentlock already held */
   tmp->tech_pvt = p;
   p->owner = tmp;
   tmp->priority = 1;
   return tmp;
}


/*!
 * Read configuration data. The file named agents.conf.
 *
 * \returns Always 0, or so it seems.
 */
static int read_agent_config(int reload)
{
   struct ast_config *cfg;
   struct ast_config *ucfg;
   struct ast_variable *v;
   struct agent_pvt *p;
   const char *catname;
   const char *hasagent;
   int genhasagent;
   struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };

   group = 0;
   autologoff = 0;
   wrapuptime = 0;
   ackcall = 0;
   endcall = 1;
   cfg = ast_config_load(config, config_flags);
   if (!cfg) {
      ast_log(LOG_NOTICE, "No agent configuration found -- agent support disabled\n");
      return 0;
   } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
      return -1;
   } else if (cfg == CONFIG_STATUS_FILEINVALID) {
      ast_log(LOG_ERROR, "%s contains a parsing error.  Aborting\n", config);
      return 0;
   }
   if ((ucfg = ast_config_load("users.conf", config_flags))) {
      if (ucfg == CONFIG_STATUS_FILEUNCHANGED) {
         ucfg = NULL;
      } else if (ucfg == CONFIG_STATUS_FILEINVALID) {
         ast_log(LOG_ERROR, "users.conf contains a parsing error.  Aborting\n");
         return 0;
      }
   }

   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      p->dead = 1;
   }
   strcpy(moh, "default");
   /* set the default recording values */
   recordagentcalls = 0;
   strcpy(recordformat, "wav");
   strcpy(recordformatext, "wav");
   urlprefix[0] = '\0';
   savecallsin[0] = '\0';

   /* Read in [general] section for persistence */
   multiplelogin = ast_true(ast_variable_retrieve(cfg, "general", "multiplelogin"));

   /* Read in the [agents] section */
   v = ast_variable_browse(cfg, "agents");
   while(v) {
      /* Create the interface list */
      if (!strcasecmp(v->name, "agent")) {
         add_agent(v->value, 0);
      } else if (!strcasecmp(v->name, "group")) {
         group = ast_get_group(v->value);
      } else if (!strcasecmp(v->name, "autologoff")) {
         autologoff = atoi(v->value);
         if (autologoff < 0)
            autologoff = 0;
      } else if (!strcasecmp(v->name, "ackcall")) {
         if (ast_true(v->value) || !strcasecmp(v->value, "always")) {
            ackcall = 1;
         }
      } else if (!strcasecmp(v->name, "endcall")) {
         endcall = ast_true(v->value);
      } else if (!strcasecmp(v->name, "acceptdtmf")) {
         acceptdtmf = *(v->value);
         ast_log(LOG_NOTICE, "Set acceptdtmf to %c\n", acceptdtmf);
      } else if (!strcasecmp(v->name, "enddtmf")) {
         enddtmf = *(v->value);
      } else if (!strcasecmp(v->name, "wrapuptime")) {
         wrapuptime = atoi(v->value);
         if (wrapuptime < 0)
            wrapuptime = 0;
      } else if (!strcasecmp(v->name, "maxlogintries") && !ast_strlen_zero(v->value)) {
         maxlogintries = atoi(v->value);
         if (maxlogintries < 0)
            maxlogintries = 0;
      } else if (!strcasecmp(v->name, "goodbye") && !ast_strlen_zero(v->value)) {
         strcpy(agentgoodbye,v->value);
      } else if (!strcasecmp(v->name, "musiconhold")) {
         ast_copy_string(moh, v->value, sizeof(moh));
      } else if (!strcasecmp(v->name, "updatecdr")) {
         if (ast_true(v->value))
            updatecdr = 1;
         else
            updatecdr = 0;
      } else if (!strcasecmp(v->name, "autologoffunavail")) {
         if (ast_true(v->value))
            autologoffunavail = 1;
         else
            autologoffunavail = 0;
      } else if (!strcasecmp(v->name, "recordagentcalls")) {
         recordagentcalls = ast_true(v->value);
      } else if (!strcasecmp(v->name, "recordformat")) {
         ast_copy_string(recordformat, v->value, sizeof(recordformat));
         if (!strcasecmp(v->value, "wav49"))
            strcpy(recordformatext, "WAV");
         else
            ast_copy_string(recordformatext, v->value, sizeof(recordformatext));
      } else if (!strcasecmp(v->name, "urlprefix")) {
         ast_copy_string(urlprefix, v->value, sizeof(urlprefix));
         if (urlprefix[strlen(urlprefix) - 1] != '/')
            strncat(urlprefix, "/", sizeof(urlprefix) - strlen(urlprefix) - 1);
      } else if (!strcasecmp(v->name, "savecallsin")) {
         if (v->value[0] == '/')
            ast_copy_string(savecallsin, v->value, sizeof(savecallsin));
         else
            snprintf(savecallsin, sizeof(savecallsin) - 2, "/%s", v->value);
         if (savecallsin[strlen(savecallsin) - 1] != '/')
            strncat(savecallsin, "/", sizeof(savecallsin) - strlen(savecallsin) - 1);
      } else if (!strcasecmp(v->name, "custom_beep")) {
         ast_copy_string(beep, v->value, sizeof(beep));
      }
      v = v->next;
   }
   if (ucfg) {
      genhasagent = ast_true(ast_variable_retrieve(ucfg, "general", "hasagent"));
      catname = ast_category_browse(ucfg, NULL);
      while(catname) {
         if (strcasecmp(catname, "general")) {
            hasagent = ast_variable_retrieve(ucfg, catname, "hasagent");
            if (ast_true(hasagent) || (!hasagent && genhasagent)) {
               char tmp[256];
               const char *fullname = ast_variable_retrieve(ucfg, catname, "fullname");
               const char *secret = ast_variable_retrieve(ucfg, catname, "secret");
               if (!fullname)
                  fullname = "";
               if (!secret)
                  secret = "";
               snprintf(tmp, sizeof(tmp), "%s,%s,%s", catname, secret,fullname);
               add_agent(tmp, 0);
            }
         }
         catname = ast_category_browse(ucfg, catname);
      }
      ast_config_destroy(ucfg);
   }
   AST_LIST_TRAVERSE_SAFE_BEGIN(&agents, p, list) {
      if (p->dead) {
         AST_LIST_REMOVE_CURRENT(list);
         /* Destroy if  appropriate */
         if (!p->owner) {
            if (!p->chan) {
               ast_mutex_destroy(&p->lock);
               ast_cond_destroy(&p->app_complete_cond);
               ast_cond_destroy(&p->login_wait_cond);
               ast_free(p);
            } else {
               /* Cause them to hang up */
               ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
            }
         }
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;
   AST_LIST_UNLOCK(&agents);
   ast_config_destroy(cfg);
   return 1;
}

static int check_availability(struct agent_pvt *newlyavailable, int needlock)
{
   struct ast_channel *chan=NULL, *parent=NULL;
   struct agent_pvt *p;
   int res;

   ast_debug(1, "Checking availability of '%s'\n", newlyavailable->agent);
   if (needlock)
      AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      if (p == newlyavailable) {
         continue;
      }
      ast_mutex_lock(&p->lock);
      if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
         ast_debug(1, "Call '%s' looks like a winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
         /* We found a pending call, time to merge */
         chan = agent_new(newlyavailable, AST_STATE_DOWN, p->owner ? p->owner->linkedid : NULL);
         parent = p->owner;
         p->abouttograb = 1;
         ast_mutex_unlock(&p->lock);
         break;
      }
      ast_mutex_unlock(&p->lock);
   }
   if (needlock)
      AST_LIST_UNLOCK(&agents);
   if (parent && chan)  {
      if (newlyavailable->ackcall) {
         /* Don't do beep here */
         res = 0;
      } else {
         ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
         res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
         ast_debug(3, "Played beep, result '%d'\n", res);
         if (!res) {
            res = ast_waitstream(newlyavailable->chan, "");
            ast_debug(1, "Waited for stream, result '%d'\n", res);
         }
      }
      if (!res) {
         /* Note -- parent may have disappeared */
         if (p->abouttograb) {
            newlyavailable->acknowledged = 1;
            /* Safe -- agent lock already held */
            ast_setstate(parent, AST_STATE_UP);
            ast_setstate(chan, AST_STATE_UP);
            ast_copy_string(parent->context, chan->context, sizeof(parent->context));
            ast_channel_masquerade(parent, chan);
            ast_hangup(chan);
            p->abouttograb = 0;
         } else {
            ast_debug(1, "Sneaky, parent disappeared in the mean time...\n");
            agent_cleanup(newlyavailable);
         }
      } else {
         ast_debug(1, "Ugh...  Agent hung up at exactly the wrong time\n");
         agent_cleanup(newlyavailable);
      }
   }
   return 0;
}

static int check_beep(struct agent_pvt *newlyavailable, int needlock)
{
   struct agent_pvt *p;
   int res=0;

   ast_debug(1, "Checking beep availability of '%s'\n", newlyavailable->agent);
   if (needlock)
      AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      if (p == newlyavailable) {
         continue;
      }
      ast_mutex_lock(&p->lock);
      if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
         ast_debug(1, "Call '%s' looks like a would-be winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
         ast_mutex_unlock(&p->lock);
         break;
      }
      ast_mutex_unlock(&p->lock);
   }
   if (needlock)
      AST_LIST_UNLOCK(&agents);
   if (p) {
      ast_mutex_unlock(&newlyavailable->lock);
      ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
      res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
      ast_debug(1, "Played beep, result '%d'\n", res);
      if (!res) {
         res = ast_waitstream(newlyavailable->chan, "");
         ast_debug(1, "Waited for stream, result '%d'\n", res);
      }
      ast_mutex_lock(&newlyavailable->lock);
   }
   return res;
}

/*! \brief Part of the Asterisk PBX interface */
static struct ast_channel *agent_request(const char *type, format_t format, const struct ast_channel* requestor, void *data, int *cause)
{
   struct agent_pvt *p;
   struct ast_channel *chan = NULL;
   char *s;
   ast_group_t groupmatch;
   int groupoff;
   int waitforagent=0;
   int hasagent = 0;
   struct timeval now;

   s = data;
   if ((s[0] == '@') && (sscanf(s + 1, "%30d", &groupoff) == 1)) {
      groupmatch = (1 << groupoff);
   } else if ((s[0] == ':') && (sscanf(s + 1, "%30d", &groupoff) == 1)) {
      groupmatch = (1 << groupoff);
      waitforagent = 1;
   } else 
      groupmatch = 0;

   /* Check actual logged in agents first */
   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      ast_mutex_lock(&p->lock);
      if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
         if (p->chan)
            hasagent++;
         now = ast_tvnow();
         if (!p->lastdisc.tv_sec || (now.tv_sec >= p->lastdisc.tv_sec)) {
            p->lastdisc = ast_tv(0, 0);
            /* Agent must be registered, but not have any active call, and not be in a waiting state */
            if (!p->owner && p->chan) {
               /* Fixed agent */
               chan = agent_new(p, AST_STATE_DOWN, requestor ? requestor->linkedid : NULL);
            }
            if (chan) {
               ast_mutex_unlock(&p->lock);
               break;
            }
         }
      }
      ast_mutex_unlock(&p->lock);
   }
   if (!p) {
      AST_LIST_TRAVERSE(&agents, p, list) {
         ast_mutex_lock(&p->lock);
         if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
            if (p->chan) {
               hasagent++;
            }
            now = ast_tvnow();
            if (!p->lastdisc.tv_sec || (now.tv_sec >= p->lastdisc.tv_sec)) {
               p->lastdisc = ast_tv(0, 0);
               /* Agent must be registered, but not have any active call, and not be in a waiting state */
               if (!p->owner && p->chan) {
                  /* Could still get a fixed agent */
                  chan = agent_new(p, AST_STATE_DOWN, requestor ? requestor->linkedid : NULL);
               }
               if (chan) {
                  ast_mutex_unlock(&p->lock);
                  break;
               }
            }
         }
         ast_mutex_unlock(&p->lock);
      }
   }

   if (!chan && waitforagent) {
      /* No agent available -- but we're requesting to wait for one.
         Allocate a place holder */
      if (hasagent) {
         ast_debug(1, "Creating place holder for '%s'\n", s);
         p = add_agent(data, 1);
         p->group = groupmatch;
         chan = agent_new(p, AST_STATE_DOWN, requestor ? requestor->linkedid : NULL);
         if (!chan) 
            ast_log(LOG_WARNING, "Weird...  Fix this to drop the unused pending agent\n");
      } else {
         ast_debug(1, "Not creating place holder for '%s' since nobody logged in\n", s);
      }
   }
   *cause = hasagent ? AST_CAUSE_BUSY : AST_CAUSE_UNREGISTERED;
   AST_LIST_UNLOCK(&agents);

   if (chan) {
      ast_mutex_lock(&p->lock);
      if (p->pending) {
         ast_mutex_unlock(&p->lock);
         return chan;
      }

      if (!p->chan) {
         ast_log(LOG_DEBUG, "Agent disconnected while we were connecting the call\n");
         *cause = AST_CAUSE_UNREGISTERED;
         ast_mutex_unlock(&p->lock);
         agent_hangup(chan);
         return NULL;
      }

      /* we need to take control of the channel from the login app
       * thread */
      p->app_sleep_cond = 0;
      p->app_lock_flag = 1;

      ast_queue_frame(p->chan, &ast_null_frame);
      ast_cond_wait(&p->login_wait_cond, &p->lock);

      if (!p->chan) {
         ast_log(LOG_DEBUG, "Agent disconnected while we were connecting the call\n");
         p->app_sleep_cond = 1;
         p->app_lock_flag = 0;
         ast_cond_signal(&p->app_complete_cond);
         ast_mutex_unlock(&p->lock);
         *cause = AST_CAUSE_UNREGISTERED;
         agent_hangup(chan);
         return NULL;
      }

      ast_indicate(p->chan, AST_CONTROL_UNHOLD);
      ast_mutex_unlock(&p->lock);
   }

   return chan;
}

static force_inline int powerof(unsigned int d)
{
   int x = ffs(d);

   if (x)
      return x - 1;

   return 0;
}

/*!
 * Lists agents and their status to the Manager API.
 * It is registered on load_module() and it gets called by the manager backend.
 * This function locks both the pvt and the channel that owns it for a while, but
 * does not keep these locks.
 * \param s
 * \param m
 * \returns 
 * \sa action_agent_logoff(), load_module().
 */
static int action_agents(struct mansession *s, const struct message *m)
{
   const char *id = astman_get_header(m,"ActionID");
   char idText[256] = "";
   struct agent_pvt *p;
   char *username = NULL;
   char *loginChan = NULL;
   char *talkingto = NULL;
   char *talkingtoChan = NULL;
   char *status = NULL;
   struct ast_channel *bridge;

   if (!ast_strlen_zero(id))
      snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
   astman_send_ack(s, m, "Agents will follow");
   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      struct ast_channel *owner;
      ast_mutex_lock(&p->lock);
      owner = agent_lock_owner(p);

      /* Status Values:
         AGENT_LOGGEDOFF - Agent isn't logged in
         AGENT_IDLE      - Agent is logged in, and waiting for call
         AGENT_ONCALL    - Agent is logged in, and on a call
         AGENT_UNKNOWN   - Don't know anything about agent. Shouldn't ever get this. */

      username = S_OR(p->name, "None");

      /* Set a default status. It 'should' get changed. */
      status = "AGENT_UNKNOWN";

      if (p->chan) {
         loginChan = ast_strdupa(p->chan->name);
         if (owner && owner->_bridge) {
            talkingto = S_COR(p->chan->caller.id.number.valid,
               p->chan->caller.id.number.str, "n/a");
            if ((bridge = ast_bridged_channel(owner))) {
               talkingtoChan = ast_strdupa(bridge->name);
            } else {
               talkingtoChan = "n/a";
            }
            status = "AGENT_ONCALL";
         } else {
            talkingto = "n/a";
            talkingtoChan = "n/a";
            status = "AGENT_IDLE";
         }
      } else {
         loginChan = "n/a";
         talkingto = "n/a";
         talkingtoChan = "n/a";
         status = "AGENT_LOGGEDOFF";
      }

      if (owner) {
         ast_channel_unlock(owner);
         owner = ast_channel_unref(owner);
      }

      astman_append(s, "Event: Agents\r\n"
         "Agent: %s\r\n"
         "Name: %s\r\n"
         "Status: %s\r\n"
         "LoggedInChan: %s\r\n"
         "LoggedInTime: %d\r\n"
         "TalkingTo: %s\r\n"
         "TalkingToChan: %s\r\n"
         "%s"
         "\r\n",
         p->agent, username, status, loginChan, (int)p->loginstart, talkingto, talkingtoChan, idText);
      ast_mutex_unlock(&p->lock);
   }
   AST_LIST_UNLOCK(&agents);
   astman_append(s, "Event: AgentsComplete\r\n"
      "%s"
      "\r\n",idText);
   return 0;
}

static int agent_logoff(const char *agent, int soft)
{
   struct agent_pvt *p;
   int ret = -1; /* Return -1 if no agent if found */

   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      if (!strcasecmp(p->agent, agent)) {
         ret = 0;
         if (p->owner || p->chan) {
            if (!soft) {
               struct ast_channel *owner;
               ast_mutex_lock(&p->lock);
               owner = agent_lock_owner(p);

               if (owner) {
                  ast_softhangup(owner, AST_SOFTHANGUP_EXPLICIT);
                  ast_channel_unlock(owner);
                  owner = ast_channel_unref(owner);
               }

               while (p->chan && ast_channel_trylock(p->chan)) {
                  DEADLOCK_AVOIDANCE(&p->lock);
               }
               if (p->chan) {
                  ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
                  ast_channel_unlock(p->chan);
               }

               ast_mutex_unlock(&p->lock);
            } else
               p->deferlogoff = 1;
         }
         break;
      }
   }
   AST_LIST_UNLOCK(&agents);

   return ret;
}

static char *agent_logoff_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   int ret;
   const char *agent;

   switch (cmd) {
   case CLI_INIT:
      e->command = "agent logoff";
      e->usage =
         "Usage: agent logoff <channel> [soft]\n"
         "       Sets an agent as no longer logged in.\n"
         "       If 'soft' is specified, do not hangup existing calls.\n";
      return NULL;
   case CLI_GENERATE:
      return complete_agent_logoff_cmd(a->line, a->word, a->pos, a->n); 
   }

   if (a->argc < 3 || a->argc > 4)
      return CLI_SHOWUSAGE;
   if (a->argc == 4 && strcasecmp(a->argv[3], "soft"))
      return CLI_SHOWUSAGE;

   agent = a->argv[2] + 6;
   ret = agent_logoff(agent, a->argc == 4);
   if (ret == 0)
      ast_cli(a->fd, "Logging out %s\n", agent);

   return CLI_SUCCESS;
}

/*!
 * Sets an agent as no longer logged in in the Manager API.
 * It is registered on load_module() and it gets called by the manager backend.
 * \param s
 * \param m
 * \returns 
 * \sa action_agents(), load_module().
 */
static int action_agent_logoff(struct mansession *s, const struct message *m)
{
   const char *agent = astman_get_header(m, "Agent");
   const char *soft_s = astman_get_header(m, "Soft"); /* "true" is don't hangup */
   int soft;
   int ret; /* return value of agent_logoff */

   if (ast_strlen_zero(agent)) {
      astman_send_error(s, m, "No agent specified");
      return 0;
   }

   soft = ast_true(soft_s) ? 1 : 0;
   ret = agent_logoff(agent, soft);
   if (ret == 0)
      astman_send_ack(s, m, "Agent logged out");
   else
      astman_send_error(s, m, "No such agent");

   return 0;
}

static char *complete_agent_logoff_cmd(const char *line, const char *word, int pos, int state)
{
   char *ret = NULL;

   if (pos == 2) {
      struct agent_pvt *p;
      char name[AST_MAX_AGENT];
      int which = 0, len = strlen(word);

      AST_LIST_LOCK(&agents);
      AST_LIST_TRAVERSE(&agents, p, list) {
         snprintf(name, sizeof(name), "Agent/%s", p->agent);
         if (!strncasecmp(word, name, len) && p->loginstart && ++which > state) {
            ret = ast_strdup(name);
            break;
         }
      }
      AST_LIST_UNLOCK(&agents);
   } else if (pos == 3 && state == 0) 
      return ast_strdup("soft");
   
   return ret;
}

/*!
 * Show agents in cli.
 */
static char *agents_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   struct agent_pvt *p;
   char username[AST_MAX_BUF];
   char location[AST_MAX_BUF] = "";
   char talkingto[AST_MAX_BUF] = "";
   char music[AST_MAX_BUF];
   int count_agents = 0;      /*!< Number of agents configured */
   int online_agents = 0;     /*!< Number of online agents */
   int offline_agents = 0;    /*!< Number of offline agents */

   switch (cmd) {
   case CLI_INIT:
      e->command = "agent show";
      e->usage =
         "Usage: agent show\n"
         "       Provides summary information on agents.\n";
      return NULL;
   case CLI_GENERATE:
      return NULL;
   }

   if (a->argc != 2)
      return CLI_SHOWUSAGE;

   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      struct ast_channel *owner;
      ast_mutex_lock(&p->lock);
      owner = agent_lock_owner(p);
      if (p->pending) {
         if (p->group)
            ast_cli(a->fd, "-- Pending call to group %d\n", powerof(p->group));
         else
            ast_cli(a->fd, "-- Pending call to agent %s\n", p->agent);
      } else {
         if (!ast_strlen_zero(p->name))
            snprintf(username, sizeof(username), "(%s) ", p->name);
         else
            username[0] = '\0';
         if (p->chan) {
            snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
            if (owner && ast_bridged_channel(owner)) {
               snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(p->owner)->name);
            } else {
               strcpy(talkingto, " is idle");
            }
            online_agents++;
         } else {
            strcpy(location, "not logged in");
            talkingto[0] = '\0';
            offline_agents++;
         }
         if (!ast_strlen_zero(p->moh))
            snprintf(music, sizeof(music), " (musiconhold is '%s')", p->moh);
         ast_cli(a->fd, "%-12.12s %s%s%s%s\n", p->agent, 
            username, location, talkingto, music);
         count_agents++;
      }

      if (owner) {
         ast_channel_unlock(owner);
         owner = ast_channel_unref(owner);
      }
      ast_mutex_unlock(&p->lock);
   }
   AST_LIST_UNLOCK(&agents);
   if ( !count_agents ) 
      ast_cli(a->fd, "No Agents are configured in %s\n",config);
   else 
      ast_cli(a->fd, "%d agents configured [%d online , %d offline]\n",count_agents, online_agents, offline_agents);
   ast_cli(a->fd, "\n");
                   
   return CLI_SUCCESS;
}


static char *agents_show_online(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
   struct agent_pvt *p;
   char username[AST_MAX_BUF];
   char location[AST_MAX_BUF] = "";
   char talkingto[AST_MAX_BUF] = "";
   char music[AST_MAX_BUF];
   int count_agents = 0;           /* Number of agents configured */
   int online_agents = 0;          /* Number of online agents */
   int agent_status = 0;           /* 0 means offline, 1 means online */

   switch (cmd) {
   case CLI_INIT:
      e->command = "agent show online";
      e->usage =
         "Usage: agent show online\n"
         "       Provides a list of all online agents.\n";
      return NULL;
   case CLI_GENERATE:
      return NULL;
   }

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

   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      struct ast_channel *owner;

      agent_status = 0;       /* reset it to offline */
      ast_mutex_lock(&p->lock);
      owner = agent_lock_owner(p);

      if (!ast_strlen_zero(p->name))
         snprintf(username, sizeof(username), "(%s) ", p->name);
      else
         username[0] = '\0';
      if (p->chan) {
         snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
         if (owner && ast_bridged_channel(owner)) {
            snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(owner)->name);
         } else {
            strcpy(talkingto, " is idle");
         }
         agent_status = 1;
         online_agents++;
      }

      if (owner) {
         ast_channel_unlock(owner);
         owner = ast_channel_unref(owner);
      }

      if (!ast_strlen_zero(p->moh))
         snprintf(music, sizeof(music), " (musiconhold is '%s')", p->moh);
      if (agent_status)
         ast_cli(a->fd, "%-12.12s %s%s%s%s\n", p->agent, username, location, talkingto, music);
      count_agents++;
      ast_mutex_unlock(&p->lock);
   }
   AST_LIST_UNLOCK(&agents);
   if (!count_agents) 
      ast_cli(a->fd, "No Agents are configured in %s\n", config);
   else
      ast_cli(a->fd, "%d agents online\n", online_agents);
   ast_cli(a->fd, "\n");
   return CLI_SUCCESS;
}

static const char agent_logoff_usage[] =
"Usage: agent logoff <channel> [soft]\n"
"       Sets an agent as no longer logged in.\n"
"       If 'soft' is specified, do not hangup existing calls.\n";

static struct ast_cli_entry cli_agents[] = {
   AST_CLI_DEFINE(agents_show, "Show status of agents"),
   AST_CLI_DEFINE(agents_show_online, "Show all online agents"),
   AST_CLI_DEFINE(agent_logoff_cmd, "Sets an agent offline"),
};

/*!
 * Called by the AgentLogin application (from the dial plan).
 * 
 * \brief Log in agent application.
 *
 * \param chan
 * \param data
 * \returns
 * \sa agentmonitoroutgoing_exec(), load_module().
 */
static int login_exec(struct ast_channel *chan, const char *data)
{
   int res=0;
   int tries = 0;
   int max_login_tries = maxlogintries;
   struct agent_pvt *p;
   struct ast_module_user *u;
   char user[AST_MAX_AGENT] = "";
   char pass[AST_MAX_AGENT];
   char agent[AST_MAX_AGENT] = "";
   char xpass[AST_MAX_AGENT] = "";
   char *errmsg;
   char *parse;
   AST_DECLARE_APP_ARGS(args,
              AST_APP_ARG(agent_id);
              AST_APP_ARG(options);
              AST_APP_ARG(extension);
      );
   const char *tmpoptions = NULL;
   int play_announcement = 1;
   char agent_goodbye[AST_MAX_FILENAME_LEN];
   int update_cdr = updatecdr;
   char *filename = "agent-loginok";

   u = ast_module_user_add(chan);

   parse = ast_strdupa(data);

   AST_STANDARD_APP_ARGS(args, parse);

   ast_copy_string(agent_goodbye, agentgoodbye, sizeof(agent_goodbye));

   ast_channel_lock(chan);
   /* Set Channel Specific Login Overrides */
   if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTLMAXLOGINTRIES"))) {
      max_login_tries = atoi(pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES"));
      if (max_login_tries < 0)
         max_login_tries = 0;
      tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES");
      ast_verb(3, "Saw variable AGENTMAXLOGINTRIES=%s, setting max_login_tries to: %d on Channel '%s'.\n",tmpoptions,max_login_tries,chan->name);
   }
   if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR"))) {
      if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR")))
         update_cdr = 1;
      else
         update_cdr = 0;
      tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR");
      ast_verb(3, "Saw variable AGENTUPDATECDR=%s, setting update_cdr to: %d on Channel '%s'.\n",tmpoptions,update_cdr,chan->name);
   }
   if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"))) {
      strcpy(agent_goodbye, pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"));
      tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTGOODBYE");
      ast_verb(3, "Saw variable AGENTGOODBYE=%s, setting agent_goodbye to: %s on Channel '%s'.\n",tmpoptions,agent_goodbye,chan->name);
   }
   ast_channel_unlock(chan);
   /* End Channel Specific Login Overrides */
   
   if (!ast_strlen_zero(args.options)) {
      if (strchr(args.options, 's')) {
         play_announcement = 0;
      }
   }

   if (chan->_state != AST_STATE_UP)
      res = ast_answer(chan);
   if (!res) {
      if (!ast_strlen_zero(args.agent_id))
         ast_copy_string(user, args.agent_id, AST_MAX_AGENT);
      else
         res = ast_app_getdata(chan, "agent-user", user, sizeof(user) - 1, 0);
   }
   while (!res && (max_login_tries==0 || tries < max_login_tries)) {
      tries++;
      /* Check for password */
      AST_LIST_LOCK(&agents);
      AST_LIST_TRAVERSE(&agents, p, list) {
         if (!strcmp(p->agent, user) && !p->pending)
            ast_copy_string(xpass, p->password, sizeof(xpass));
      }
      AST_LIST_UNLOCK(&agents);
      if (!res) {
         if (!ast_strlen_zero(xpass))
            res = ast_app_getdata(chan, "agent-pass", pass, sizeof(pass) - 1, 0);
         else
            pass[0] = '\0';
      }
      errmsg = "agent-incorrect";

#if 0
      ast_log(LOG_NOTICE, "user: %s, pass: %s\n", user, pass);
#endif      

      /* Check again for accuracy */
      AST_LIST_LOCK(&agents);
      AST_LIST_TRAVERSE(&agents, p, list) {
         int unlock_channel = 1;
         ast_channel_lock(chan);
         ast_mutex_lock(&p->lock);
         if (!strcmp(p->agent, user) &&
             !strcmp(p->password, pass) && !p->pending) {

            /* Ensure we can't be gotten until we're done */
            p->lastdisc = ast_tvnow();
            p->lastdisc.tv_sec++;

            /* Set Channel Specific Agent Overrides */
            if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"))) {
               if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"))) {
                  p->ackcall = 1;
               } else {
                  p->ackcall = 0;
               }
               tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTACKCALL");
               ast_verb(3, "Saw variable AGENTACKCALL=%s, setting ackcall to: %d for Agent '%s'.\n", tmpoptions, p->ackcall, p->agent);
               ast_set_flag(p, AGENT_FLAG_ACKCALL);
            } else {
               p->ackcall = ackcall;
            }
            if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"))) {
               p->autologoff = atoi(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"));
               if (p->autologoff < 0)
                  p->autologoff = 0;
               tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF");
               ast_verb(3, "Saw variable AGENTAUTOLOGOFF=%s, setting autologff to: %d for Agent '%s'.\n", tmpoptions, p->autologoff, p->agent);
               ast_set_flag(p, AGENT_FLAG_AUTOLOGOFF);
            } else {
               p->autologoff = autologoff;
            }
            if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"))) {
               p->wrapuptime = atoi(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"));
               if (p->wrapuptime < 0)
                  p->wrapuptime = 0;
               tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME");
               ast_verb(3, "Saw variable AGENTWRAPUPTIME=%s, setting wrapuptime to: %d for Agent '%s'.\n", tmpoptions, p->wrapuptime, p->agent);
               ast_set_flag(p, AGENT_FLAG_WRAPUPTIME);
            } else {
               p->wrapuptime = wrapuptime;
            }
            tmpoptions = pbx_builtin_getvar_helper(chan, "AGENTACCEPTDTMF");
            if (!ast_strlen_zero(tmpoptions)) {
               p->acceptdtmf = *tmpoptions;
               ast_verb(3, "Saw variable AGENTACCEPTDTMF=%s, setting acceptdtmf to: %c for Agent '%s'.\n", tmpoptions, p->acceptdtmf, p->agent);
               ast_set_flag(p, AGENT_FLAG_ACCEPTDTMF);
            }
            tmpoptions = pbx_builtin_getvar_helper(chan, "AGENTENDDTMF");
            if (!ast_strlen_zero(tmpoptions)) {
               p->enddtmf = *tmpoptions;
               ast_verb(3, "Saw variable AGENTENDDTMF=%s, setting enddtmf to: %c for Agent '%s'.\n", tmpoptions, p->enddtmf, p->agent);
               ast_set_flag(p, AGENT_FLAG_ENDDTMF);
            }
            ast_channel_unlock(chan);
            unlock_channel = 0;
            /* End Channel Specific Agent Overrides */
            if (!p->chan) {
               long logintime;
               snprintf(agent, sizeof(agent), "Agent/%s", p->agent);

               p->logincallerid[0] = '\0';
               p->acknowledged = 0;
               
               ast_mutex_unlock(&p->lock);
               AST_LIST_UNLOCK(&agents);
               if( !res && play_announcement==1 )
                  res = ast_streamfile(chan, filename, chan->language);
               if (!res)
                  ast_waitstream(chan, "");
               AST_LIST_LOCK(&agents);
               ast_mutex_lock(&p->lock);
               if (!res) {
                  res = ast_set_read_format(chan, ast_best_codec(chan->nativeformats));
                  if (res)
                     ast_log(LOG_WARNING, "Unable to set read format to %s\n", ast_getformatname(ast_best_codec(chan->nativeformats)));
               }
               if (!res) {
                  res = ast_set_write_format(chan, ast_best_codec(chan->nativeformats));
                  if (res)
                     ast_log(LOG_WARNING, "Unable to set write format to %s\n", ast_getformatname(ast_best_codec(chan->nativeformats)));
               }
               /* Check once more just in case */
               if (p->chan)
                  res = -1;
               if (!res) {
                  ast_indicate_data(chan, AST_CONTROL_HOLD, 
                     S_OR(p->moh, NULL), 
                     !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
                  if (p->loginstart == 0)
                     time(&p->loginstart);
                  manager_event(EVENT_FLAG_AGENT, "Agentlogin",
                           "Agent: %s\r\n"
                           "Channel: %s\r\n"
                           "Uniqueid: %s\r\n",
                           p->agent, chan->name, chan->uniqueid);
                  if (update_cdr && chan->cdr)
                     snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
                  ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGIN", "%s", chan->name);
                  ast_verb(2, "Agent '%s' logged in (format %s/%s)\n", p->agent,
                            ast_getformatname(chan->readformat), ast_getformatname(chan->writeformat));
                  /* Login this channel and wait for it to go away */
                  p->chan = chan;
                  if (p->ackcall) {
                     check_beep(p, 0);
                  } else {
                     check_availability(p, 0);
                  }
                  ast_mutex_unlock(&p->lock);
                  AST_LIST_UNLOCK(&agents);
                  ast_devstate_changed(AST_DEVICE_NOT_INUSE, "Agent/%s", p->agent);
                  while (res >= 0) {
                     ast_mutex_lock(&p->lock);
                     if (p->deferlogoff && p->chan) {
                        ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
                        p->deferlogoff = 0;
                     }
                     if (p->chan != chan)
                        res = -1;
                     ast_mutex_unlock(&p->lock);
                     /* Yield here so other interested threads can kick in. */
                     sched_yield();
                     if (res)
                        break;

                     AST_LIST_LOCK(&agents);
                     ast_mutex_lock(&p->lock);
                     if (p->lastdisc.tv_sec) {
                        if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0) {
                           ast_debug(1, "Wrapup time for %s expired!\n", p->agent);
                           p->lastdisc = ast_tv(0, 0);
                           ast_devstate_changed(AST_DEVICE_NOT_INUSE, "Agent/%s", p->agent);
                           if (p->ackcall) {
                              check_beep(p, 0);
                           } else {
                              check_availability(p, 0);
                           }
                        }
                     }
                     ast_mutex_unlock(&p->lock);
                     AST_LIST_UNLOCK(&agents);

                     /* Synchronize channel ownership between call to agent and itself. */
                     ast_mutex_lock(&p->lock);
                     if (p->app_lock_flag == 1) {
                        ast_cond_signal(&p->login_wait_cond);
                        ast_cond_wait(&p->app_complete_cond, &p->lock);
                     }
                     ast_mutex_unlock(&p->lock);
                     if (p->ackcall) {
                        res = agent_ack_sleep(p);
                     } else {
                        res = ast_safe_sleep_conditional( chan, 1000, agent_cont_sleep, p );
                     }
                     if (p->ackcall && (res == 1)) {
                        AST_LIST_LOCK(&agents);
                        ast_mutex_lock(&p->lock);
                        check_availability(p, 0);
                        ast_mutex_unlock(&p->lock);
                        AST_LIST_UNLOCK(&agents);
                        res = 0;
                     }
                     sched_yield();
                  }
                  ast_mutex_lock(&p->lock);
                  /* Log us off if appropriate */
                  if (p->chan == chan) {
                     p->chan = NULL;
                  }

                  /* Synchronize channel ownership between call to agent and itself. */
                  if (p->app_lock_flag == 1) {
                     ast_cond_signal(&p->login_wait_cond);
                     ast_cond_wait(&p->app_complete_cond, &p->lock);
                  }

                  if (res && p->owner)
                     ast_log(LOG_WARNING, "Huh?  We broke out when there was still an owner?\n");

                  p->acknowledged = 0;
                  logintime = time(NULL) - p->loginstart;
                  p->loginstart = 0;
                  ast_mutex_unlock(&p->lock);
                  manager_event(EVENT_FLAG_AGENT, "Agentlogoff",
                           "Agent: %s\r\n"
                           "Logintime: %ld\r\n"
                           "Uniqueid: %s\r\n",
                           p->agent, logintime, chan->uniqueid);
                  ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGOFF", "%s|%ld", chan->name, logintime);
                  ast_verb(2, "Agent '%s' logged out\n", p->agent);
                  /* If there is no owner, go ahead and kill it now */
                  ast_devstate_changed(AST_DEVICE_UNAVAILABLE, "Agent/%s", p->agent);
                  if (p->dead && !p->owner) {
                     ast_mutex_destroy(&p->lock);
                     ast_cond_destroy(&p->app_complete_cond);
                     ast_cond_destroy(&p->login_wait_cond);
                     ast_free(p);
                  }
               }
               else {
                  ast_mutex_unlock(&p->lock);
                  p = NULL;
               }
               res = -1;
            } else {
               ast_mutex_unlock(&p->lock);
               errmsg = "agent-alreadyon";
               p = NULL;
            }
            break;
         }
         ast_mutex_unlock(&p->lock);
         if (unlock_channel) {
            ast_channel_unlock(chan);
         }
      }
      if (!p)
         AST_LIST_UNLOCK(&agents);

      if (!res && (max_login_tries==0 || tries < max_login_tries))
         res = ast_app_getdata(chan, errmsg, user, sizeof(user) - 1, 0);
   }
      
   if (!res)
      res = ast_safe_sleep(chan, 500);

   ast_module_user_remove(u);
   
   return -1;
}

/*!
 *  \brief Called by the AgentMonitorOutgoing application (from the dial plan).
 *
 * \param chan
 * \param data
 * \returns
 * \sa login_exec(), load_module().
 */
static int agentmonitoroutgoing_exec(struct ast_channel *chan, const char *data)
{
   int exitifnoagentid = 0;
   int nowarnings = 0;
   int changeoutgoing = 0;
   int res = 0;
   char agent[AST_MAX_AGENT];

   if (data) {
      if (strchr(data, 'd'))
         exitifnoagentid = 1;
      if (strchr(data, 'n'))
         nowarnings = 1;
      if (strchr(data, 'c'))
         changeoutgoing = 1;
   }
   if (chan->caller.id.number.valid
      && !ast_strlen_zero(chan->caller.id.number.str)) {
      const char *tmp;
      char agentvar[AST_MAX_BUF];
      snprintf(agentvar, sizeof(agentvar), "%s_%s", GETAGENTBYCALLERID,
         chan->caller.id.number.str);
      if ((tmp = pbx_builtin_getvar_helper(NULL, agentvar))) {
         struct agent_pvt *p;
         ast_copy_string(agent, tmp, sizeof(agent));
         AST_LIST_LOCK(&agents);
         AST_LIST_TRAVERSE(&agents, p, list) {
            if (!strcasecmp(p->agent, tmp)) {
               if (changeoutgoing) snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
               __agent_start_monitoring(chan, p, 1);
               break;
            }
         }
         AST_LIST_UNLOCK(&agents);
         
      } else {
         res = -1;
         if (!nowarnings)
            ast_log(LOG_WARNING, "Couldn't find the global variable %s, so I can't figure out which agent (if it's an agent) is placing outgoing call.\n", agentvar);
      }
   } else {
      res = -1;
      if (!nowarnings)
         ast_log(LOG_WARNING, "There is no callerid on that call, so I can't figure out which agent (if it's an agent) is placing outgoing call.\n");
   }
   if (res) {
      if (exitifnoagentid)
         return res;
   }
   return 0;
}

/*! \brief Part of PBX channel interface */
static int agent_devicestate(void *data)
{
   struct agent_pvt *p;
   char *s;
   ast_group_t groupmatch;
   int groupoff;
   int res = AST_DEVICE_INVALID;
   
   s = data;
   if ((s[0] == '@') && (sscanf(s + 1, "%30d", &groupoff) == 1))
      groupmatch = (1 << groupoff);
   else if ((s[0] == ':') && (sscanf(s + 1, "%30d", &groupoff) == 1)) {
      groupmatch = (1 << groupoff);
   } else 
      groupmatch = 0;

   /* Check actual logged in agents first */
   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      ast_mutex_lock(&p->lock);
      if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
         if (p->owner) {
            if (res != AST_DEVICE_INUSE)
               res = AST_DEVICE_BUSY;
         } else {
            if (res == AST_DEVICE_BUSY)
               res = AST_DEVICE_INUSE;
            if (p->chan) {
               if (res == AST_DEVICE_INVALID)
                  res = AST_DEVICE_UNKNOWN;
            } else if (res == AST_DEVICE_INVALID)  
               res = AST_DEVICE_UNAVAILABLE;
         }
         if (!strcmp(data, p->agent)) {
            ast_mutex_unlock(&p->lock);
            break;
         }
      }
      ast_mutex_unlock(&p->lock);
   }
   AST_LIST_UNLOCK(&agents);
   return res;
}

/*!
 * \note This function expects the agent list to be locked
 */
static struct agent_pvt *find_agent(char *agentid)
{
   struct agent_pvt *cur;

   AST_LIST_TRAVERSE(&agents, cur, list) {
      if (!strcmp(cur->agent, agentid))
         break;   
   }

   return cur; 
}

static int function_agent(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
{
   char *parse;    
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(agentid);
      AST_APP_ARG(item);
   );
   char *tmp;
   struct agent_pvt *agent;

   buf[0] = '\0';

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "The AGENT function requires an argument - agentid!\n");
      return -1;
   }

   parse = ast_strdupa(data);

   AST_NONSTANDARD_APP_ARGS(args, parse, ':');
   if (!args.item)
      args.item = "status";

   AST_LIST_LOCK(&agents);

   if (!(agent = find_agent(args.agentid))) {
      AST_LIST_UNLOCK(&agents);
      ast_log(LOG_WARNING, "Agent '%s' not found!\n", args.agentid);
      return -1;
   }

   if (!strcasecmp(args.item, "status")) {
      char *status = "LOGGEDOUT";
      if (agent->chan) {
         status = "LOGGEDIN";
      }
      ast_copy_string(buf, status, len);
   } else if (!strcasecmp(args.item, "password")) 
      ast_copy_string(buf, agent->password, len);
   else if (!strcasecmp(args.item, "name"))
      ast_copy_string(buf, agent->name, len);
   else if (!strcasecmp(args.item, "mohclass"))
      ast_copy_string(buf, agent->moh, len);
   else if (!strcasecmp(args.item, "channel")) {
      if (agent->chan) {
         ast_channel_lock(agent->chan);
         ast_copy_string(buf, agent->chan->name, len);
         ast_channel_unlock(agent->chan);
         tmp = strrchr(buf, '-');
         if (tmp)
            *tmp = '\0';
      } 
   } else if (!strcasecmp(args.item, "fullchannel")) {
      if (agent->chan) {
         ast_channel_lock(agent->chan);
         ast_copy_string(buf, agent->chan->name, len);
         ast_channel_unlock(agent->chan);
      } 
   } else if (!strcasecmp(args.item, "exten")) {
      buf[0] = '\0';
   }

   AST_LIST_UNLOCK(&agents);

   return 0;
}

static struct ast_custom_function agent_function = {
   .name = "AGENT",
   .read = function_agent,
};

/*!
 * \internal
 * \brief Callback used to generate the agents tree.
 * \param[in] search The search pattern tree.
 * \retval NULL on error.
 * \retval non-NULL The generated tree.
 */
static int agents_data_provider_get(const struct ast_data_search *search,
   struct ast_data *data_root)
{
   struct agent_pvt *p;
   struct ast_data *data_agent, *data_channel, *data_talkingto;

   AST_LIST_LOCK(&agents);
   AST_LIST_TRAVERSE(&agents, p, list) {
      struct ast_channel *owner;

      data_agent = ast_data_add_node(data_root, "agent");
      if (!data_agent) {
         continue;
      }

      ast_mutex_lock(&p->lock);
      owner = agent_lock_owner(p);

      if (!(p->pending)) {
         ast_data_add_str(data_agent, "id", p->agent);
         ast_data_add_structure(agent_pvt, data_agent, p);

         ast_data_add_bool(data_agent, "logged", p->chan ? 1 : 0);
         if (p->chan) {
            data_channel = ast_data_add_node(data_agent, "loggedon");
            if (!data_channel) {
               ast_mutex_unlock(&p->lock);
               ast_data_remove_node(data_root, data_agent);
               if (owner) {
                  ast_channel_unlock(owner);
                  owner = ast_channel_unref(owner);
               }
               continue;
            }
            ast_channel_data_add_structure(data_channel, p->chan, 0);
            if (owner && ast_bridged_channel(owner)) {
               data_talkingto = ast_data_add_node(data_agent, "talkingto");
               if (!data_talkingto) {
                  ast_mutex_unlock(&p->lock);
                  ast_data_remove_node(data_root, data_agent);
                  if (owner) {
                     ast_channel_unlock(owner);
                     owner = ast_channel_unref(owner);
                  }
                  continue;
               }
               ast_channel_data_add_structure(data_talkingto, ast_bridged_channel(owner), 0);
            }
         } else {
            ast_data_add_node(data_agent, "talkingto");
            ast_data_add_node(data_agent, "loggedon");
         }
         ast_data_add_str(data_agent, "musiconhold", p->moh);
      }

      if (owner) {
         ast_channel_unlock(owner);
         owner = ast_channel_unref(owner);
      }

      ast_mutex_unlock(&p->lock);

      /* if this agent doesn't match remove the added agent. */
      if (!ast_data_search_match(search, data_agent)) {
         ast_data_remove_node(data_root, data_agent);
      }
   }
   AST_LIST_UNLOCK(&agents);

   return 0;
}

static const struct ast_data_handler agents_data_provider = {
   .version = AST_DATA_HANDLER_VERSION,
   .get = agents_data_provider_get
};

static const struct ast_data_entry agents_data_providers[] = {
   AST_DATA_ENTRY("asterisk/channel/agent/list", &agents_data_provider),
};

/*!
 * \brief Initialize the Agents module.
 * This function is being called by Asterisk when loading the module. 
 * Among other things it registers applications, cli commands and reads the cofiguration file.
 *
 * \returns int Always 0.
 */
static int load_module(void)
{
   /* Make sure we can register our agent channel type */
   if (ast_channel_register(&agent_tech)) {
      ast_log(LOG_ERROR, "Unable to register channel class 'Agent'\n");
      return AST_MODULE_LOAD_FAILURE;
   }
   /* Read in the config */
   if (!read_agent_config(0))
      return AST_MODULE_LOAD_DECLINE;
   /* Dialplan applications */
   ast_register_application_xml(app, login_exec);
   ast_register_application_xml(app3, agentmonitoroutgoing_exec);

   /* data tree */
   ast_data_register_multiple(agents_data_providers, ARRAY_LEN(agents_data_providers));

   /* Manager commands */
   ast_manager_register_xml("Agents", EVENT_FLAG_AGENT, action_agents);
   ast_manager_register_xml("AgentLogoff", EVENT_FLAG_AGENT, action_agent_logoff);

   /* CLI Commands */
   ast_cli_register_multiple(cli_agents, ARRAY_LEN(cli_agents));

   /* Dialplan Functions */
   ast_custom_function_register(&agent_function);

   return AST_MODULE_LOAD_SUCCESS;
}

static int reload(void)
{
   return read_agent_config(1);
}

static int unload_module(void)
{
   struct agent_pvt *p;
   /* First, take us out of the channel loop */
   ast_channel_unregister(&agent_tech);
   /* Unregister dialplan functions */
   ast_custom_function_unregister(&agent_function);   
   /* Unregister CLI commands */
   ast_cli_unregister_multiple(cli_agents, ARRAY_LEN(cli_agents));
   /* Unregister dialplan applications */
   ast_unregister_application(app);
   ast_unregister_application(app3);
   /* Unregister manager command */
   ast_manager_unregister("Agents");
   ast_manager_unregister("AgentLogoff");
   /* Unregister the data tree */
   ast_data_unregister(NULL);
   /* Unregister channel */
   AST_LIST_LOCK(&agents);
   /* Hangup all interfaces if they have an owner */
   while ((p = AST_LIST_REMOVE_HEAD(&agents, list))) {
      if (p->owner)
         ast_softhangup(p->owner, AST_SOFTHANGUP_APPUNLOAD);
      ast_free(p);
   }
   AST_LIST_UNLOCK(&agents);
   return 0;
}

AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Agent Proxy Channel",
      .load = load_module,
      .unload = unload_module,
      .reload = reload,
      .load_pri = AST_MODPRI_CHANNEL_DRIVER,
      .nonoptreq = "res_monitor,chan_local",
          );