move variable declarations to the beginning of the block
[asterisk/asterisk.git] / channels / chan_agent.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19
20 /*! \file
21  * 
22  * \brief Implementation of Agents (proxy channel)
23  *
24  * \author Mark Spencer <markster@digium.com>
25  *
26  * This file is the implementation of Agents modules.
27  * It is a dynamic module that is loaded by Asterisk. 
28  * \par See also
29  * \arg \ref Config_agent
30  *
31  * \ingroup channel_drivers
32  */
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include <stdio.h>
39 #include <string.h>
40 #include <errno.h>
41 #include <unistd.h>
42 #include <sys/socket.h>
43 #include <stdlib.h>
44 #include <fcntl.h>
45 #include <netdb.h>
46 #include <netinet/in.h>
47 #include <arpa/inet.h>
48 #include <sys/signal.h>
49
50 #include "asterisk/lock.h"
51 #include "asterisk/channel.h"
52 #include "asterisk/config.h"
53 #include "asterisk/logger.h"
54 #include "asterisk/module.h"
55 #include "asterisk/pbx.h"
56 #include "asterisk/options.h"
57 #include "asterisk/lock.h"
58 #include "asterisk/sched.h"
59 #include "asterisk/io.h"
60 #include "asterisk/rtp.h"
61 #include "asterisk/acl.h"
62 #include "asterisk/callerid.h"
63 #include "asterisk/file.h"
64 #include "asterisk/cli.h"
65 #include "asterisk/app.h"
66 #include "asterisk/musiconhold.h"
67 #include "asterisk/manager.h"
68 #include "asterisk/features.h"
69 #include "asterisk/utils.h"
70 #include "asterisk/causes.h"
71 #include "asterisk/astdb.h"
72 #include "asterisk/devicestate.h"
73 #include "asterisk/monitor.h"
74 #include "asterisk/stringfields.h"
75
76 static const char tdesc[] = "Call Agent Proxy Channel";
77 static const char config[] = "agents.conf";
78
79 static const char app[] = "AgentLogin";
80 static const char app3[] = "AgentMonitorOutgoing";
81
82 static const char synopsis[] = "Call agent login";
83 static const char synopsis3[] = "Record agent's outgoing call";
84
85 static const char descrip[] =
86 "  AgentLogin([AgentNo][|options]):\n"
87 "Asks the agent to login to the system.  Always returns -1.  While\n"
88 "logged in, the agent can receive calls and will hear a 'beep'\n"
89 "when a new call comes in. The agent can dump the call by pressing\n"
90 "the star key.\n"
91 "The option string may contain zero or more of the following characters:\n"
92 "      's' -- silent login - do not announce the login ok segment after agent logged in/off\n";
93
94 static const char descrip3[] =
95 "  AgentMonitorOutgoing([options]):\n"
96 "Tries to figure out the id of the agent who is placing outgoing call based on\n"
97 "comparison of the callerid of the current interface and the global variable \n"
98 "placed by the AgentCallbackLogin application. That's why it should be used only\n"
99 "with the AgentCallbackLogin app. Uses the monitoring functions in chan_agent \n"
100 "instead of Monitor application. That have to be configured in the agents.conf file.\n"
101 "\nReturn value:\n"
102 "Normally the app returns 0 unless the options are passed.\n"
103 "\nOptions:\n"
104 "       'd' - make the app return -1 if there is an error condition"
105 "       'c' - change the CDR so that the source of the call is 'Agent/agent_id'\n"
106 "       'n' - don't generate the warnings when there is no callerid or the\n"
107 "             agentid is not known.\n"
108 "             It's handy if you want to have one context for agent and non-agent calls.\n";
109
110 static const char mandescr_agents[] =
111 "Description: Will list info about all possible agents.\n"
112 "Variables: NONE\n";
113
114 static const char mandescr_agent_logoff[] =
115 "Description: Sets an agent as no longer logged in.\n"
116 "Variables: (Names marked with * are required)\n"
117 "       *Agent: Agent ID of the agent to log off\n"
118 "       Soft: Set to 'true' to not hangup existing calls\n";
119
120 static char moh[80] = "default";
121
122 #define AST_MAX_AGENT   80                          /*!< Agent ID or Password max length */
123 #define AST_MAX_BUF     256
124 #define AST_MAX_FILENAME_LEN    256
125
126 static const char pa_family[] = "Agents";          /*!< Persistent Agents astdb family */
127 #define PA_MAX_LEN 2048                             /*!< The maximum length of each persistent member agent database entry */
128
129 static int persistent_agents = 0;                   /*!< queues.conf [general] option */
130 static void dump_agents(void);
131
132 static ast_group_t group;
133 static int autologoff;
134 static int wrapuptime;
135 static int ackcall;
136 static int endcall;
137 static int multiplelogin = 1;
138 static int autologoffunavail = 0;
139
140 static int maxlogintries = 3;
141 static char agentgoodbye[AST_MAX_FILENAME_LEN] = "vm-goodbye";
142
143 static int recordagentcalls = 0;
144 static char recordformat[AST_MAX_BUF] = "";
145 static char recordformatext[AST_MAX_BUF] = "";
146 static char urlprefix[AST_MAX_BUF] = "";
147 static char savecallsin[AST_MAX_BUF] = "";
148 static int updatecdr = 0;
149 static char beep[AST_MAX_BUF] = "beep";
150
151 #define GETAGENTBYCALLERID      "AGENTBYCALLERID"
152
153 /*! \brief Structure representing an agent.  */
154 struct agent_pvt {
155         ast_mutex_t lock;              /*!< Channel private lock */
156         int dead;                      /*!< Poised for destruction? */
157         int pending;                   /*!< Not a real agent -- just pending a match */
158         int abouttograb;               /*!< About to grab */
159         int autologoff;                /*!< Auto timeout time */
160         int ackcall;                   /*!< ackcall */
161         int deferlogoff;               /*!< Defer logoff to hangup */
162         time_t loginstart;             /*!< When agent first logged in (0 when logged off) */
163         time_t start;                  /*!< When call started */
164         struct timeval lastdisc;       /*!< When last disconnected */
165         int wrapuptime;                /*!< Wrapup time in ms */
166         ast_group_t group;             /*!< Group memberships */
167         int acknowledged;              /*!< Acknowledged */
168         char moh[80];                  /*!< Which music on hold */
169         char agent[AST_MAX_AGENT];     /*!< Agent ID */
170         char password[AST_MAX_AGENT];  /*!< Password for Agent login */
171         char name[AST_MAX_AGENT];
172         ast_mutex_t app_lock;          /**< Synchronization between owning applications */
173         volatile pthread_t owning_app; /**< Owning application thread id */
174         volatile int app_sleep_cond;   /**< Sleep condition for the login app */
175         struct ast_channel *owner;     /**< Agent */
176         char loginchan[80];            /**< channel they logged in from */
177         char logincallerid[80];        /**< Caller ID they had when they logged in */
178         struct ast_channel *chan;      /**< Channel we use */
179         AST_LIST_ENTRY(agent_pvt) list; /**< Next Agent in the linked list. */
180 };
181
182 static AST_LIST_HEAD_STATIC(agents, agent_pvt); /*!< Holds the list of agents (loaded form agents.conf). */
183
184 #define CHECK_FORMATS(ast, p) do { \
185         if (p->chan) {\
186                 if (ast->nativeformats != p->chan->nativeformats) { \
187                         ast_debug(1, "Native formats changing from %d to %d\n", ast->nativeformats, p->chan->nativeformats); \
188                         /* Native formats changed, reset things */ \
189                         ast->nativeformats = p->chan->nativeformats; \
190                         ast_debug(1, "Resetting read to %d and write to %d\n", ast->readformat, ast->writeformat);\
191                         ast_set_read_format(ast, ast->readformat); \
192                         ast_set_write_format(ast, ast->writeformat); \
193                 } \
194                 if (p->chan->readformat != ast->rawreadformat)  \
195                         ast_set_read_format(p->chan, ast->rawreadformat); \
196                 if (p->chan->writeformat != ast->rawwriteformat) \
197                         ast_set_write_format(p->chan, ast->rawwriteformat); \
198         } \
199 } while(0)
200
201 /*! \brief Cleanup moves all the relevant FD's from the 2nd to the first, but retains things
202    properly for a timingfd XXX This might need more work if agents were logged in as agents or other
203    totally impractical combinations XXX */
204
205 #define CLEANUP(ast, p) do { \
206         int x; \
207         if (p->chan) { \
208                 for (x=0;x<AST_MAX_FDS;x++) {\
209                         if (x != AST_TIMING_FD) \
210                                 ast->fds[x] = p->chan->fds[x]; \
211                 } \
212                 ast->fds[AST_AGENT_FD] = p->chan->fds[AST_TIMING_FD]; \
213         } \
214 } while(0)
215
216 /*--- Forward declarations */
217 static struct ast_channel *agent_request(const char *type, int format, void *data, int *cause);
218 static int agent_devicestate(void *data);
219 static void agent_logoff_maintenance(struct agent_pvt *p, char *loginchan, long logintime, const char *uniqueid, char *logcommand);
220 static int agent_digit_begin(struct ast_channel *ast, char digit);
221 static int agent_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
222 static int agent_call(struct ast_channel *ast, char *dest, int timeout);
223 static int agent_hangup(struct ast_channel *ast);
224 static int agent_answer(struct ast_channel *ast);
225 static struct ast_frame *agent_read(struct ast_channel *ast);
226 static int agent_write(struct ast_channel *ast, struct ast_frame *f);
227 static int agent_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
228 static int agent_sendtext(struct ast_channel *ast, const char *text);
229 static int agent_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
230 static int agent_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
231 static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct ast_channel *bridge);
232 static void set_agentbycallerid(const char *callerid, const char *agent);
233
234 /*! \brief Channel interface description for PBX integration */
235 static const struct ast_channel_tech agent_tech = {
236         .type = "Agent",
237         .description = tdesc,
238         .capabilities = -1,
239         .requester = agent_request,
240         .devicestate = agent_devicestate,
241         .send_digit_begin = agent_digit_begin,
242         .send_digit_end = agent_digit_end,
243         .call = agent_call,
244         .hangup = agent_hangup,
245         .answer = agent_answer,
246         .read = agent_read,
247         .write = agent_write,
248         .write_video = agent_write,
249         .send_html = agent_sendhtml,
250         .send_text = agent_sendtext,
251         .exception = agent_read,
252         .indicate = agent_indicate,
253         .fixup = agent_fixup,
254         .bridged_channel = agent_bridgedchannel,
255 };
256
257 /*!
258  * Adds an agent to the global list of agents.
259  *
260  * \param agent A string with the username, password and real name of an agent. As defined in agents.conf. Example: "13,169,John Smith"
261  * \param pending If it is pending or not.
262  * @return The just created agent.
263  * \sa agent_pvt, agents.
264  */
265 static struct agent_pvt *add_agent(char *agent, int pending)
266 {
267         char *parse;
268         AST_DECLARE_APP_ARGS(args,
269                 AST_APP_ARG(agt);
270                 AST_APP_ARG(password);
271                 AST_APP_ARG(name);
272         );
273         char *password = NULL;
274         char *name = NULL;
275         char *agt = NULL;
276         struct agent_pvt *p;
277
278         parse = ast_strdupa(agent);
279
280         /* Extract username (agt), password and name from agent (args). */
281         AST_NONSTANDARD_APP_ARGS(args, parse, ',');
282
283         if(args.argc == 0) {
284                 ast_log(LOG_WARNING, "A blank agent line!\n");
285                 return NULL;
286         }
287
288         if(ast_strlen_zero(args.agt) ) {
289                 ast_log(LOG_WARNING, "An agent line with no agentid!\n");
290                 return NULL;
291         } else
292                 agt = args.agt;
293
294         if(!ast_strlen_zero(args.password)) {
295                 password = args.password;
296                 while (*password && *password < 33) password++;
297         }
298         if(!ast_strlen_zero(args.name)) {
299                 name = args.name;
300                 while (*name && *name < 33) name++;
301         }
302         
303         /* Are we searching for the agent here ? To see if it exists already ? */
304         AST_LIST_TRAVERSE(&agents, p, list) {
305                 if (!pending && !strcmp(p->agent, agt))
306                         break;
307         }
308         if (!p) {
309                 // Build the agent.
310                 if (!(p = ast_calloc(1, sizeof(*p))))
311                         return NULL;
312                 ast_copy_string(p->agent, agt, sizeof(p->agent));
313                 ast_mutex_init(&p->lock);
314                 ast_mutex_init(&p->app_lock);
315                 p->owning_app = (pthread_t) -1;
316                 p->app_sleep_cond = 1;
317                 p->group = group;
318                 p->pending = pending;
319                 AST_LIST_INSERT_TAIL(&agents, p, list);
320         }
321         
322         ast_copy_string(p->password, password ? password : "", sizeof(p->password));
323         ast_copy_string(p->name, name ? name : "", sizeof(p->name));
324         ast_copy_string(p->moh, moh, sizeof(p->moh));
325         p->ackcall = ackcall;
326         p->autologoff = autologoff;
327
328         /* If someone reduces the wrapuptime and reloads, we want it
329          * to change the wrapuptime immediately on all calls */
330         if (p->wrapuptime > wrapuptime) {
331                 struct timeval now = ast_tvnow();
332                 /* XXX check what is this exactly */
333
334                 /* We won't be pedantic and check the tv_usec val */
335                 if (p->lastdisc.tv_sec > (now.tv_sec + wrapuptime/1000)) {
336                         p->lastdisc.tv_sec = now.tv_sec + wrapuptime/1000;
337                         p->lastdisc.tv_usec = now.tv_usec;
338                 }
339         }
340         p->wrapuptime = wrapuptime;
341
342         if (pending)
343                 p->dead = 1;
344         else
345                 p->dead = 0;
346         return p;
347 }
348
349 /*!
350  * Deletes an agent after doing some clean up.
351  * Further documentation: How safe is this function ? What state should the agent be to be cleaned.
352  * \param p Agent to be deleted.
353  * \returns Always 0.
354  */
355 static int agent_cleanup(struct agent_pvt *p)
356 {
357         struct ast_channel *chan = p->owner;
358         p->owner = NULL;
359         chan->tech_pvt = NULL;
360         p->app_sleep_cond = 1;
361         /* Release ownership of the agent to other threads (presumably running the login app). */
362         ast_mutex_unlock(&p->app_lock);
363         if (chan)
364                 ast_channel_free(chan);
365         if (p->dead) {
366                 ast_mutex_destroy(&p->lock);
367                 ast_mutex_destroy(&p->app_lock);
368                 ast_free(p);
369         }
370         return 0;
371 }
372
373 static int check_availability(struct agent_pvt *newlyavailable, int needlock);
374
375 static int agent_answer(struct ast_channel *ast)
376 {
377         ast_log(LOG_WARNING, "Huh?  Agent is being asked to answer?\n");
378         return -1;
379 }
380
381 static int __agent_start_monitoring(struct ast_channel *ast, struct agent_pvt *p, int needlock)
382 {
383         char tmp[AST_MAX_BUF],tmp2[AST_MAX_BUF], *pointer;
384         char filename[AST_MAX_BUF];
385         int res = -1;
386         if (!p)
387                 return -1;
388         if (!ast->monitor) {
389                 snprintf(filename, sizeof(filename), "agent-%s-%s",p->agent, ast->uniqueid);
390                 /* substitute . for - */
391                 if ((pointer = strchr(filename, '.')))
392                         *pointer = '-';
393                 snprintf(tmp, sizeof(tmp), "%s%s",savecallsin ? savecallsin : "", filename);
394                 ast_monitor_start(ast, recordformat, tmp, needlock);
395                 ast_monitor_setjoinfiles(ast, 1);
396                 snprintf(tmp2, sizeof(tmp2), "%s%s.%s", urlprefix ? urlprefix : "", filename, recordformatext);
397 #if 0
398                 ast_verbose("name is %s, link is %s\n",tmp, tmp2);
399 #endif
400                 if (!ast->cdr)
401                         ast->cdr = ast_cdr_alloc();
402                 ast_cdr_setuserfield(ast, tmp2);
403                 res = 0;
404         } else
405                 ast_log(LOG_ERROR, "Recording already started on that call.\n");
406         return res;
407 }
408
409 static int agent_start_monitoring(struct ast_channel *ast, int needlock)
410 {
411         return __agent_start_monitoring(ast, ast->tech_pvt, needlock);
412 }
413
414 static struct ast_frame *agent_read(struct ast_channel *ast)
415 {
416         struct agent_pvt *p = ast->tech_pvt;
417         struct ast_frame *f = NULL;
418         static struct ast_frame answer_frame = { AST_FRAME_CONTROL, AST_CONTROL_ANSWER };
419         const char *status;
420         ast_mutex_lock(&p->lock); 
421         CHECK_FORMATS(ast, p);
422         if (p->chan) {
423                 ast_copy_flags(p->chan, ast, AST_FLAG_EXCEPTION);
424                 p->chan->fdno = (ast->fdno == AST_AGENT_FD) ? AST_TIMING_FD : ast->fdno;
425                 f = ast_read(p->chan);
426         } else
427                 f = &ast_null_frame;
428         if (!f) {
429                 /* If there's a channel, hang it up (if it's on a callback) make it NULL */
430                 if (p->chan) {
431                         p->chan->_bridge = NULL;
432                         /* Note that we don't hangup if it's not a callback because Asterisk will do it
433                            for us when the PBX instance that called login finishes */
434                         if (!ast_strlen_zero(p->loginchan)) {
435                                 if (p->chan)
436                                         ast_debug(1, "Bridge on '%s' being cleared (2)\n", p->chan->name);
437
438                                 status = pbx_builtin_getvar_helper(p->chan, "CHANLOCALSTATUS");
439                                 if (autologoffunavail && status && !strcasecmp(status, "CHANUNAVAIL")) {
440                                         long logintime = time(NULL) - p->loginstart;
441                                         p->loginstart = 0;
442                                         ast_log(LOG_NOTICE, "Agent read: '%s' is not available now, auto logoff\n", p->name);
443                                         agent_logoff_maintenance(p, p->loginchan, logintime, ast->uniqueid, "Chanunavail");
444                                 }
445                                 ast_hangup(p->chan);
446                                 if (p->wrapuptime && p->acknowledged)
447                                         p->lastdisc = ast_tvadd(ast_tvnow(), ast_samp2tv(p->wrapuptime, 1000));
448                         }
449                         p->chan = NULL;
450                         p->acknowledged = 0;
451                 }
452         } else {
453                 /* if acknowledgement is not required, and the channel is up, we may have missed
454                    an AST_CONTROL_ANSWER (if there was one), so mark the call acknowledged anyway */
455                 if (!p->ackcall && !p->acknowledged && p->chan && (p->chan->_state == AST_STATE_UP))
456                         p->acknowledged = 1;
457                 switch (f->frametype) {
458                 case AST_FRAME_CONTROL:
459                         if (f->subclass == AST_CONTROL_ANSWER) {
460                                 if (p->ackcall) {
461                                         if (option_verbose > 2)
462                                                 ast_verbose(VERBOSE_PREFIX_3 "%s answered, waiting for '#' to acknowledge\n", p->chan->name);
463                                         /* Don't pass answer along */
464                                         ast_frfree(f);
465                                         f = &ast_null_frame;
466                                 } else {
467                                         p->acknowledged = 1;
468                                         /* Use the builtin answer frame for the 
469                                            recording start check below. */
470                                         ast_frfree(f);
471                                         f = &answer_frame;
472                                 }
473                         }
474                         break;
475                 case AST_FRAME_DTMF_BEGIN:
476                 case AST_FRAME_DTMF_END:
477                         if (!p->acknowledged && (f->subclass == '#')) {
478                                 if (option_verbose > 2)
479                                         ast_verbose(VERBOSE_PREFIX_3 "%s acknowledged\n", p->chan->name);
480                                 p->acknowledged = 1;
481                                 ast_frfree(f);
482                                 f = &answer_frame;
483                         } else if (f->subclass == '*' && endcall) {
484                                 /* terminates call */
485                                 ast_frfree(f);
486                                 f = NULL;
487                         }
488                         break;
489                 case AST_FRAME_VOICE:
490                 case AST_FRAME_VIDEO:
491                         /* don't pass voice or video until the call is acknowledged */
492                         if (!p->acknowledged) {
493                                 ast_frfree(f);
494                                 f = &ast_null_frame;
495                         }
496                 default:
497                         /* pass everything else on through */
498                         break;
499                 }
500         }
501
502         CLEANUP(ast,p);
503         if (p->chan && !p->chan->_bridge) {
504                 if (strcasecmp(p->chan->tech->type, "Local")) {
505                         p->chan->_bridge = ast;
506                         if (p->chan)
507                                 ast_debug(1, "Bridge on '%s' being set to '%s' (3)\n", p->chan->name, p->chan->_bridge->name);
508                 }
509         }
510         ast_mutex_unlock(&p->lock);
511         if (recordagentcalls && f == &answer_frame)
512                 agent_start_monitoring(ast,0);
513         return f;
514 }
515
516 static int agent_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen)
517 {
518         struct agent_pvt *p = ast->tech_pvt;
519         int res = -1;
520         ast_mutex_lock(&p->lock);
521         if (p->chan) 
522                 res = ast_channel_sendhtml(p->chan, subclass, data, datalen);
523         ast_mutex_unlock(&p->lock);
524         return res;
525 }
526
527 static int agent_sendtext(struct ast_channel *ast, const char *text)
528 {
529         struct agent_pvt *p = ast->tech_pvt;
530         int res = -1;
531         ast_mutex_lock(&p->lock);
532         if (p->chan) 
533                 res = ast_sendtext(p->chan, text);
534         ast_mutex_unlock(&p->lock);
535         return res;
536 }
537
538 static int agent_write(struct ast_channel *ast, struct ast_frame *f)
539 {
540         struct agent_pvt *p = ast->tech_pvt;
541         int res = -1;
542         CHECK_FORMATS(ast, p);
543         ast_mutex_lock(&p->lock);
544         if (!p->chan) 
545                 res = 0;
546         else {
547                 if ((f->frametype != AST_FRAME_VOICE) ||
548                     (f->frametype != AST_FRAME_VIDEO) ||
549                     (f->subclass == p->chan->writeformat)) {
550                         res = ast_write(p->chan, f);
551                 } else {
552                         ast_debug(1, "Dropping one incompatible %s frame on '%s' to '%s'\n", 
553                                 f->frametype == AST_FRAME_VOICE ? "audio" : "video",
554                                 ast->name, p->chan->name);
555                         res = 0;
556                 }
557         }
558         CLEANUP(ast, p);
559         ast_mutex_unlock(&p->lock);
560         return res;
561 }
562
563 static int agent_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
564 {
565         struct agent_pvt *p = newchan->tech_pvt;
566         ast_mutex_lock(&p->lock);
567         if (p->owner != oldchan) {
568                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
569                 ast_mutex_unlock(&p->lock);
570                 return -1;
571         }
572         p->owner = newchan;
573         ast_mutex_unlock(&p->lock);
574         return 0;
575 }
576
577 static int agent_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen)
578 {
579         struct agent_pvt *p = ast->tech_pvt;
580         int res = -1;
581         ast_mutex_lock(&p->lock);
582         if (p->chan)
583                 res = p->chan->tech->indicate ? p->chan->tech->indicate(p->chan, condition, data, datalen) : -1;
584         else
585                 res = 0;
586         ast_mutex_unlock(&p->lock);
587         return res;
588 }
589
590 static int agent_digit_begin(struct ast_channel *ast, char digit)
591 {
592         struct agent_pvt *p = ast->tech_pvt;
593         ast_mutex_lock(&p->lock);
594         ast_senddigit_begin(p->chan, digit);
595         ast_mutex_unlock(&p->lock);
596         return 0;
597 }
598
599 static int agent_digit_end(struct ast_channel *ast, char digit, unsigned int duration)
600 {
601         struct agent_pvt *p = ast->tech_pvt;
602         ast_mutex_lock(&p->lock);
603         ast_senddigit_end(p->chan, digit, duration);
604         ast_mutex_unlock(&p->lock);
605         return 0;
606 }
607
608 static int agent_call(struct ast_channel *ast, char *dest, int timeout)
609 {
610         struct agent_pvt *p = ast->tech_pvt;
611         int res = -1;
612         int newstate=0;
613         ast_mutex_lock(&p->lock);
614         p->acknowledged = 0;
615         if (!p->chan) {
616                 if (p->pending) {
617                         ast_debug(1, "Pretending to dial on pending agent\n");
618                         newstate = AST_STATE_DIALING;
619                         res = 0;
620                 } else {
621                         ast_log(LOG_NOTICE, "Whoa, they hung up between alloc and call...  what are the odds of that?\n");
622                         res = -1;
623                 }
624                 ast_mutex_unlock(&p->lock);
625                 if (newstate)
626                         ast_setstate(ast, newstate);
627                 return res;
628         } else if (!ast_strlen_zero(p->loginchan)) {
629                 time(&p->start);
630                 /* Call on this agent */
631                 if (option_verbose > 2)
632                         ast_verbose(VERBOSE_PREFIX_3 "outgoing agentcall, to agent '%s', on '%s'\n", p->agent, p->chan->name);
633                 ast_set_callerid(p->chan,
634                         ast->cid.cid_num, ast->cid.cid_name, NULL);
635                 ast_channel_inherit_variables(ast, p->chan);
636                 res = ast_call(p->chan, p->loginchan, 0);
637                 CLEANUP(ast,p);
638                 ast_mutex_unlock(&p->lock);
639                 return res;
640         }
641         ast_verbose( VERBOSE_PREFIX_3 "agent_call, call to agent '%s' call on '%s'\n", p->agent, p->chan->name);
642         ast_debug(3, "Playing beep, lang '%s'\n", p->chan->language);
643         res = ast_streamfile(p->chan, beep, p->chan->language);
644         ast_debug(3, "Played beep, result '%d'\n", res);
645         if (!res) {
646                 res = ast_waitstream(p->chan, "");
647                 ast_debug(3, "Waited for stream, result '%d'\n", res);
648         }
649         if (!res) {
650                 res = ast_set_read_format(p->chan, ast_best_codec(p->chan->nativeformats));
651                 ast_debug(3, "Set read format, result '%d'\n", res);
652                 if (res)
653                         ast_log(LOG_WARNING, "Unable to set read format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
654         } else {
655                 /* Agent hung-up */
656                 p->chan = NULL;
657         }
658
659         if (!res) {
660                 res = ast_set_write_format(p->chan, ast_best_codec(p->chan->nativeformats));
661                 ast_debug(3, "Set write format, result '%d'\n", res);
662                 if (res)
663                         ast_log(LOG_WARNING, "Unable to set write format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
664         }
665         if(!res) {
666                 /* Call is immediately up, or might need ack */
667                 if (p->ackcall > 1)
668                         newstate = AST_STATE_RINGING;
669                 else {
670                         newstate = AST_STATE_UP;
671                         if (recordagentcalls)
672                                 agent_start_monitoring(ast, 0);
673                         p->acknowledged = 1;
674                 }
675                 res = 0;
676         }
677         CLEANUP(ast, p);
678         ast_mutex_unlock(&p->lock);
679         if (newstate)
680                 ast_setstate(ast, newstate);
681         return res;
682 }
683
684 /*! \brief store/clear the global variable that stores agentid based on the callerid */
685 static void set_agentbycallerid(const char *callerid, const char *agent)
686 {
687         char buf[AST_MAX_BUF];
688
689         /* if there is no Caller ID, nothing to do */
690         if (ast_strlen_zero(callerid))
691                 return;
692
693         snprintf(buf, sizeof(buf), "%s_%s", GETAGENTBYCALLERID, callerid);
694         pbx_builtin_setvar_helper(NULL, buf, agent);
695 }
696
697 static int agent_hangup(struct ast_channel *ast)
698 {
699         struct agent_pvt *p = ast->tech_pvt;
700         int howlong = 0;
701         const char *status;
702         ast_mutex_lock(&p->lock);
703         p->owner = NULL;
704         ast->tech_pvt = NULL;
705         p->app_sleep_cond = 1;
706         p->acknowledged = 0;
707
708         /* if they really are hung up then set start to 0 so the test
709          * later if we're called on an already downed channel
710          * doesn't cause an agent to be logged out like when
711          * agent_request() is followed immediately by agent_hangup()
712          * as in apps/app_chanisavail.c:chanavail_exec()
713          */
714
715         ast_debug(1, "Hangup called for state %s\n", ast_state2str(ast->_state));
716         if (p->start && (ast->_state != AST_STATE_UP)) {
717                 howlong = time(NULL) - p->start;
718                 p->start = 0;
719         } else if (ast->_state == AST_STATE_RESERVED) 
720                 howlong = 0;
721         else
722                 p->start = 0; 
723         if (p->chan) {
724                 p->chan->_bridge = NULL;
725                 /* If they're dead, go ahead and hang up on the agent now */
726                 if (!ast_strlen_zero(p->loginchan)) {
727                         /* Store last disconnect time */
728                         if (p->wrapuptime)
729                                 p->lastdisc = ast_tvadd(ast_tvnow(), ast_samp2tv(p->wrapuptime, 1000));
730                         else
731                                 p->lastdisc = ast_tv(0,0);
732                         if (p->chan) {
733                                 status = pbx_builtin_getvar_helper(p->chan, "CHANLOCALSTATUS");
734                                 if (autologoffunavail && status && !strcasecmp(status, "CHANUNAVAIL")) {
735                                         long logintime = time(NULL) - p->loginstart;
736                                         p->loginstart = 0;
737                                         ast_log(LOG_NOTICE, "Agent hangup: '%s' is not available now, auto logoff\n", p->name);
738                                         agent_logoff_maintenance(p, p->loginchan, logintime, ast->uniqueid, "Chanunavail");
739                                 }
740                                 /* Recognize the hangup and pass it along immediately */
741                                 ast_hangup(p->chan);
742                                 p->chan = NULL;
743                         }
744                         ast_debug(1, "Hungup, howlong is %d, autologoff is %d\n", howlong, p->autologoff);
745                         if ((p->deferlogoff) || (howlong && p->autologoff && (howlong > p->autologoff))) {
746                                 long logintime = time(NULL) - p->loginstart;
747                                 p->loginstart = 0;
748                                 if (!p->deferlogoff)
749                                         ast_log(LOG_NOTICE, "Agent '%s' didn't answer/confirm within %d seconds (waited %d)\n", p->name, p->autologoff, howlong);
750                                 p->deferlogoff = 0;
751                                 agent_logoff_maintenance(p, p->loginchan, logintime, ast->uniqueid, "Autologoff");
752                                 if (persistent_agents)
753                                         dump_agents();
754                         }
755                 } else if (p->dead) {
756                         ast_channel_lock(p->chan);
757                         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
758                         ast_channel_unlock(p->chan);
759                 } else if (p->loginstart) {
760                         ast_channel_lock(p->chan);
761                         ast_indicate_data(p->chan, AST_CONTROL_HOLD, 
762                                 S_OR(p->moh, NULL),
763                                 !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
764                         ast_channel_unlock(p->chan);
765                 }
766         }
767         ast_mutex_unlock(&p->lock);
768
769         /* Only register a device state change if the agent is still logged in */
770         if (!p->loginstart) {
771                 p->loginchan[0] = '\0';
772                 p->logincallerid[0] = '\0';
773                 if (persistent_agents)
774                         dump_agents();
775         } else {
776                 ast_device_state_changed("Agent/%s", p->agent);
777         }
778
779         if (p->pending) {
780                 AST_LIST_LOCK(&agents);
781                 AST_LIST_REMOVE(&agents, p, list);
782                 AST_LIST_UNLOCK(&agents);
783         }
784         if (p->abouttograb) {
785                 /* Let the "about to grab" thread know this isn't valid anymore, and let it
786                    kill it later */
787                 p->abouttograb = 0;
788         } else if (p->dead) {
789                 ast_mutex_destroy(&p->lock);
790                 ast_mutex_destroy(&p->app_lock);
791                 ast_free(p);
792         } else {
793                 if (p->chan) {
794                         /* Not dead -- check availability now */
795                         ast_mutex_lock(&p->lock);
796                         /* Store last disconnect time */
797                         p->lastdisc = ast_tvnow();
798                         ast_mutex_unlock(&p->lock);
799                 }
800                 /* Release ownership of the agent to other threads (presumably running the login app). */
801                 if (ast_strlen_zero(p->loginchan))
802                         ast_mutex_unlock(&p->app_lock);
803         }
804         return 0;
805 }
806
807 static int agent_cont_sleep( void *data )
808 {
809         struct agent_pvt *p;
810         int res;
811
812         p = (struct agent_pvt *)data;
813
814         ast_mutex_lock(&p->lock);
815         res = p->app_sleep_cond;
816         if (p->lastdisc.tv_sec) {
817                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > p->wrapuptime) 
818                         res = 1;
819         }
820         ast_mutex_unlock(&p->lock);
821
822         if (!res)
823                 ast_debug(5, "agent_cont_sleep() returning %d\n", res );
824
825         return res;
826 }
827
828 static int agent_ack_sleep(void *data)
829 {
830         struct agent_pvt *p;
831         int res=0;
832         int to = 1000;
833         struct ast_frame *f;
834
835         /* Wait a second and look for something */
836
837         p = (struct agent_pvt *) data;
838         if (!p->chan) 
839                 return -1;
840
841         for(;;) {
842                 to = ast_waitfor(p->chan, to);
843                 if (to < 0) 
844                         return -1;
845                 if (!to) 
846                         return 0;
847                 f = ast_read(p->chan);
848                 if (!f) 
849                         return -1;
850                 if (f->frametype == AST_FRAME_DTMF)
851                         res = f->subclass;
852                 else
853                         res = 0;
854                 ast_frfree(f);
855                 ast_mutex_lock(&p->lock);
856                 if (!p->app_sleep_cond) {
857                         ast_mutex_unlock(&p->lock);
858                         return 0;
859                 } else if (res == '#') {
860                         ast_mutex_unlock(&p->lock);
861                         return 1;
862                 }
863                 ast_mutex_unlock(&p->lock);
864                 res = 0;
865         }
866         return res;
867 }
868
869 static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct ast_channel *bridge)
870 {
871         struct agent_pvt *p = bridge->tech_pvt;
872         struct ast_channel *ret = NULL;
873
874         if (p) {
875                 if (chan == p->chan)
876                         ret = bridge->_bridge;
877                 else if (chan == bridge->_bridge)
878                         ret = p->chan;
879         }
880
881         ast_debug(1, "Asked for bridged channel on '%s'/'%s', returning '%s'\n", chan->name, bridge->name, ret ? ret->name : "<none>");
882         return ret;
883 }
884
885 /*! \brief Create new agent channel */
886 static struct ast_channel *agent_new(struct agent_pvt *p, int state)
887 {
888         struct ast_channel *tmp;
889 #if 0
890         if (!p->chan) {
891                 ast_log(LOG_WARNING, "No channel? :(\n");
892                 return NULL;
893         }
894 #endif  
895         if (p->pending)
896                 tmp = ast_channel_alloc(0, state, 0, 0, "", p->chan ? p->chan->exten:"", p->chan ? p->chan->context:"", 0, "Agent/P%s-%d", p->agent, ast_random() & 0xffff);
897         else
898                 tmp = ast_channel_alloc(0, state, 0, 0, "", p->chan ? p->chan->exten:"", p->chan ? p->chan->context:"", 0, "Agent/%s", p->agent);
899         if (!tmp) {
900                 ast_log(LOG_WARNING, "Unable to allocate agent channel structure\n");
901                 return NULL;
902         }
903
904         tmp->tech = &agent_tech;
905         if (p->chan) {
906                 tmp->nativeformats = p->chan->nativeformats;
907                 tmp->writeformat = p->chan->writeformat;
908                 tmp->rawwriteformat = p->chan->writeformat;
909                 tmp->readformat = p->chan->readformat;
910                 tmp->rawreadformat = p->chan->readformat;
911                 ast_string_field_set(tmp, language, p->chan->language);
912                 ast_copy_string(tmp->context, p->chan->context, sizeof(tmp->context));
913                 ast_copy_string(tmp->exten, p->chan->exten, sizeof(tmp->exten));
914                 /* XXX Is this really all we copy form the originating channel?? */
915         } else {
916                 tmp->nativeformats = AST_FORMAT_SLINEAR;
917                 tmp->writeformat = AST_FORMAT_SLINEAR;
918                 tmp->rawwriteformat = AST_FORMAT_SLINEAR;
919                 tmp->readformat = AST_FORMAT_SLINEAR;
920                 tmp->rawreadformat = AST_FORMAT_SLINEAR;
921         }
922         /* Safe, agentlock already held */
923         tmp->tech_pvt = p;
924         p->owner = tmp;
925         tmp->priority = 1;
926         /* Wake up and wait for other applications (by definition the login app)
927          * to release this channel). Takes ownership of the agent channel
928          * to this thread only.
929          * For signalling the other thread, ast_queue_frame is used until we
930          * can safely use signals for this purpose. The pselect() needs to be
931          * implemented in the kernel for this.
932          */
933         p->app_sleep_cond = 0;
934         if(ast_strlen_zero(p->loginchan) && ast_mutex_trylock(&p->app_lock)) {
935                 if (p->chan) {
936                         ast_queue_frame(p->chan, &ast_null_frame);
937                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
938                         ast_mutex_lock(&p->app_lock);
939                         ast_mutex_lock(&p->lock);
940                 } else {
941                         ast_log(LOG_WARNING, "Agent disconnected while we were connecting the call\n");
942                         p->owner = NULL;
943                         tmp->tech_pvt = NULL;
944                         p->app_sleep_cond = 1;
945                         ast_channel_free( tmp );
946                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
947                         ast_mutex_unlock(&p->app_lock);
948                         return NULL;
949                 }
950         } else if (!ast_strlen_zero(p->loginchan)) {
951                 if (p->chan)
952                         ast_queue_frame(p->chan, &ast_null_frame);
953                 if (!p->chan) {
954                         ast_log(LOG_WARNING, "Agent disconnected while we were connecting the call\n");
955                         p->owner = NULL;
956                         tmp->tech_pvt = NULL;
957                         p->app_sleep_cond = 1;
958                         ast_channel_free( tmp );
959                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
960                         return NULL;
961                 }       
962         } 
963         if (p->chan)
964                 ast_indicate(p->chan, AST_CONTROL_UNHOLD);
965         p->owning_app = pthread_self();
966         /* After the above step, there should not be any blockers. */
967         if (p->chan) {
968                 if (ast_test_flag(p->chan, AST_FLAG_BLOCKING)) {
969                         ast_log( LOG_ERROR, "A blocker exists after agent channel ownership acquired\n" );
970                         CRASH;
971                 }
972         }
973         return tmp;
974 }
975
976
977 /*!
978  * Read configuration data. The file named agents.conf.
979  *
980  * \returns Always 0, or so it seems.
981  */
982 static int read_agent_config(void)
983 {
984         struct ast_config *cfg;
985         struct ast_config *ucfg;
986         struct ast_variable *v;
987         struct agent_pvt *p;
988         const char *general_val;
989         const char *catname;
990         const char *hasagent;
991         int genhasagent;
992
993         group = 0;
994         autologoff = 0;
995         wrapuptime = 0;
996         ackcall = 0;
997         endcall = 1;
998         cfg = ast_config_load(config);
999         if (!cfg) {
1000                 ast_log(LOG_NOTICE, "No agent configuration found -- agent support disabled\n");
1001                 return 0;
1002         }
1003         AST_LIST_LOCK(&agents);
1004         AST_LIST_TRAVERSE(&agents, p, list) {
1005                 p->dead = 1;
1006         }
1007         strcpy(moh, "default");
1008         /* set the default recording values */
1009         recordagentcalls = 0;
1010         strcpy(recordformat, "wav");
1011         strcpy(recordformatext, "wav");
1012         urlprefix[0] = '\0';
1013         savecallsin[0] = '\0';
1014
1015         /* Read in [general] section for persistence */
1016         if ((general_val = ast_variable_retrieve(cfg, "general", "persistentagents")))
1017                 persistent_agents = ast_true(general_val);
1018         multiplelogin = ast_true(ast_variable_retrieve(cfg, "general", "multiplelogin"));
1019
1020         /* Read in the [agents] section */
1021         v = ast_variable_browse(cfg, "agents");
1022         while(v) {
1023                 /* Create the interface list */
1024                 if (!strcasecmp(v->name, "agent")) {
1025                         add_agent(v->value, 0);
1026                 } else if (!strcasecmp(v->name, "group")) {
1027                         group = ast_get_group(v->value);
1028                 } else if (!strcasecmp(v->name, "autologoff")) {
1029                         autologoff = atoi(v->value);
1030                         if (autologoff < 0)
1031                                 autologoff = 0;
1032                 } else if (!strcasecmp(v->name, "ackcall")) {
1033                         if (!strcasecmp(v->value, "always"))
1034                                 ackcall = 2;
1035                         else if (ast_true(v->value))
1036                                 ackcall = 1;
1037                         else
1038                                 ackcall = 0;
1039                 } else if (!strcasecmp(v->name, "endcall")) {
1040                         endcall = ast_true(v->value);
1041                 } else if (!strcasecmp(v->name, "wrapuptime")) {
1042                         wrapuptime = atoi(v->value);
1043                         if (wrapuptime < 0)
1044                                 wrapuptime = 0;
1045                 } else if (!strcasecmp(v->name, "maxlogintries") && !ast_strlen_zero(v->value)) {
1046                         maxlogintries = atoi(v->value);
1047                         if (maxlogintries < 0)
1048                                 maxlogintries = 0;
1049                 } else if (!strcasecmp(v->name, "goodbye") && !ast_strlen_zero(v->value)) {
1050                         strcpy(agentgoodbye,v->value);
1051                 } else if (!strcasecmp(v->name, "musiconhold")) {
1052                         ast_copy_string(moh, v->value, sizeof(moh));
1053                 } else if (!strcasecmp(v->name, "updatecdr")) {
1054                         if (ast_true(v->value))
1055                                 updatecdr = 1;
1056                         else
1057                                 updatecdr = 0;
1058                 } else if (!strcasecmp(v->name, "autologoffunavail")) {
1059                         if (ast_true(v->value))
1060                                 autologoffunavail = 1;
1061                         else
1062                                 autologoffunavail = 0;
1063                 } else if (!strcasecmp(v->name, "recordagentcalls")) {
1064                         recordagentcalls = ast_true(v->value);
1065                 } else if (!strcasecmp(v->name, "recordformat")) {
1066                         ast_copy_string(recordformat, v->value, sizeof(recordformat));
1067                         if (!strcasecmp(v->value, "wav49"))
1068                                 strcpy(recordformatext, "WAV");
1069                         else
1070                                 ast_copy_string(recordformatext, v->value, sizeof(recordformatext));
1071                 } else if (!strcasecmp(v->name, "urlprefix")) {
1072                         ast_copy_string(urlprefix, v->value, sizeof(urlprefix));
1073                         if (urlprefix[strlen(urlprefix) - 1] != '/')
1074                                 strncat(urlprefix, "/", sizeof(urlprefix) - strlen(urlprefix) - 1);
1075                 } else if (!strcasecmp(v->name, "savecallsin")) {
1076                         if (v->value[0] == '/')
1077                                 ast_copy_string(savecallsin, v->value, sizeof(savecallsin));
1078                         else
1079                                 snprintf(savecallsin, sizeof(savecallsin) - 2, "/%s", v->value);
1080                         if (savecallsin[strlen(savecallsin) - 1] != '/')
1081                                 strncat(savecallsin, "/", sizeof(savecallsin) - strlen(savecallsin) - 1);
1082                 } else if (!strcasecmp(v->name, "custom_beep")) {
1083                         ast_copy_string(beep, v->value, sizeof(beep));
1084                 }
1085                 v = v->next;
1086         }
1087         if ((ucfg = ast_config_load("users.conf"))) {
1088                 genhasagent = ast_true(ast_variable_retrieve(ucfg, "general", "hasagent"));
1089                 catname = ast_category_browse(ucfg, NULL);
1090                 while(catname) {
1091                         if (strcasecmp(catname, "general")) {
1092                                 hasagent = ast_variable_retrieve(ucfg, catname, "hasagent");
1093                                 if (ast_true(hasagent) || (!hasagent && genhasagent)) {
1094                                         char tmp[256];
1095                                         const char *fullname = ast_variable_retrieve(ucfg, catname, "fullname");
1096                                         const char *secret = ast_variable_retrieve(ucfg, catname, "secret");
1097                                         if (!fullname)
1098                                                 fullname = "";
1099                                         if (!secret)
1100                                                 secret = "";
1101                                         snprintf(tmp, sizeof(tmp), "%s,%s,%s", catname, secret,fullname);
1102                                         add_agent(tmp, 0);
1103                                 }
1104                         }
1105                         catname = ast_category_browse(ucfg, catname);
1106                 }
1107                 ast_config_destroy(ucfg);
1108         }
1109         AST_LIST_TRAVERSE_SAFE_BEGIN(&agents, p, list) {
1110                 if (p->dead) {
1111                         AST_LIST_REMOVE_CURRENT(&agents, list);
1112                         /* Destroy if  appropriate */
1113                         if (!p->owner) {
1114                                 if (!p->chan) {
1115                                         ast_mutex_destroy(&p->lock);
1116                                         ast_mutex_destroy(&p->app_lock);
1117                                         ast_free(p);
1118                                 } else {
1119                                         /* Cause them to hang up */
1120                                         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1121                                 }
1122                         }
1123                 }
1124         }
1125         AST_LIST_TRAVERSE_SAFE_END
1126         AST_LIST_UNLOCK(&agents);
1127         ast_config_destroy(cfg);
1128         return 1;
1129 }
1130
1131 static int check_availability(struct agent_pvt *newlyavailable, int needlock)
1132 {
1133         struct ast_channel *chan=NULL, *parent=NULL;
1134         struct agent_pvt *p;
1135         int res;
1136
1137         ast_debug(1, "Checking availability of '%s'\n", newlyavailable->agent);
1138         if (needlock)
1139                 AST_LIST_LOCK(&agents);
1140         AST_LIST_TRAVERSE(&agents, p, list) {
1141                 if (p == newlyavailable) {
1142                         continue;
1143                 }
1144                 ast_mutex_lock(&p->lock);
1145                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1146                         ast_debug(1, "Call '%s' looks like a winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1147                         /* We found a pending call, time to merge */
1148                         chan = agent_new(newlyavailable, AST_STATE_DOWN);
1149                         parent = p->owner;
1150                         p->abouttograb = 1;
1151                         ast_mutex_unlock(&p->lock);
1152                         break;
1153                 }
1154                 ast_mutex_unlock(&p->lock);
1155         }
1156         if (needlock)
1157                 AST_LIST_UNLOCK(&agents);
1158         if (parent && chan)  {
1159                 if (newlyavailable->ackcall > 1) {
1160                         /* Don't do beep here */
1161                         res = 0;
1162                 } else {
1163                         ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1164                         res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1165                         ast_debug(3, "Played beep, result '%d'\n", res);
1166                         if (!res) {
1167                                 res = ast_waitstream(newlyavailable->chan, "");
1168                                 ast_debug(1, "Waited for stream, result '%d'\n", res);
1169                         }
1170                 }
1171                 if (!res) {
1172                         /* Note -- parent may have disappeared */
1173                         if (p->abouttograb) {
1174                                 newlyavailable->acknowledged = 1;
1175                                 /* Safe -- agent lock already held */
1176                                 ast_setstate(parent, AST_STATE_UP);
1177                                 ast_setstate(chan, AST_STATE_UP);
1178                                 ast_copy_string(parent->context, chan->context, sizeof(parent->context));
1179                                 /* Go ahead and mark the channel as a zombie so that masquerade will
1180                                    destroy it for us, and we need not call ast_hangup */
1181                                 ast_mutex_lock(&parent->lock);
1182                                 ast_set_flag(chan, AST_FLAG_ZOMBIE);
1183                                 ast_channel_masquerade(parent, chan);
1184                                 ast_mutex_unlock(&parent->lock);
1185                                 p->abouttograb = 0;
1186                         } else {
1187                                 ast_debug(1, "Sneaky, parent disappeared in the mean time...\n");
1188                                 agent_cleanup(newlyavailable);
1189                         }
1190                 } else {
1191                         ast_debug(1, "Ugh...  Agent hung up at exactly the wrong time\n");
1192                         agent_cleanup(newlyavailable);
1193                 }
1194         }
1195         return 0;
1196 }
1197
1198 static int check_beep(struct agent_pvt *newlyavailable, int needlock)
1199 {
1200         struct agent_pvt *p;
1201         int res=0;
1202
1203         ast_debug(1, "Checking beep availability of '%s'\n", newlyavailable->agent);
1204         if (needlock)
1205                 AST_LIST_LOCK(&agents);
1206         AST_LIST_TRAVERSE(&agents, p, list) {
1207                 if (p == newlyavailable) {
1208                         continue;
1209                 }
1210                 ast_mutex_lock(&p->lock);
1211                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1212                         ast_debug(1, "Call '%s' looks like a would-be winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1213                         ast_mutex_unlock(&p->lock);
1214                         break;
1215                 }
1216                 ast_mutex_unlock(&p->lock);
1217         }
1218         if (needlock)
1219                 AST_LIST_UNLOCK(&agents);
1220         if (p) {
1221                 ast_mutex_unlock(&newlyavailable->lock);
1222                 ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1223                 res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1224                 ast_debug(1, "Played beep, result '%d'\n", res);
1225                 if (!res) {
1226                         res = ast_waitstream(newlyavailable->chan, "");
1227                         ast_debug(1, "Waited for stream, result '%d'\n", res);
1228                 }
1229                 ast_mutex_lock(&newlyavailable->lock);
1230         }
1231         return res;
1232 }
1233
1234 /*! \brief Part of the Asterisk PBX interface */
1235 static struct ast_channel *agent_request(const char *type, int format, void *data, int *cause)
1236 {
1237         struct agent_pvt *p;
1238         struct ast_channel *chan = NULL;
1239         char *s;
1240         ast_group_t groupmatch;
1241         int groupoff;
1242         int waitforagent=0;
1243         int hasagent = 0;
1244         struct timeval tv;
1245
1246         s = data;
1247         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1248                 groupmatch = (1 << groupoff);
1249         } else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1250                 groupmatch = (1 << groupoff);
1251                 waitforagent = 1;
1252         } else 
1253                 groupmatch = 0;
1254
1255         /* Check actual logged in agents first */
1256         AST_LIST_LOCK(&agents);
1257         AST_LIST_TRAVERSE(&agents, p, list) {
1258                 ast_mutex_lock(&p->lock);
1259                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent)) &&
1260                     ast_strlen_zero(p->loginchan)) {
1261                         if (p->chan)
1262                                 hasagent++;
1263                         if (!p->lastdisc.tv_sec) {
1264                                 /* Agent must be registered, but not have any active call, and not be in a waiting state */
1265                                 if (!p->owner && p->chan) {
1266                                         /* Fixed agent */
1267                                         chan = agent_new(p, AST_STATE_DOWN);
1268                                 }
1269                                 if (chan) {
1270                                         ast_mutex_unlock(&p->lock);
1271                                         break;
1272                                 }
1273                         }
1274                 }
1275                 ast_mutex_unlock(&p->lock);
1276         }
1277         if (!p) {
1278                 AST_LIST_TRAVERSE(&agents, p, list) {
1279                         ast_mutex_lock(&p->lock);
1280                         if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
1281                                 if (p->chan || !ast_strlen_zero(p->loginchan))
1282                                         hasagent++;
1283                                 tv = ast_tvnow();
1284 #if 0
1285                                 ast_log(LOG_NOTICE, "Time now: %ld, Time of lastdisc: %ld\n", tv.tv_sec, p->lastdisc.tv_sec);
1286 #endif
1287                                 if (!p->lastdisc.tv_sec || (tv.tv_sec > p->lastdisc.tv_sec)) {
1288                                         p->lastdisc = ast_tv(0, 0);
1289                                         /* Agent must be registered, but not have any active call, and not be in a waiting state */
1290                                         if (!p->owner && p->chan) {
1291                                                 /* Could still get a fixed agent */
1292                                                 chan = agent_new(p, AST_STATE_DOWN);
1293                                         } else if (!p->owner && !ast_strlen_zero(p->loginchan)) {
1294                                                 /* Adjustable agent */
1295                                                 p->chan = ast_request("Local", format, p->loginchan, cause);
1296                                                 if (p->chan)
1297                                                         chan = agent_new(p, AST_STATE_DOWN);
1298                                         }
1299                                         if (chan) {
1300                                                 ast_mutex_unlock(&p->lock);
1301                                                 break;
1302                                         }
1303                                 }
1304                         }
1305                         ast_mutex_unlock(&p->lock);
1306                 }
1307         }
1308
1309         if (!chan && waitforagent) {
1310                 /* No agent available -- but we're requesting to wait for one.
1311                    Allocate a place holder */
1312                 if (hasagent) {
1313                         ast_debug(1, "Creating place holder for '%s'\n", s);
1314                         p = add_agent(data, 1);
1315                         p->group = groupmatch;
1316                         chan = agent_new(p, AST_STATE_DOWN);
1317                         if (!chan) 
1318                                 ast_log(LOG_WARNING, "Weird...  Fix this to drop the unused pending agent\n");
1319                 } else {
1320                         ast_debug(1, "Not creating place holder for '%s' since nobody logged in\n", s);
1321                 }
1322         }
1323         *cause = hasagent ? AST_CAUSE_BUSY : AST_CAUSE_UNREGISTERED;
1324         AST_LIST_UNLOCK(&agents);
1325         return chan;
1326 }
1327
1328 static force_inline int powerof(unsigned int d)
1329 {
1330         int x = ffs(d);
1331
1332         if (x)
1333                 return x - 1;
1334
1335         return 0;
1336 }
1337
1338 /*!
1339  * Lists agents and their status to the Manager API.
1340  * It is registered on load_module() and it gets called by the manager backend.
1341  * \param s
1342  * \param m
1343  * \returns 
1344  * \sa action_agent_logoff(), load_module().
1345  */
1346 static int action_agents(struct mansession *s, const struct message *m)
1347 {
1348         const char *id = astman_get_header(m,"ActionID");
1349         char idText[256] = "";
1350         char chanbuf[256];
1351         struct agent_pvt *p;
1352         char *username = NULL;
1353         char *loginChan = NULL;
1354         char *talkingtoChan = NULL;
1355         char *status = NULL;
1356
1357         if (!ast_strlen_zero(id))
1358                 snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
1359         astman_send_ack(s, m, "Agents will follow");
1360         AST_LIST_LOCK(&agents);
1361         AST_LIST_TRAVERSE(&agents, p, list) {
1362                 ast_mutex_lock(&p->lock);
1363
1364                 /* Status Values:
1365                    AGENT_LOGGEDOFF - Agent isn't logged in
1366                    AGENT_IDLE      - Agent is logged in, and waiting for call
1367                    AGENT_ONCALL    - Agent is logged in, and on a call
1368                    AGENT_UNKNOWN   - Don't know anything about agent. Shouldn't ever get this. */
1369
1370                 username = S_OR(p->name, "None");
1371
1372                 /* Set a default status. It 'should' get changed. */
1373                 status = "AGENT_UNKNOWN";
1374
1375                 if (!ast_strlen_zero(p->loginchan) && !p->chan) {
1376                         loginChan = p->loginchan;
1377                         talkingtoChan = "n/a";
1378                         status = "AGENT_IDLE";
1379                         if (p->acknowledged) {
1380                                 snprintf(chanbuf, sizeof(chanbuf), " %s (Confirmed)", p->loginchan);
1381                                 loginChan = chanbuf;
1382                         }
1383                 } else if (p->chan) {
1384                         loginChan = ast_strdupa(p->chan->name);
1385                         if (p->owner && p->owner->_bridge) {
1386                                 talkingtoChan = p->chan->cid.cid_num;
1387                                 status = "AGENT_ONCALL";
1388                         } else {
1389                                 talkingtoChan = "n/a";
1390                                 status = "AGENT_IDLE";
1391                         }
1392                 } else {
1393                         loginChan = "n/a";
1394                         talkingtoChan = "n/a";
1395                         status = "AGENT_LOGGEDOFF";
1396                 }
1397
1398                 astman_append(s, "Event: Agents\r\n"
1399                         "Agent: %s\r\n"
1400                         "Name: %s\r\n"
1401                         "Status: %s\r\n"
1402                         "LoggedInChan: %s\r\n"
1403                         "LoggedInTime: %d\r\n"
1404                         "TalkingTo: %s\r\n"
1405                         "%s"
1406                         "\r\n",
1407                         p->agent, username, status, loginChan, (int)p->loginstart, talkingtoChan, idText);
1408                 ast_mutex_unlock(&p->lock);
1409         }
1410         AST_LIST_UNLOCK(&agents);
1411         astman_append(s, "Event: AgentsComplete\r\n"
1412                 "%s"
1413                 "\r\n",idText);
1414         return 0;
1415 }
1416
1417 static void agent_logoff_maintenance(struct agent_pvt *p, char *loginchan, long logintime, const char *uniqueid, char *logcommand)
1418 {
1419         char *tmp = NULL;
1420         char agent[AST_MAX_AGENT];
1421
1422         if (!ast_strlen_zero(logcommand))
1423                 tmp = logcommand;
1424         else
1425                 tmp = ast_strdupa("");
1426
1427         snprintf(agent, sizeof(agent), "Agent/%s", p->agent);
1428
1429         if (!ast_strlen_zero(uniqueid)) {
1430                 manager_event(EVENT_FLAG_AGENT, "Agentcallbacklogoff",
1431                                 "Agent: %s\r\n"
1432                                 "Reason: %s\r\n"
1433                                 "Loginchan: %s\r\n"
1434                                 "Logintime: %ld\r\n"
1435                                 "Uniqueid: %s\r\n", 
1436                                 p->agent, tmp, loginchan, logintime, uniqueid);
1437         } else {
1438                 manager_event(EVENT_FLAG_AGENT, "Agentcallbacklogoff",
1439                                 "Agent: %s\r\n"
1440                                 "Reason: %s\r\n"
1441                                 "Loginchan: %s\r\n"
1442                                 "Logintime: %ld\r\n",
1443                                 p->agent, tmp, loginchan, logintime);
1444         }
1445
1446         ast_queue_log("NONE", ast_strlen_zero(uniqueid) ? "NONE" : uniqueid, agent, "AGENTCALLBACKLOGOFF", "%s|%ld|%s", loginchan, logintime, tmp);
1447         set_agentbycallerid(p->logincallerid, NULL);
1448         p->loginchan[0] ='\0';
1449         p->logincallerid[0] = '\0';
1450         ast_device_state_changed("Agent/%s", p->agent);
1451         if (persistent_agents)
1452                 dump_agents();  
1453
1454 }
1455
1456 static int agent_logoff(const char *agent, int soft)
1457 {
1458         struct agent_pvt *p;
1459         long logintime;
1460         int ret = -1; /* Return -1 if no agent if found */
1461
1462         AST_LIST_TRAVERSE(&agents, p, list) {
1463                 if (!strcasecmp(p->agent, agent)) {
1464                         ret = 0;
1465                         if (p->owner || p->chan) {
1466                                 p->deferlogoff = 1;
1467                                 if (!soft) {
1468                                         if (p->owner)
1469                                                 ast_softhangup(p->owner, AST_SOFTHANGUP_EXPLICIT);
1470                                         if (p->chan)
1471                                                 ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1472                                 }
1473                         } else {
1474                                 logintime = time(NULL) - p->loginstart;
1475                                 p->loginstart = 0;
1476                                 agent_logoff_maintenance(p, p->loginchan, logintime, NULL, "CommandLogoff");
1477                         }
1478                         break;
1479                 }
1480         }
1481
1482         return ret;
1483 }
1484
1485 static int agent_logoff_cmd(int fd, int argc, char **argv)
1486 {
1487         int ret;
1488         char *agent;
1489
1490         if (argc < 3 || argc > 4)
1491                 return RESULT_SHOWUSAGE;
1492         if (argc == 4 && strcasecmp(argv[3], "soft"))
1493                 return RESULT_SHOWUSAGE;
1494
1495         agent = argv[2] + 6;
1496         ret = agent_logoff(agent, argc == 4);
1497         if (ret == 0)
1498                 ast_cli(fd, "Logging out %s\n", agent);
1499
1500         return RESULT_SUCCESS;
1501 }
1502
1503 /*!
1504  * Sets an agent as no longer logged in in the Manager API.
1505  * It is registered on load_module() and it gets called by the manager backend.
1506  * \param s
1507  * \param m
1508  * \returns 
1509  * \sa action_agents(), load_module().
1510  */
1511 static int action_agent_logoff(struct mansession *s, const struct message *m)
1512 {
1513         const char *agent = astman_get_header(m, "Agent");
1514         const char *soft_s = astman_get_header(m, "Soft"); /* "true" is don't hangup */
1515         int soft;
1516         int ret; /* return value of agent_logoff */
1517
1518         if (ast_strlen_zero(agent)) {
1519                 astman_send_error(s, m, "No agent specified");
1520                 return 0;
1521         }
1522
1523         soft = ast_true(soft_s) ? 1 : 0;
1524         ret = agent_logoff(agent, soft);
1525         if (ret == 0)
1526                 astman_send_ack(s, m, "Agent logged out");
1527         else
1528                 astman_send_error(s, m, "No such agent");
1529
1530         return 0;
1531 }
1532
1533 static char *complete_agent_logoff_cmd(const char *line, const char *word, int pos, int state)
1534 {
1535         if (pos == 2) {
1536                 struct agent_pvt *p;
1537                 char name[AST_MAX_AGENT];
1538                 int which = 0, len = strlen(word);
1539
1540                 AST_LIST_TRAVERSE(&agents, p, list) {
1541                         snprintf(name, sizeof(name), "Agent/%s", p->agent);
1542                         if (!strncasecmp(word, name, len) && p->loginstart && ++which > state)
1543                                 return ast_strdup(name);
1544                 }
1545         } else if (pos == 3 && state == 0) 
1546                 return ast_strdup("soft");
1547         
1548         return NULL;
1549 }
1550
1551 /*!
1552  * Show agents in cli.
1553  */
1554 static int agents_show(int fd, int argc, char **argv)
1555 {
1556         struct agent_pvt *p;
1557         char username[AST_MAX_BUF];
1558         char location[AST_MAX_BUF] = "";
1559         char talkingto[AST_MAX_BUF] = "";
1560         char moh[AST_MAX_BUF];
1561         int count_agents = 0;           /*!< Number of agents configured */
1562         int online_agents = 0;          /*!< Number of online agents */
1563         int offline_agents = 0;         /*!< Number of offline agents */
1564         if (argc != 2)
1565                 return RESULT_SHOWUSAGE;
1566         AST_LIST_LOCK(&agents);
1567         AST_LIST_TRAVERSE(&agents, p, list) {
1568                 ast_mutex_lock(&p->lock);
1569                 if (p->pending) {
1570                         if (p->group)
1571                                 ast_cli(fd, "-- Pending call to group %d\n", powerof(p->group));
1572                         else
1573                                 ast_cli(fd, "-- Pending call to agent %s\n", p->agent);
1574                 } else {
1575                         if (!ast_strlen_zero(p->name))
1576                                 snprintf(username, sizeof(username), "(%s) ", p->name);
1577                         else
1578                                 username[0] = '\0';
1579                         if (p->chan) {
1580                                 snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
1581                                 if (p->owner && ast_bridged_channel(p->owner))
1582                                         snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(p->owner)->name);
1583                                  else 
1584                                         strcpy(talkingto, " is idle");
1585                                 online_agents++;
1586                         } else if (!ast_strlen_zero(p->loginchan)) {
1587                                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0 || !(p->lastdisc.tv_sec)) 
1588                                         snprintf(location, sizeof(location) - 20, "available at '%s'", p->loginchan);
1589                                 else 
1590                                         snprintf(location, sizeof(location) - 20, "wrapping up at '%s'", p->loginchan);
1591                                 talkingto[0] = '\0';
1592                                 online_agents++;
1593                                 if (p->acknowledged)
1594                                         strncat(location, " (Confirmed)", sizeof(location) - strlen(location) - 1);
1595                         } else {
1596                                 strcpy(location, "not logged in");
1597                                 talkingto[0] = '\0';
1598                                 offline_agents++;
1599                         }
1600                         if (!ast_strlen_zero(p->moh))
1601                                 snprintf(moh, sizeof(moh), " (musiconhold is '%s')", p->moh);
1602                         ast_cli(fd, "%-12.12s %s%s%s%s\n", p->agent, 
1603                                 username, location, talkingto, moh);
1604                         count_agents++;
1605                 }
1606                 ast_mutex_unlock(&p->lock);
1607         }
1608         AST_LIST_UNLOCK(&agents);
1609         if ( !count_agents ) 
1610                 ast_cli(fd, "No Agents are configured in %s\n",config);
1611         else 
1612                 ast_cli(fd, "%d agents configured [%d online , %d offline]\n",count_agents, online_agents, offline_agents);
1613         ast_cli(fd, "\n");
1614                         
1615         return RESULT_SUCCESS;
1616 }
1617
1618
1619 static int agents_show_online(int fd, int argc, char **argv)
1620 {
1621         struct agent_pvt *p;
1622         char username[AST_MAX_BUF];
1623         char location[AST_MAX_BUF] = "";
1624         char talkingto[AST_MAX_BUF] = "";
1625         char moh[AST_MAX_BUF];
1626         int count_agents = 0;           /* Number of agents configured */
1627         int online_agents = 0;          /* Number of online agents */
1628         int agent_status = 0;           /* 0 means offline, 1 means online */
1629         if (argc != 3)
1630                 return RESULT_SHOWUSAGE;
1631         AST_LIST_LOCK(&agents);
1632         AST_LIST_TRAVERSE(&agents, p, list) {
1633                 agent_status = 0;       /* reset it to offline */
1634                 ast_mutex_lock(&p->lock);
1635                 if (!ast_strlen_zero(p->name))
1636                         snprintf(username, sizeof(username), "(%s) ", p->name);
1637                 else
1638                         username[0] = '\0';
1639                 if (p->chan) {
1640                         snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
1641                         if (p->owner && ast_bridged_channel(p->owner)) 
1642                                 snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(p->owner)->name);
1643                         else 
1644                                 strcpy(talkingto, " is idle");
1645                         agent_status = 1;
1646                         online_agents++;
1647                 } else if (!ast_strlen_zero(p->loginchan)) {
1648                         snprintf(location, sizeof(location) - 20, "available at '%s'", p->loginchan);
1649                         talkingto[0] = '\0';
1650                         agent_status = 1;
1651                         online_agents++;
1652                         if (p->acknowledged)
1653                                 strncat(location, " (Confirmed)", sizeof(location) - strlen(location) - 1);
1654                 }
1655                 if (!ast_strlen_zero(p->moh))
1656                         snprintf(moh, sizeof(moh), " (musiconhold is '%s')", p->moh);
1657                 if (agent_status)
1658                         ast_cli(fd, "%-12.12s %s%s%s%s\n", p->agent, username, location, talkingto, moh);
1659                 count_agents++;
1660                 ast_mutex_unlock(&p->lock);
1661         }
1662         AST_LIST_UNLOCK(&agents);
1663         if (!count_agents) 
1664                 ast_cli(fd, "No Agents are configured in %s\n", config);
1665         else
1666                 ast_cli(fd, "%d agents online\n", online_agents);
1667         ast_cli(fd, "\n");
1668         return RESULT_SUCCESS;
1669 }
1670
1671
1672
1673 static const char show_agents_usage[] = 
1674 "Usage: agent show\n"
1675 "       Provides summary information on agents.\n";
1676
1677 static const char show_agents_online_usage[] =
1678 "Usage: agent show online\n"
1679 "       Provides a list of all online agents.\n";
1680
1681 static const char agent_logoff_usage[] =
1682 "Usage: agent logoff <channel> [soft]\n"
1683 "       Sets an agent as no longer logged in.\n"
1684 "       If 'soft' is specified, do not hangup existing calls.\n";
1685
1686 static struct ast_cli_entry cli_agents[] = {
1687         { { "agent", "show", NULL },
1688         agents_show, "Show status of agents",
1689         show_agents_usage },
1690
1691         { { "agent", "show", "online" },
1692         agents_show_online, "Show all online agents",
1693         show_agents_online_usage },
1694
1695         { { "agent", "logoff", NULL },
1696         agent_logoff_cmd, "Sets an agent offline",
1697         agent_logoff_usage, complete_agent_logoff_cmd },
1698 };
1699
1700 /*!
1701  * Called by the AgentLogin application (from the dial plan).
1702  * 
1703  * \brief Log in agent application.
1704  *
1705  * \param chan
1706  * \param data
1707  * \returns
1708  * \sa agentmonitoroutgoing_exec(), load_module().
1709  */
1710 static int login_exec(struct ast_channel *chan, void *data)
1711 {
1712         int res=0;
1713         int tries = 0;
1714         int max_login_tries = maxlogintries;
1715         struct agent_pvt *p;
1716         struct ast_module_user *u;
1717         int login_state = 0;
1718         char user[AST_MAX_AGENT] = "";
1719         char pass[AST_MAX_AGENT];
1720         char agent[AST_MAX_AGENT] = "";
1721         char xpass[AST_MAX_AGENT] = "";
1722         char *errmsg;
1723         char *parse;
1724         AST_DECLARE_APP_ARGS(args,
1725                              AST_APP_ARG(agent_id);
1726                              AST_APP_ARG(options);
1727                              AST_APP_ARG(extension);
1728                 );
1729         const char *tmpoptions = NULL;
1730         int play_announcement = 1;
1731         char agent_goodbye[AST_MAX_FILENAME_LEN];
1732         int update_cdr = updatecdr;
1733         char *filename = "agent-loginok";
1734
1735         u = ast_module_user_add(chan);
1736
1737         parse = ast_strdupa(data);
1738
1739         AST_STANDARD_APP_ARGS(args, parse);
1740
1741         ast_copy_string(agent_goodbye, agentgoodbye, sizeof(agent_goodbye));
1742
1743         /* Set Channel Specific Login Overrides */
1744         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTLMAXLOGINTRIES"))) {
1745                 max_login_tries = atoi(pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES"));
1746                 if (max_login_tries < 0)
1747                         max_login_tries = 0;
1748                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES");
1749                 if (option_verbose > 2)
1750                         ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTMAXLOGINTRIES=%s, setting max_login_tries to: %d on Channel '%s'.\n",tmpoptions,max_login_tries,chan->name);
1751         }
1752         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR"))) {
1753                 if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR")))
1754                         update_cdr = 1;
1755                 else
1756                         update_cdr = 0;
1757                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR");
1758                 if (option_verbose > 2)
1759                         ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTUPDATECDR=%s, setting update_cdr to: %d on Channel '%s'.\n",tmpoptions,update_cdr,chan->name);
1760         }
1761         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"))) {
1762                 strcpy(agent_goodbye, pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"));
1763                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTGOODBYE");
1764                 if (option_verbose > 2)
1765                         ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTGOODBYE=%s, setting agent_goodbye to: %s on Channel '%s'.\n",tmpoptions,agent_goodbye,chan->name);
1766         }
1767         /* End Channel Specific Login Overrides */
1768         
1769         if (!ast_strlen_zero(args.options)) {
1770                 if (strchr(args.options, 's')) {
1771                         play_announcement = 0;
1772                 }
1773         }
1774
1775         if (chan->_state != AST_STATE_UP)
1776                 res = ast_answer(chan);
1777         if (!res) {
1778                 if (!ast_strlen_zero(args.agent_id))
1779                         ast_copy_string(user, args.agent_id, AST_MAX_AGENT);
1780                 else
1781                         res = ast_app_getdata(chan, "agent-user", user, sizeof(user) - 1, 0);
1782         }
1783         while (!res && (max_login_tries==0 || tries < max_login_tries)) {
1784                 tries++;
1785                 /* Check for password */
1786                 AST_LIST_LOCK(&agents);
1787                 AST_LIST_TRAVERSE(&agents, p, list) {
1788                         if (!strcmp(p->agent, user) && !p->pending)
1789                                 ast_copy_string(xpass, p->password, sizeof(xpass));
1790                 }
1791                 AST_LIST_UNLOCK(&agents);
1792                 if (!res) {
1793                         if (!ast_strlen_zero(xpass))
1794                                 res = ast_app_getdata(chan, "agent-pass", pass, sizeof(pass) - 1, 0);
1795                         else
1796                                 pass[0] = '\0';
1797                 }
1798                 errmsg = "agent-incorrect";
1799
1800 #if 0
1801                 ast_log(LOG_NOTICE, "user: %s, pass: %s\n", user, pass);
1802 #endif          
1803
1804                 /* Check again for accuracy */
1805                 AST_LIST_LOCK(&agents);
1806                 AST_LIST_TRAVERSE(&agents, p, list) {
1807                         ast_mutex_lock(&p->lock);
1808                         if (!strcmp(p->agent, user) &&
1809                             !strcmp(p->password, pass) && !p->pending) {
1810                                 login_state = 1; /* Successful Login */
1811
1812                                 /* Ensure we can't be gotten until we're done */
1813                                 gettimeofday(&p->lastdisc, NULL);
1814                                 p->lastdisc.tv_sec++;
1815
1816                                 /* Set Channel Specific Agent Overrides */
1817                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"))) {
1818                                         if (!strcasecmp(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"), "always"))
1819                                                 p->ackcall = 2;
1820                                         else if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTACKCALL")))
1821                                                 p->ackcall = 1;
1822                                         else
1823                                                 p->ackcall = 0;
1824                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTACKCALL");
1825                                         if (option_verbose > 2)
1826                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTACKCALL=%s, setting ackcall to: %d for Agent '%s'.\n",tmpoptions,p->ackcall,p->agent);
1827                                 }
1828                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"))) {
1829                                         p->autologoff = atoi(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"));
1830                                         if (p->autologoff < 0)
1831                                                 p->autologoff = 0;
1832                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF");
1833                                         if (option_verbose > 2)
1834                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTAUTOLOGOFF=%s, setting autologff to: %d for Agent '%s'.\n",tmpoptions,p->autologoff,p->agent);
1835                                 }
1836                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"))) {
1837                                         p->wrapuptime = atoi(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"));
1838                                         if (p->wrapuptime < 0)
1839                                                 p->wrapuptime = 0;
1840                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME");
1841                                         if (option_verbose > 2)
1842                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTWRAPUPTIME=%s, setting wrapuptime to: %d for Agent '%s'.\n",tmpoptions,p->wrapuptime,p->agent);
1843                                 }
1844                                 /* End Channel Specific Agent Overrides */
1845                                 if (!p->chan) {
1846                                         long logintime;
1847                                         snprintf(agent, sizeof(agent), "Agent/%s", p->agent);
1848
1849                                         p->loginchan[0] = '\0';
1850                                         p->logincallerid[0] = '\0';
1851                                         p->acknowledged = 0;
1852                                         
1853                                         ast_mutex_unlock(&p->lock);
1854                                         AST_LIST_UNLOCK(&agents);
1855                                         if( !res && play_announcement==1 )
1856                                                 res = ast_streamfile(chan, filename, chan->language);
1857                                         if (!res)
1858                                                 ast_waitstream(chan, "");
1859                                         AST_LIST_LOCK(&agents);
1860                                         ast_mutex_lock(&p->lock);
1861                                         if (!res) {
1862                                                 res = ast_set_read_format(chan, ast_best_codec(chan->nativeformats));
1863                                                 if (res)
1864                                                         ast_log(LOG_WARNING, "Unable to set read format to %d\n", ast_best_codec(chan->nativeformats));
1865                                         }
1866                                         if (!res) {
1867                                                 res = ast_set_write_format(chan, ast_best_codec(chan->nativeformats));
1868                                                 if (res)
1869                                                         ast_log(LOG_WARNING, "Unable to set write format to %d\n", ast_best_codec(chan->nativeformats));
1870                                         }
1871                                         /* Check once more just in case */
1872                                         if (p->chan)
1873                                                 res = -1;
1874                                         if (!res) {
1875                                                 ast_indicate_data(chan, AST_CONTROL_HOLD, 
1876                                                         S_OR(p->moh, NULL), 
1877                                                         !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
1878                                                 if (p->loginstart == 0)
1879                                                         time(&p->loginstart);
1880                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogin",
1881                                                               "Agent: %s\r\n"
1882                                                               "Channel: %s\r\n"
1883                                                               "Uniqueid: %s\r\n",
1884                                                               p->agent, chan->name, chan->uniqueid);
1885                                                 if (update_cdr && chan->cdr)
1886                                                         snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
1887                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGIN", "%s", chan->name);
1888                                                 if (option_verbose > 1)
1889                                                         ast_verbose(VERBOSE_PREFIX_2 "Agent '%s' logged in (format %s/%s)\n", p->agent,
1890                                                                     ast_getformatname(chan->readformat), ast_getformatname(chan->writeformat));
1891                                                 /* Login this channel and wait for it to go away */
1892                                                 p->chan = chan;
1893                                                 if (p->ackcall > 1)
1894                                                         check_beep(p, 0);
1895                                                 else
1896                                                         check_availability(p, 0);
1897                                                 ast_mutex_unlock(&p->lock);
1898                                                 AST_LIST_UNLOCK(&agents);
1899                                                 ast_device_state_changed("Agent/%s", p->agent);
1900                                                 while (res >= 0) {
1901                                                         ast_mutex_lock(&p->lock);
1902                                                         if (p->chan != chan)
1903                                                                 res = -1;
1904                                                         ast_mutex_unlock(&p->lock);
1905                                                         /* Yield here so other interested threads can kick in. */
1906                                                         sched_yield();
1907                                                         if (res)
1908                                                                 break;
1909
1910                                                         AST_LIST_LOCK(&agents);
1911                                                         ast_mutex_lock(&p->lock);
1912                                                         if (p->lastdisc.tv_sec) {
1913                                                                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > p->wrapuptime) {
1914                                                                         ast_debug(1, "Wrapup time for %s expired!\n", p->agent);
1915                                                                         p->lastdisc = ast_tv(0, 0);
1916                                                                         if (p->ackcall > 1)
1917                                                                                 check_beep(p, 0);
1918                                                                         else
1919                                                                                 check_availability(p, 0);
1920                                                                 }
1921                                                         }
1922                                                         ast_mutex_unlock(&p->lock);
1923                                                         AST_LIST_UNLOCK(&agents);
1924                                                         /*      Synchronize channel ownership between call to agent and itself. */
1925                                                         ast_mutex_lock( &p->app_lock );
1926                                                         ast_mutex_lock(&p->lock);
1927                                                         p->owning_app = pthread_self();
1928                                                         ast_mutex_unlock(&p->lock);
1929                                                         if (p->ackcall > 1) 
1930                                                                 res = agent_ack_sleep(p);
1931                                                         else
1932                                                                 res = ast_safe_sleep_conditional( chan, 1000, agent_cont_sleep, p );
1933                                                         ast_mutex_unlock( &p->app_lock );
1934                                                         if ((p->ackcall > 1)  && (res == 1)) {
1935                                                                 AST_LIST_LOCK(&agents);
1936                                                                 ast_mutex_lock(&p->lock);
1937                                                                 check_availability(p, 0);
1938                                                                 ast_mutex_unlock(&p->lock);
1939                                                                 AST_LIST_UNLOCK(&agents);
1940                                                                 res = 0;
1941                                                         }
1942                                                         sched_yield();
1943                                                 }
1944                                                 ast_mutex_lock(&p->lock);
1945                                                 if (res && p->owner) 
1946                                                         ast_log(LOG_WARNING, "Huh?  We broke out when there was still an owner?\n");
1947                                                 /* Log us off if appropriate */
1948                                                 if (p->chan == chan)
1949                                                         p->chan = NULL;
1950                                                 p->acknowledged = 0;
1951                                                 logintime = time(NULL) - p->loginstart;
1952                                                 p->loginstart = 0;
1953                                                 ast_mutex_unlock(&p->lock);
1954                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogoff",
1955                                                               "Agent: %s\r\n"
1956                                                               "Logintime: %ld\r\n"
1957                                                               "Uniqueid: %s\r\n",
1958                                                               p->agent, logintime, chan->uniqueid);
1959                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGOFF", "%s|%ld", chan->name, logintime);
1960                                                 if (option_verbose > 1)
1961                                                         ast_verbose(VERBOSE_PREFIX_2 "Agent '%s' logged out\n", p->agent);
1962                                                 /* If there is no owner, go ahead and kill it now */
1963                                                 ast_device_state_changed("Agent/%s", p->agent);
1964                                                 if (p->dead && !p->owner) {
1965                                                         ast_mutex_destroy(&p->lock);
1966                                                         ast_mutex_destroy(&p->app_lock);
1967                                                         ast_free(p);
1968                                                 }
1969                                         }
1970                                         else {
1971                                                 ast_mutex_unlock(&p->lock);
1972                                                 p = NULL;
1973                                         }
1974                                         res = -1;
1975                                 } else {
1976                                         ast_mutex_unlock(&p->lock);
1977                                         errmsg = "agent-alreadyon";
1978                                         p = NULL;
1979                                 }
1980                                 break;
1981                         }
1982                         ast_mutex_unlock(&p->lock);
1983                 }
1984                 if (!p)
1985                         AST_LIST_UNLOCK(&agents);
1986
1987                 if (!res && (max_login_tries==0 || tries < max_login_tries))
1988                         res = ast_app_getdata(chan, errmsg, user, sizeof(user) - 1, 0);
1989         }
1990                 
1991         if (!res)
1992                 res = ast_safe_sleep(chan, 500);
1993
1994         ast_module_user_remove(u);
1995         
1996         return -1;
1997 }
1998
1999 /*!
2000  *  \brief Called by the AgentMonitorOutgoing application (from the dial plan).
2001  *
2002  * \param chan
2003  * \param data
2004  * \returns
2005  * \sa login_exec(), load_module().
2006  */
2007 static int agentmonitoroutgoing_exec(struct ast_channel *chan, void *data)
2008 {
2009         int exitifnoagentid = 0;
2010         int nowarnings = 0;
2011         int changeoutgoing = 0;
2012         int res = 0;
2013         char agent[AST_MAX_AGENT];
2014
2015         if (data) {
2016                 if (strchr(data, 'd'))
2017                         exitifnoagentid = 1;
2018                 if (strchr(data, 'n'))
2019                         nowarnings = 1;
2020                 if (strchr(data, 'c'))
2021                         changeoutgoing = 1;
2022         }
2023         if (chan->cid.cid_num) {
2024                 const char *tmp;
2025                 char agentvar[AST_MAX_BUF];
2026                 snprintf(agentvar, sizeof(agentvar), "%s_%s", GETAGENTBYCALLERID, chan->cid.cid_num);
2027                 if ((tmp = pbx_builtin_getvar_helper(NULL, agentvar))) {
2028                         struct agent_pvt *p;
2029                         ast_copy_string(agent, tmp, sizeof(agent));
2030                         AST_LIST_LOCK(&agents);
2031                         AST_LIST_TRAVERSE(&agents, p, list) {
2032                                 if (!strcasecmp(p->agent, tmp)) {
2033                                         if (changeoutgoing) snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
2034                                         __agent_start_monitoring(chan, p, 1);
2035                                         break;
2036                                 }
2037                         }
2038                         AST_LIST_UNLOCK(&agents);
2039                         
2040                 } else {
2041                         res = -1;
2042                         if (!nowarnings)
2043                                 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);
2044                 }
2045         } else {
2046                 res = -1;
2047                 if (!nowarnings)
2048                         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");
2049         }
2050         if (res) {
2051                 if (exitifnoagentid)
2052                         return res;
2053         }
2054         return 0;
2055 }
2056
2057 /*!
2058  * \brief Dump AgentCallbackLogin agents to the ASTdb database for persistence
2059  */
2060 static void dump_agents(void)
2061 {
2062         struct agent_pvt *cur_agent = NULL;
2063         char buf[256];
2064
2065         AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2066                 if (cur_agent->chan)
2067                         continue;
2068
2069                 if (!ast_strlen_zero(cur_agent->loginchan)) {
2070                         snprintf(buf, sizeof(buf), "%s;%s", cur_agent->loginchan, cur_agent->logincallerid);
2071                         if (ast_db_put(pa_family, cur_agent->agent, buf))
2072                                 ast_log(LOG_WARNING, "failed to create persistent entry in ASTdb for %s!\n", buf);
2073                         else
2074                                 ast_debug(1, "Saved Agent: %s on %s\n", cur_agent->agent, cur_agent->loginchan);
2075                 } else {
2076                         /* Delete -  no agent or there is an error */
2077                         ast_db_del(pa_family, cur_agent->agent);
2078                 }
2079         }
2080 }
2081
2082 /*!
2083  * \brief Reload the persistent agents from astdb.
2084  */
2085 static void reload_agents(void)
2086 {
2087         char *agent_num;
2088         struct ast_db_entry *db_tree;
2089         struct ast_db_entry *entry;
2090         struct agent_pvt *cur_agent;
2091         char agent_data[256];
2092         char *parse;
2093         char *agent_chan;
2094         char *agent_callerid;
2095
2096         db_tree = ast_db_gettree(pa_family, NULL);
2097
2098         AST_LIST_LOCK(&agents);
2099         for (entry = db_tree; entry; entry = entry->next) {
2100                 agent_num = entry->key + strlen(pa_family) + 2;
2101                 AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2102                         ast_mutex_lock(&cur_agent->lock);
2103                         if (strcmp(agent_num, cur_agent->agent) == 0)
2104                                 break;
2105                         ast_mutex_unlock(&cur_agent->lock);
2106                 }
2107                 if (!cur_agent) {
2108                         ast_db_del(pa_family, agent_num);
2109                         continue;
2110                 } else
2111                         ast_mutex_unlock(&cur_agent->lock);
2112                 if (!ast_db_get(pa_family, agent_num, agent_data, sizeof(agent_data)-1)) {
2113                         ast_debug(1, "Reload Agent from AstDB: %s on %s\n", cur_agent->agent, agent_data);
2114                         parse = agent_data;
2115                         agent_chan = strsep(&parse, ";");
2116                         agent_callerid = strsep(&parse, ";");
2117                         ast_copy_string(cur_agent->loginchan, agent_chan, sizeof(cur_agent->loginchan));
2118                         if (agent_callerid) {
2119                                 ast_copy_string(cur_agent->logincallerid, agent_callerid, sizeof(cur_agent->logincallerid));
2120                                 set_agentbycallerid(cur_agent->logincallerid, cur_agent->agent);
2121                         } else
2122                                 cur_agent->logincallerid[0] = '\0';
2123                         if (cur_agent->loginstart == 0)
2124                                 time(&cur_agent->loginstart);
2125                         ast_device_state_changed("Agent/%s", cur_agent->agent); 
2126                 }
2127         }
2128         AST_LIST_UNLOCK(&agents);
2129         if (db_tree) {
2130                 ast_log(LOG_NOTICE, "Agents successfully reloaded from database.\n");
2131                 ast_db_freetree(db_tree);
2132         }
2133 }
2134
2135 /*! \brief Part of PBX channel interface */
2136 static int agent_devicestate(void *data)
2137 {
2138         struct agent_pvt *p;
2139         char *s;
2140         ast_group_t groupmatch;
2141         int groupoff;
2142         int waitforagent=0;
2143         int res = AST_DEVICE_INVALID;
2144         
2145         s = data;
2146         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1))
2147                 groupmatch = (1 << groupoff);
2148         else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
2149                 groupmatch = (1 << groupoff);
2150                 waitforagent = 1;
2151         } else 
2152                 groupmatch = 0;
2153
2154         /* Check actual logged in agents first */
2155         AST_LIST_LOCK(&agents);
2156         AST_LIST_TRAVERSE(&agents, p, list) {
2157                 ast_mutex_lock(&p->lock);
2158                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
2159                         if (p->owner) {
2160                                 if (res != AST_DEVICE_INUSE)
2161                                         res = AST_DEVICE_BUSY;
2162                         } else {
2163                                 if (res == AST_DEVICE_BUSY)
2164                                         res = AST_DEVICE_INUSE;
2165                                 if (p->chan || !ast_strlen_zero(p->loginchan)) {
2166                                         if (res == AST_DEVICE_INVALID)
2167                                                 res = AST_DEVICE_UNKNOWN;
2168                                 } else if (res == AST_DEVICE_INVALID)   
2169                                         res = AST_DEVICE_UNAVAILABLE;
2170                         }
2171                         if (!strcmp(data, p->agent)) {
2172                                 ast_mutex_unlock(&p->lock);
2173                                 break;
2174                         }
2175                 }
2176                 ast_mutex_unlock(&p->lock);
2177         }
2178         AST_LIST_UNLOCK(&agents);
2179         return res;
2180 }
2181
2182 static struct agent_pvt *find_agent(char *agentid)
2183 {
2184         struct agent_pvt *cur;
2185
2186         AST_LIST_TRAVERSE(&agents, cur, list) {
2187                 if (!strcmp(cur->agent, agentid))
2188                         break;  
2189         }
2190
2191         return cur;     
2192 }
2193
2194 static int function_agent(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
2195 {
2196         char *parse;    
2197         AST_DECLARE_APP_ARGS(args,
2198                 AST_APP_ARG(agentid);
2199                 AST_APP_ARG(item);
2200         );
2201         char *tmp;
2202         struct agent_pvt *agent;
2203
2204         buf[0] = '\0';
2205
2206         if (ast_strlen_zero(data)) {
2207                 ast_log(LOG_WARNING, "The AGENT function requires an argument - agentid!\n");
2208                 return -1;
2209         }
2210
2211         parse = ast_strdupa(data);
2212
2213         AST_NONSTANDARD_APP_ARGS(args, parse, ':');
2214         if (!args.item)
2215                 args.item = "status";
2216
2217         if (!(agent = find_agent(args.agentid))) {
2218                 ast_log(LOG_WARNING, "Agent '%s' not found!\n", args.agentid);
2219                 return -1;
2220         }
2221
2222         if (!strcasecmp(args.item, "status")) {
2223                 char *status = "LOGGEDOUT";
2224                 if (agent->chan || !ast_strlen_zero(agent->loginchan)) 
2225                         status = "LOGGEDIN";    
2226                 ast_copy_string(buf, status, len);
2227         } else if (!strcasecmp(args.item, "password")) 
2228                 ast_copy_string(buf, agent->password, len);
2229         else if (!strcasecmp(args.item, "name"))
2230                 ast_copy_string(buf, agent->name, len);
2231         else if (!strcasecmp(args.item, "mohclass"))
2232                 ast_copy_string(buf, agent->moh, len);
2233         else if (!strcasecmp(args.item, "channel")) {
2234                 if (agent->chan) {
2235                         ast_copy_string(buf, agent->chan->name, len);
2236                         tmp = strrchr(buf, '-');
2237                         if (tmp)
2238                                 *tmp = '\0';
2239                 } 
2240         } else if (!strcasecmp(args.item, "exten"))
2241                 ast_copy_string(buf, agent->loginchan, len);    
2242
2243         return 0;
2244 }
2245
2246 struct ast_custom_function agent_function = {
2247         .name = "AGENT",
2248         .synopsis = "Gets information about an Agent",
2249         .syntax = "AGENT(<agentid>[:item])",
2250         .read = function_agent,
2251         .desc = "The valid items to retrieve are:\n"
2252         "- status (default)      The status of the agent\n"
2253         "                          LOGGEDIN | LOGGEDOUT\n"
2254         "- password              The password of the agent\n"
2255         "- name                  The name of the agent\n"
2256         "- mohclass              MusicOnHold class\n"
2257         "- exten                 The callback extension for the Agent (AgentCallbackLogin)\n"
2258         "- channel               The name of the active channel for the Agent (AgentLogin)\n"
2259 };
2260
2261
2262 /*!
2263  * \brief Initialize the Agents module.
2264  * This function is being called by Asterisk when loading the module. 
2265  * Among other things it registers applications, cli commands and reads the cofiguration file.
2266  *
2267  * \returns int Always 0.
2268  */
2269 static int load_module(void)
2270 {
2271         /* Make sure we can register our agent channel type */
2272         if (ast_channel_register(&agent_tech)) {
2273                 ast_log(LOG_ERROR, "Unable to register channel class 'Agent'\n");
2274                 return -1;
2275         }
2276         /* Read in the config */
2277         if (!read_agent_config())
2278                 return AST_MODULE_LOAD_DECLINE;
2279         if (persistent_agents)
2280                 reload_agents();
2281         /* Dialplan applications */
2282         ast_register_application(app, login_exec, synopsis, descrip);
2283         ast_register_application(app3, agentmonitoroutgoing_exec, synopsis3, descrip3);
2284
2285         /* Manager commands */
2286         ast_manager_register2("Agents", EVENT_FLAG_AGENT, action_agents, "Lists agents and their status", mandescr_agents);
2287         ast_manager_register2("AgentLogoff", EVENT_FLAG_AGENT, action_agent_logoff, "Sets an agent as no longer logged in", mandescr_agent_logoff);
2288
2289         /* CLI Commands */
2290         ast_cli_register_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2291
2292         /* Dialplan Functions */
2293         ast_custom_function_register(&agent_function);
2294
2295         return 0;
2296 }
2297
2298 static int reload(void)
2299 {
2300         read_agent_config();
2301         if (persistent_agents)
2302                 reload_agents();
2303         return 0;
2304 }
2305
2306 static int unload_module(void)
2307 {
2308         struct agent_pvt *p;
2309         /* First, take us out of the channel loop */
2310         ast_channel_unregister(&agent_tech);
2311         /* Unregister dialplan functions */
2312         ast_custom_function_unregister(&agent_function);        
2313         /* Unregister CLI commands */
2314         ast_cli_unregister_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2315         /* Unregister dialplan applications */
2316         ast_unregister_application(app);
2317         ast_unregister_application(app3);
2318         /* Unregister manager command */
2319         ast_manager_unregister("Agents");
2320         ast_manager_unregister("AgentLogoff");
2321         /* Unregister channel */
2322         AST_LIST_LOCK(&agents);
2323         /* Hangup all interfaces if they have an owner */
2324         while ((p = AST_LIST_REMOVE_HEAD(&agents, list))) {
2325                 if (p->owner)
2326                         ast_softhangup(p->owner, AST_SOFTHANGUP_APPUNLOAD);
2327                 ast_free(p);
2328         }
2329         AST_LIST_UNLOCK(&agents);
2330         AST_LIST_HEAD_DESTROY(&agents);
2331         return 0;
2332 }
2333
2334 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Agent Proxy Channel",
2335                 .load = load_module,
2336                 .unload = unload_module,
2337                 .reload = reload,
2338                );