Try immediately logged in agents first, then callbacklogin ones
[asterisk/asterisk.git] / channels / chan_agent.c
index b514043..466181c 100755 (executable)
@@ -49,8 +49,10 @@ static char *tdesc = "Call Agent Proxy Channel";
 static char *config = "agents.conf";
 
 static char *app = "AgentLogin";
+static char *app2 = "AgentCallbackLogin";
 
 static char *synopsis = "Call agent login";
+static char *synopsis2 = "Call agent callback login";
 
 static char *descrip =
 "  AgentLogin([AgentNo][|options]):\n"
@@ -61,6 +63,12 @@ static char *descrip =
 "The option string may contain zero or more of the following characters:\n"
 "      's' -- silent login - do not announce the login ok segment\n";
 
+static char *descrip2 =
+"  AgentCallbackLogin([AgentNo][|@context]):\n"
+"Asks the agent to login to the system with callback.  Always returns -1.\n"
+"The agent's callback extension is called (optionally with the specified\n"
+"context. \n";
+
 static char moh[80] = "default";
 
 #define AST_MAX_AGENT  80              /* Agent ID or Password max length */
@@ -68,6 +76,9 @@ static char moh[80] = "default";
 static int capability = -1;
 
 static unsigned int group;
+static int autologoff;
+static int wrapuptime;
+static int ackcall;
 
 static int usecnt =0;
 static pthread_mutex_t usecnt_lock = AST_MUTEX_INITIALIZER;
@@ -80,7 +91,13 @@ static struct agent_pvt {
        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 */
+       time_t start;                                           /* When call started */
+       struct timeval lastdisc;                        /* When last disconnected */
+       int wrapuptime;                                         /* Wrapup time in ms */
        unsigned int 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 */
@@ -89,6 +106,7 @@ static struct agent_pvt {
        volatile pthread_t owning_app;          /* Owning application thread id */
        volatile int app_sleep_cond;            /* Sleep condition for the login app */
        struct ast_channel *owner;                      /* Agent */
+       char loginchan[80];
        struct ast_channel *chan;                       /* Channel we use */
        struct agent_pvt *next;                         /* Agent */
 } *agents = NULL;
@@ -169,6 +187,9 @@ static struct agent_pvt *add_agent(char *agent, int pending)
        strncpy(p->password, password ? password : "", sizeof(p->password) - 1);
        strncpy(p->name, name ? name : "", sizeof(p->name) - 1);
        strncpy(p->moh, moh, sizeof(p->moh) - 1);
+       p->ackcall = ackcall;
+       p->autologoff = autologoff;
+       p->wrapuptime = wrapuptime;
        if (pending)
                p->dead = 1;
        else
@@ -204,15 +225,43 @@ static struct ast_frame  *agent_read(struct ast_channel *ast)
        struct agent_pvt *p = ast->pvt->pvt;
        struct ast_frame *f = NULL;
        static struct ast_frame null_frame = { AST_FRAME_NULL, };
+       static struct ast_frame answer_frame = { AST_FRAME_CONTROL, AST_CONTROL_ANSWER };
        ast_pthread_mutex_lock(&p->lock);
        if (p->chan)
                f = ast_read(p->chan);
        else
                f = &null_frame;
        if (!f) {
-               /* If there's a channel, make it NULL */
-               if (p->chan)
+               /* If there's a channel, hang it up  (if it's on a callback) make it NULL */
+               if (p->chan) {
+                       if (strlen(p->loginchan))
+                               ast_hangup(p->chan);
                        p->chan = NULL;
+                       p->acknowledged = 0;
+               }
+       }
+       if (f && (f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_ANSWER)) {
+/* TC */
+       if (p->ackcall) {
+               if (option_verbose > 2)
+                       ast_verbose(VERBOSE_PREFIX_3 "%s answered, waiting for '#' to acknowledge\n", p->chan->name);
+               /* Don't pass answer along */
+               ast_frfree(f);
+               f = &null_frame;
+        }
+        else {
+               p->acknowledged = 1;
+               f = &answer_frame;
+        }
+       }
+       if (f && (f->frametype == AST_FRAME_DTMF) && (f->subclass == '#')) {
+               if (!p->acknowledged) {
+                       if (option_verbose > 2)
+                               ast_verbose(VERBOSE_PREFIX_3 "%s acknowledged\n", p->chan->name);
+                       p->acknowledged = 1;
+                       ast_frfree(f);
+                       f = &answer_frame;
+               }
        }
        if (f && (f->frametype == AST_FRAME_DTMF) && (f->subclass == '*')) {
                /* * terminates call */
@@ -294,6 +343,15 @@ static int agent_call(struct ast_channel *ast, char *dest, int timeout)
                }
                ast_pthread_mutex_unlock(&p->lock);
                return res;
+       } else if (strlen(p->loginchan)) {
+               time(&p->start);
+               /* Call on this agent */
+               if (option_verbose > 2)
+                       ast_verbose(VERBOSE_PREFIX_3 "outgoing agentcall, to agent '%s', on '%s'\n", p->agent, p->chan->name);
+               res = ast_call(p->chan, p->loginchan, 0);
+               CLEANUP(ast,p);
+               ast_pthread_mutex_unlock(&p->lock);
+               return res;
        }
        ast_verbose( VERBOSE_PREFIX_3 "agent_call, call to agent '%s' call on '%s'\n", p->agent, p->chan->name);
        ast_log( LOG_DEBUG, "Playing beep, lang '%s'\n", p->chan->language);
@@ -332,17 +390,37 @@ static int agent_call(struct ast_channel *ast, char *dest, int timeout)
 static int agent_hangup(struct ast_channel *ast)
 {
        struct agent_pvt *p = ast->pvt->pvt;
+       int howlong = 0;
        ast_pthread_mutex_lock(&p->lock);
        p->owner = NULL;
        ast->pvt->pvt = NULL;
        p->app_sleep_cond = 1;
+       if (p->start && (ast->_state != AST_STATE_UP))
+               howlong = time(NULL) - p->start;
+       time(&p->start);
        if (p->chan) {
                /* If they're dead, go ahead and hang up on the agent now */
-               ast_pthread_mutex_lock(&p->chan->lock);
-               if (p->dead)
+               if (strlen(p->loginchan)) {
+                       p->acknowledged = 0;
+                       if (p->chan) {
+                               /* Recognize the hangup and pass it along immediately */
+                               ast_hangup(p->chan);
+                               p->chan = NULL;
+                       }
+                       ast_log(LOG_DEBUG, "Hungup, howlong is %d, autologoff is %d\n", howlong, p->autologoff);
+                       if (howlong  && 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);
+                               strcpy(p->loginchan, "");
+                       }
+               } else if (p->dead) {
+                       ast_pthread_mutex_lock(&p->chan->lock);
                        ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
-               ast_moh_start(p->chan, p->moh);
-               ast_pthread_mutex_unlock(&p->chan->lock);
+                       ast_pthread_mutex_unlock(&p->chan->lock);
+               } else {
+                       ast_pthread_mutex_lock(&p->chan->lock);
+                       ast_moh_start(p->chan, p->moh);
+                       ast_pthread_mutex_unlock(&p->chan->lock);
+               }
        }
 #if 0
                ast_pthread_mutex_unlock(&p->lock);
@@ -374,10 +452,12 @@ static int agent_hangup(struct ast_channel *ast)
                p->abouttograb = 0;
        } else if (p->dead) {
                free(p);
-       } else {
+       } else if (p->chan) {
                /* Not dead -- check availability now */
                ast_pthread_mutex_lock(&p->lock);
-               check_availability(p, 1);
+               /* check_availability(p, 1); */
+               /* Store last disconnect time */
+               gettimeofday(&p->lastdisc, NULL);
                ast_pthread_mutex_unlock(&p->lock);
        }
        return 0;
@@ -386,12 +466,19 @@ static int agent_hangup(struct ast_channel *ast)
 static int agent_cont_sleep( void *data )
 {
        struct agent_pvt *p;
+       struct timeval tv;
        int res;
 
        p = (struct agent_pvt *)data;
 
        ast_pthread_mutex_lock(&p->lock);
        res = p->app_sleep_cond;
+       if (p->lastdisc.tv_sec) {
+               gettimeofday(&tv, NULL);
+               if ((tv.tv_sec - p->lastdisc.tv_sec) * 1000 + 
+                       (tv.tv_usec - p->lastdisc.tv_usec) / 1000 > p->wrapuptime) 
+                       res = 1;
+       }
        ast_pthread_mutex_unlock(&p->lock);
 #if 0
        if( !res )
@@ -497,6 +584,9 @@ static int read_agent_config(void)
        struct ast_variable *v;
        struct agent_pvt *p, *pl, *pn;
        group = 0;
+       autologoff = 0;
+       wrapuptime = 0;
+       ackcall = 1;
        cfg = ast_load(config);
        if (!cfg) {
                ast_log(LOG_NOTICE, "No agent configuration found -- agent support disabled\n");
@@ -516,6 +606,16 @@ static int read_agent_config(void)
                        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")) {
+                        ackcall = ast_true(v->value);
+               } else if (!strcasecmp(v->name, "wrapuptime")) {
+                       wrapuptime = atoi(v->value);
+                       if (wrapuptime < 0)
+                               wrapuptime = 0;
                } else if (!strcasecmp(v->name, "musiconhold")) {
                        strncpy(moh, v->value, sizeof(moh) - 1);
                }
@@ -564,7 +664,7 @@ static int check_availability(struct agent_pvt *newlyavailable, int needlock)
                        continue;
                }
                ast_pthread_mutex_lock(&p->lock);
-               if (p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
+               if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
                        ast_log(LOG_DEBUG, "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);
@@ -591,9 +691,13 @@ static int check_availability(struct agent_pvt *newlyavailable, int needlock)
                        if (p->abouttograb) {
                                ast_setstate(parent, AST_STATE_UP);
                                ast_setstate(chan, AST_STATE_UP);
+                               /* Go ahead and mark the channel as a zombie so that masquerade will
+                                  destroy it for us, and we need not call ast_hangup */
+                               ast_pthread_mutex_lock(&parent->lock);
+                               chan->zombie = 1;
                                ast_channel_masquerade(parent, chan);
+                               ast_pthread_mutex_unlock(&parent->lock);
                                p->abouttograb = 0;
-                               ast_hangup(chan);
                        } else {
                                ast_log(LOG_DEBUG, "Sneaky, parent disappeared in the mean time...\n");
                                agent_cleanup(newlyavailable);
@@ -622,21 +726,58 @@ static struct ast_channel *agent_request(char *type, int format, void *data)
        } else {
                groupmatch = 0;
        }
+
+       /* Check actual logged in agents first */
        ast_pthread_mutex_lock(&agentlock);
        p = agents;
        while(p) {
                ast_pthread_mutex_lock(&p->lock);
-               if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
-                       /* Agent must be registered, but not have any active call */
+               if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent)) &&
+                               !p->lastdisc.tv_sec && !strlen(p->loginchan)) {
+                       /* 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);
+                       } else if (!p->owner && strlen(p->loginchan)) {
+                               /* Adjustable agent */
+                               p->chan = ast_request("Local", format, p->loginchan);
+                               if (p->chan)
+                                       chan = agent_new(p, AST_STATE_DOWN);
+                       }
+                       if (chan) {
+                               ast_pthread_mutex_unlock(&p->lock);
+                               break;
                        }
-                       ast_pthread_mutex_unlock(&p->lock);
-                       break;
                }
                ast_pthread_mutex_unlock(&p->lock);
                p = p->next;
        }
+       if (!p) {
+               p = agents;
+               while(p) {
+                       ast_pthread_mutex_lock(&p->lock);
+                       if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent)) &&
+                                       !p->lastdisc.tv_sec) {
+                               /* 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);
+                               } else if (!p->owner && strlen(p->loginchan)) {
+                                       /* Adjustable agent */
+                                       p->chan = ast_request("Local", format, p->loginchan);
+                                       if (p->chan)
+                                               chan = agent_new(p, AST_STATE_DOWN);
+                               }
+                               if (chan) {
+                                       ast_pthread_mutex_unlock(&p->lock);
+                                       break;
+                               }
+                       }
+                       ast_pthread_mutex_unlock(&p->lock);
+                       p = p->next;
+               }
+       }
+
        if (!chan && waitforagent) {
                /* No agent available -- but we're requesting to wait for one.
                   Allocate a place holder */
@@ -667,6 +808,7 @@ static int agents_show(int fd, int argc, char **argv)
        char username[256];
        char location[256];
        char talkingto[256];
+       char moh[256];
 
        if (argc != 2)
                return RESULT_SHOWUSAGE;
@@ -691,12 +833,19 @@ static int agents_show(int fd, int argc, char **argv)
                                } else {
                                        strcpy(talkingto, " is idle");
                                }
+                       } else if (strlen(p->loginchan)) {
+                               snprintf(location, sizeof(location) - 20, "available at '%s'", p->loginchan);
+                               strcpy(talkingto, "");
+                               if (p->acknowledged)
+                                       strcat(location, " (Confirmed)");
                        } else {
                                strcpy(location, "not logged in");
                                strcpy(talkingto, "");
                        }
-                       ast_cli(fd, "%-12.12s %s%s%s\n", p->agent, 
-                                       username, location, talkingto);
+                       if (strlen(p->moh))
+                               snprintf(moh, sizeof(moh), " (musiconhold is '%s')", p->moh);
+                       ast_cli(fd, "%-12.12s %s%s%s%s\n", p->agent, 
+                                       username, location, talkingto, moh);
                }
                ast_pthread_mutex_unlock(&p->lock);
                p = p->next;
@@ -716,12 +865,13 @@ static struct ast_cli_entry cli_show_agents = {
 STANDARD_LOCAL_USER;
 LOCAL_USER_DECL;
 
-static int login_exec(struct ast_channel *chan, void *data)
+static int __login_exec(struct ast_channel *chan, void *data, int callbackmode)
 {
        int res=0;
        int tries = 0;
        struct agent_pvt *p;
        struct localuser *u;
+       struct timeval tv;
        char user[AST_MAX_AGENT];
        char pass[AST_MAX_AGENT];
        char xpass[AST_MAX_AGENT] = "";
@@ -729,7 +879,9 @@ static int login_exec(struct ast_channel *chan, void *data)
        char info[512];
        char *opt_user = NULL;
        char *options = NULL;
+       char *context = NULL;
        int play_announcement;
+       char *filename = "agent-loginok";
        
        LOCAL_USER_ADD(u);
 
@@ -741,6 +893,13 @@ static int login_exec(struct ast_channel *chan, void *data)
                if (options) {
                        *options = '\0';
                        options++;
+                       if (callbackmode) {
+                               context = strchr(options, '@');
+                               if (context) {
+                                       *context = '\0';
+                                       context++;
+                               }
+                       }
                }
        }
 
@@ -782,12 +941,29 @@ static int login_exec(struct ast_channel *chan, void *data)
                        if (!strcmp(p->agent, user) &&
                                !strcmp(p->password, pass) && !p->pending) {
                                        if (!p->chan) {
+                                               if (callbackmode) {
+                                                       char tmpchan[256] = "";
+                                                       /* Retrieve login chan */
+                                                       res = ast_app_getdata(chan, "agent-newlocation", tmpchan, sizeof(tmpchan) - 1, 0);
+                                                       if (!res) {
+                                                               if (context && strlen(context) && strlen(tmpchan))
+                                                                       snprintf(p->loginchan, sizeof(p->loginchan), "%s@%s", tmpchan, context);
+                                                               else
+                                                                       strncpy(p->loginchan, tmpchan, sizeof(p->loginchan) - 1);
+                                                               if (!strlen(p->loginchan))
+                                                                       filename = "agent-loggedoff";
+                                                               p->acknowledged = 0;
+                                                       }
+                                               } else {
+                                                       strcpy(p->loginchan, "");
+                                                       p->acknowledged = 0;
+                                               }
                                                play_announcement = 1;
                                                if( options )
                                                        if( strchr( options, 's' ) )
                                                                play_announcement = 0;
-                                               if( play_announcement )
-                                                       res = ast_streamfile(chan, "agent-loginok", chan->language);
+                                               if( !res && play_announcement )
+                                                       res = ast_streamfile(chan, filename, chan->language);
                                                if (!res)
                                                        ast_waitstream(chan, "");
                                                if (!res) {
@@ -803,7 +979,18 @@ static int login_exec(struct ast_channel *chan, void *data)
                                                /* Check once more just in case */
                                                if (p->chan)
                                                        res = -1;
-                                               if (!res) {
+                                               if (callbackmode && !res) {
+                                                       /* Just say goodbye and be done with it */
+                                                       if (!res)
+                                                               res = ast_safe_sleep(chan, 500);
+                                                       res = ast_streamfile(chan, "vm-goodbye", chan->language);
+                                                       if (!res)
+                                                               res = ast_waitstream(chan, "");
+                                                       if (!res)
+                                                               res = ast_safe_sleep(chan, 1000);
+                                                       ast_pthread_mutex_unlock(&p->lock);
+                                                       ast_pthread_mutex_unlock(&agentlock);
+                                               } else if (!res) {
                                                        /* check if the moh class was changed with setmusiconhold */
                                                        if (*(chan->musicclass))
                                                                strncpy(p->moh, chan->musicclass, sizeof(p->moh) - 1);
@@ -818,6 +1005,7 @@ static int login_exec(struct ast_channel *chan, void *data)
                                                        /* Login this channel and wait for it to
                                                           go away */
                                                        p->chan = chan;
+                                                       p->acknowledged = 1;
                                                        check_availability(p, 0);
                                                        ast_pthread_mutex_unlock(&p->lock);
                                                        ast_pthread_mutex_unlock(&agentlock);
@@ -831,6 +1019,17 @@ static int login_exec(struct ast_channel *chan, void *data)
                                                                if (res)
                                                                        break;
 
+                                                               ast_pthread_mutex_lock(&p->lock);
+                                                               if (p->lastdisc.tv_sec) {
+                                                                       gettimeofday(&tv, NULL);
+                                                                       if ((tv.tv_sec - p->lastdisc.tv_sec) * 1000 + 
+                                                                               (tv.tv_usec - p->lastdisc.tv_usec) / 1000 > p->wrapuptime) {
+                                                                                       ast_log(LOG_DEBUG, "Wrapup time expired!\n");
+                                                                               memset(&p->lastdisc, 0, sizeof(p->lastdisc));
+                                                                               check_availability(p, 1);
+                                                                       }
+                                                               }
+                                                               ast_pthread_mutex_unlock(&p->lock);
                                                                /*      Synchronize channel ownership between call to agent and itself. */
                                                                pthread_mutex_lock( &p->app_lock );
                                                                ast_pthread_mutex_lock(&p->lock);
@@ -847,6 +1046,7 @@ static int login_exec(struct ast_channel *chan, void *data)
                                                        /* Log us off if appropriate */
                                                        if (p->chan == chan)
                                                                p->chan = NULL;
+                                                       p->acknowledged = 0;
                                                        ast_pthread_mutex_unlock(&p->lock);
                                                        if (option_verbose > 2)
                                                                ast_verbose(VERBOSE_PREFIX_3 "Agent '%s' logged out\n", p->agent);
@@ -884,6 +1084,15 @@ static int login_exec(struct ast_channel *chan, void *data)
        return -1;
 }
 
+static int login_exec(struct ast_channel *chan, void *data)
+{
+       return __login_exec(chan, data, 0);
+}
+
+static int callback_exec(struct ast_channel *chan, void *data)
+{
+       return __login_exec(chan, data, 1);
+}
 
 int load_module()
 {
@@ -893,6 +1102,7 @@ int load_module()
                return -1;
        }
        ast_register_application(app, login_exec, synopsis, descrip);
+       ast_register_application(app2, callback_exec, synopsis2, descrip2);
        ast_cli_register(&cli_show_agents);
        /* Read in the config */
        read_agent_config();
@@ -911,6 +1121,7 @@ int unload_module()
        /* First, take us out of the channel loop */
        ast_cli_unregister(&cli_show_agents);
        ast_unregister_application(app);
+       ast_unregister_application(app2);
        ast_channel_unregister(type);
        if (!ast_pthread_mutex_lock(&agentlock)) {
                /* Hangup all interfaces if they have an owner */