Add a massive set of changes for converting to use the ast_debug() macro.
[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                 ast_indicate(p->chan, AST_CONTROL_UNHOLD);
964         p->owning_app = pthread_self();
965         /* After the above step, there should not be any blockers. */
966         if (p->chan) {
967                 if (ast_test_flag(p->chan, AST_FLAG_BLOCKING)) {
968                         ast_log( LOG_ERROR, "A blocker exists after agent channel ownership acquired\n" );
969                         CRASH;
970                 }
971         }
972         return tmp;
973 }
974
975
976 /*!
977  * Read configuration data. The file named agents.conf.
978  *
979  * \returns Always 0, or so it seems.
980  */
981 static int read_agent_config(void)
982 {
983         struct ast_config *cfg;
984         struct ast_config *ucfg;
985         struct ast_variable *v;
986         struct agent_pvt *p;
987         const char *general_val;
988         const char *catname;
989         const char *hasagent;
990         int genhasagent;
991
992         group = 0;
993         autologoff = 0;
994         wrapuptime = 0;
995         ackcall = 0;
996         endcall = 1;
997         cfg = ast_config_load(config);
998         if (!cfg) {
999                 ast_log(LOG_NOTICE, "No agent configuration found -- agent support disabled\n");
1000                 return 0;
1001         }
1002         AST_LIST_LOCK(&agents);
1003         AST_LIST_TRAVERSE(&agents, p, list) {
1004                 p->dead = 1;
1005         }
1006         strcpy(moh, "default");
1007         /* set the default recording values */
1008         recordagentcalls = 0;
1009         strcpy(recordformat, "wav");
1010         strcpy(recordformatext, "wav");
1011         urlprefix[0] = '\0';
1012         savecallsin[0] = '\0';
1013
1014         /* Read in [general] section for persistence */
1015         if ((general_val = ast_variable_retrieve(cfg, "general", "persistentagents")))
1016                 persistent_agents = ast_true(general_val);
1017         multiplelogin = ast_true(ast_variable_retrieve(cfg, "general", "multiplelogin"));
1018
1019         /* Read in the [agents] section */
1020         v = ast_variable_browse(cfg, "agents");
1021         while(v) {
1022                 /* Create the interface list */
1023                 if (!strcasecmp(v->name, "agent")) {
1024                         add_agent(v->value, 0);
1025                 } else if (!strcasecmp(v->name, "group")) {
1026                         group = ast_get_group(v->value);
1027                 } else if (!strcasecmp(v->name, "autologoff")) {
1028                         autologoff = atoi(v->value);
1029                         if (autologoff < 0)
1030                                 autologoff = 0;
1031                 } else if (!strcasecmp(v->name, "ackcall")) {
1032                         if (!strcasecmp(v->value, "always"))
1033                                 ackcall = 2;
1034                         else if (ast_true(v->value))
1035                                 ackcall = 1;
1036                         else
1037                                 ackcall = 0;
1038                 } else if (!strcasecmp(v->name, "endcall")) {
1039                         endcall = ast_true(v->value);
1040                 } else if (!strcasecmp(v->name, "wrapuptime")) {
1041                         wrapuptime = atoi(v->value);
1042                         if (wrapuptime < 0)
1043                                 wrapuptime = 0;
1044                 } else if (!strcasecmp(v->name, "maxlogintries") && !ast_strlen_zero(v->value)) {
1045                         maxlogintries = atoi(v->value);
1046                         if (maxlogintries < 0)
1047                                 maxlogintries = 0;
1048                 } else if (!strcasecmp(v->name, "goodbye") && !ast_strlen_zero(v->value)) {
1049                         strcpy(agentgoodbye,v->value);
1050                 } else if (!strcasecmp(v->name, "musiconhold")) {
1051                         ast_copy_string(moh, v->value, sizeof(moh));
1052                 } else if (!strcasecmp(v->name, "updatecdr")) {
1053                         if (ast_true(v->value))
1054                                 updatecdr = 1;
1055                         else
1056                                 updatecdr = 0;
1057                 } else if (!strcasecmp(v->name, "autologoffunavail")) {
1058                         if (ast_true(v->value))
1059                                 autologoffunavail = 1;
1060                         else
1061                                 autologoffunavail = 0;
1062                 } else if (!strcasecmp(v->name, "recordagentcalls")) {
1063                         recordagentcalls = ast_true(v->value);
1064                 } else if (!strcasecmp(v->name, "recordformat")) {
1065                         ast_copy_string(recordformat, v->value, sizeof(recordformat));
1066                         if (!strcasecmp(v->value, "wav49"))
1067                                 strcpy(recordformatext, "WAV");
1068                         else
1069                                 ast_copy_string(recordformatext, v->value, sizeof(recordformatext));
1070                 } else if (!strcasecmp(v->name, "urlprefix")) {
1071                         ast_copy_string(urlprefix, v->value, sizeof(urlprefix));
1072                         if (urlprefix[strlen(urlprefix) - 1] != '/')
1073                                 strncat(urlprefix, "/", sizeof(urlprefix) - strlen(urlprefix) - 1);
1074                 } else if (!strcasecmp(v->name, "savecallsin")) {
1075                         if (v->value[0] == '/')
1076                                 ast_copy_string(savecallsin, v->value, sizeof(savecallsin));
1077                         else
1078                                 snprintf(savecallsin, sizeof(savecallsin) - 2, "/%s", v->value);
1079                         if (savecallsin[strlen(savecallsin) - 1] != '/')
1080                                 strncat(savecallsin, "/", sizeof(savecallsin) - strlen(savecallsin) - 1);
1081                 } else if (!strcasecmp(v->name, "custom_beep")) {
1082                         ast_copy_string(beep, v->value, sizeof(beep));
1083                 }
1084                 v = v->next;
1085         }
1086         if ((ucfg = ast_config_load("users.conf"))) {
1087                 genhasagent = ast_true(ast_variable_retrieve(ucfg, "general", "hasagent"));
1088                 catname = ast_category_browse(ucfg, NULL);
1089                 while(catname) {
1090                         if (strcasecmp(catname, "general")) {
1091                                 hasagent = ast_variable_retrieve(ucfg, catname, "hasagent");
1092                                 if (ast_true(hasagent) || (!hasagent && genhasagent)) {
1093                                         char tmp[256];
1094                                         const char *fullname = ast_variable_retrieve(ucfg, catname, "fullname");
1095                                         const char *secret = ast_variable_retrieve(ucfg, catname, "secret");
1096                                         if (!fullname)
1097                                                 fullname = "";
1098                                         if (!secret)
1099                                                 secret = "";
1100                                         snprintf(tmp, sizeof(tmp), "%s,%s,%s", catname, secret,fullname);
1101                                         add_agent(tmp, 0);
1102                                 }
1103                         }
1104                         catname = ast_category_browse(ucfg, catname);
1105                 }
1106                 ast_config_destroy(ucfg);
1107         }
1108         AST_LIST_TRAVERSE_SAFE_BEGIN(&agents, p, list) {
1109                 if (p->dead) {
1110                         AST_LIST_REMOVE_CURRENT(&agents, list);
1111                         /* Destroy if  appropriate */
1112                         if (!p->owner) {
1113                                 if (!p->chan) {
1114                                         ast_mutex_destroy(&p->lock);
1115                                         ast_mutex_destroy(&p->app_lock);
1116                                         ast_free(p);
1117                                 } else {
1118                                         /* Cause them to hang up */
1119                                         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1120                                 }
1121                         }
1122                 }
1123         }
1124         AST_LIST_TRAVERSE_SAFE_END
1125         AST_LIST_UNLOCK(&agents);
1126         ast_config_destroy(cfg);
1127         return 1;
1128 }
1129
1130 static int check_availability(struct agent_pvt *newlyavailable, int needlock)
1131 {
1132         struct ast_channel *chan=NULL, *parent=NULL;
1133         struct agent_pvt *p;
1134         int res;
1135
1136         ast_debug(1, "Checking availability of '%s'\n", newlyavailable->agent);
1137         if (needlock)
1138                 AST_LIST_LOCK(&agents);
1139         AST_LIST_TRAVERSE(&agents, p, list) {
1140                 if (p == newlyavailable) {
1141                         continue;
1142                 }
1143                 ast_mutex_lock(&p->lock);
1144                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1145                         ast_debug(1, "Call '%s' looks like a winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1146                         /* We found a pending call, time to merge */
1147                         chan = agent_new(newlyavailable, AST_STATE_DOWN);
1148                         parent = p->owner;
1149                         p->abouttograb = 1;
1150                         ast_mutex_unlock(&p->lock);
1151                         break;
1152                 }
1153                 ast_mutex_unlock(&p->lock);
1154         }
1155         if (needlock)
1156                 AST_LIST_UNLOCK(&agents);
1157         if (parent && chan)  {
1158                 if (newlyavailable->ackcall > 1) {
1159                         /* Don't do beep here */
1160                         res = 0;
1161                 } else {
1162                         ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1163                         res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1164                         ast_debug(3, "Played beep, result '%d'\n", res);
1165                         if (!res) {
1166                                 res = ast_waitstream(newlyavailable->chan, "");
1167                                 ast_debug(1, "Waited for stream, result '%d'\n", res);
1168                         }
1169                 }
1170                 if (!res) {
1171                         /* Note -- parent may have disappeared */
1172                         if (p->abouttograb) {
1173                                 newlyavailable->acknowledged = 1;
1174                                 /* Safe -- agent lock already held */
1175                                 ast_setstate(parent, AST_STATE_UP);
1176                                 ast_setstate(chan, AST_STATE_UP);
1177                                 ast_copy_string(parent->context, chan->context, sizeof(parent->context));
1178                                 /* Go ahead and mark the channel as a zombie so that masquerade will
1179                                    destroy it for us, and we need not call ast_hangup */
1180                                 ast_mutex_lock(&parent->lock);
1181                                 ast_set_flag(chan, AST_FLAG_ZOMBIE);
1182                                 ast_channel_masquerade(parent, chan);
1183                                 ast_mutex_unlock(&parent->lock);
1184                                 p->abouttograb = 0;
1185                         } else {
1186                                 ast_debug(1, "Sneaky, parent disappeared in the mean time...\n");
1187                                 agent_cleanup(newlyavailable);
1188                         }
1189                 } else {
1190                         ast_debug(1, "Ugh...  Agent hung up at exactly the wrong time\n");
1191                         agent_cleanup(newlyavailable);
1192                 }
1193         }
1194         return 0;
1195 }
1196
1197 static int check_beep(struct agent_pvt *newlyavailable, int needlock)
1198 {
1199         struct agent_pvt *p;
1200         int res=0;
1201
1202         ast_debug(1, "Checking beep availability of '%s'\n", newlyavailable->agent);
1203         if (needlock)
1204                 AST_LIST_LOCK(&agents);
1205         AST_LIST_TRAVERSE(&agents, p, list) {
1206                 if (p == newlyavailable) {
1207                         continue;
1208                 }
1209                 ast_mutex_lock(&p->lock);
1210                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1211                         ast_debug(1, "Call '%s' looks like a would-be winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1212                         ast_mutex_unlock(&p->lock);
1213                         break;
1214                 }
1215                 ast_mutex_unlock(&p->lock);
1216         }
1217         if (needlock)
1218                 AST_LIST_UNLOCK(&agents);
1219         if (p) {
1220                 ast_mutex_unlock(&newlyavailable->lock);
1221                 ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1222                 res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1223                 ast_debug(1, "Played beep, result '%d'\n", res);
1224                 if (!res) {
1225                         res = ast_waitstream(newlyavailable->chan, "");
1226                         ast_debug(1, "Waited for stream, result '%d'\n", res);
1227                 }
1228                 ast_mutex_lock(&newlyavailable->lock);
1229         }
1230         return res;
1231 }
1232
1233 /*! \brief Part of the Asterisk PBX interface */
1234 static struct ast_channel *agent_request(const char *type, int format, void *data, int *cause)
1235 {
1236         struct agent_pvt *p;
1237         struct ast_channel *chan = NULL;
1238         char *s;
1239         ast_group_t groupmatch;
1240         int groupoff;
1241         int waitforagent=0;
1242         int hasagent = 0;
1243         struct timeval tv;
1244
1245         s = data;
1246         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1247                 groupmatch = (1 << groupoff);
1248         } else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1249                 groupmatch = (1 << groupoff);
1250                 waitforagent = 1;
1251         } else 
1252                 groupmatch = 0;
1253
1254         /* Check actual logged in agents first */
1255         AST_LIST_LOCK(&agents);
1256         AST_LIST_TRAVERSE(&agents, p, list) {
1257                 ast_mutex_lock(&p->lock);
1258                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent)) &&
1259                     ast_strlen_zero(p->loginchan)) {
1260                         if (p->chan)
1261                                 hasagent++;
1262                         if (!p->lastdisc.tv_sec) {
1263                                 /* Agent must be registered, but not have any active call, and not be in a waiting state */
1264                                 if (!p->owner && p->chan) {
1265                                         /* Fixed agent */
1266                                         chan = agent_new(p, AST_STATE_DOWN);
1267                                 }
1268                                 if (chan) {
1269                                         ast_mutex_unlock(&p->lock);
1270                                         break;
1271                                 }
1272                         }
1273                 }
1274                 ast_mutex_unlock(&p->lock);
1275         }
1276         if (!p) {
1277                 AST_LIST_TRAVERSE(&agents, p, list) {
1278                         ast_mutex_lock(&p->lock);
1279                         if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
1280                                 if (p->chan || !ast_strlen_zero(p->loginchan))
1281                                         hasagent++;
1282                                 tv = ast_tvnow();
1283 #if 0
1284                                 ast_log(LOG_NOTICE, "Time now: %ld, Time of lastdisc: %ld\n", tv.tv_sec, p->lastdisc.tv_sec);
1285 #endif
1286                                 if (!p->lastdisc.tv_sec || (tv.tv_sec > p->lastdisc.tv_sec)) {
1287                                         p->lastdisc = ast_tv(0, 0);
1288                                         /* Agent must be registered, but not have any active call, and not be in a waiting state */
1289                                         if (!p->owner && p->chan) {
1290                                                 /* Could still get a fixed agent */
1291                                                 chan = agent_new(p, AST_STATE_DOWN);
1292                                         } else if (!p->owner && !ast_strlen_zero(p->loginchan)) {
1293                                                 /* Adjustable agent */
1294                                                 p->chan = ast_request("Local", format, p->loginchan, cause);
1295                                                 if (p->chan)
1296                                                         chan = agent_new(p, AST_STATE_DOWN);
1297                                         }
1298                                         if (chan) {
1299                                                 ast_mutex_unlock(&p->lock);
1300                                                 break;
1301                                         }
1302                                 }
1303                         }
1304                         ast_mutex_unlock(&p->lock);
1305                 }
1306         }
1307
1308         if (!chan && waitforagent) {
1309                 /* No agent available -- but we're requesting to wait for one.
1310                    Allocate a place holder */
1311                 if (hasagent) {
1312                         ast_debug(1, "Creating place holder for '%s'\n", s);
1313                         p = add_agent(data, 1);
1314                         p->group = groupmatch;
1315                         chan = agent_new(p, AST_STATE_DOWN);
1316                         if (!chan) 
1317                                 ast_log(LOG_WARNING, "Weird...  Fix this to drop the unused pending agent\n");
1318                 } else {
1319                         ast_debug(1, "Not creating place holder for '%s' since nobody logged in\n", s);
1320                 }
1321         }
1322         *cause = hasagent ? AST_CAUSE_BUSY : AST_CAUSE_UNREGISTERED;
1323         AST_LIST_UNLOCK(&agents);
1324         return chan;
1325 }
1326
1327 static force_inline int powerof(unsigned int d)
1328 {
1329         int x = ffs(d);
1330
1331         if (x)
1332                 return x - 1;
1333
1334         return 0;
1335 }
1336
1337 /*!
1338  * Lists agents and their status to the Manager API.
1339  * It is registered on load_module() and it gets called by the manager backend.
1340  * \param s
1341  * \param m
1342  * \returns 
1343  * \sa action_agent_logoff(), load_module().
1344  */
1345 static int action_agents(struct mansession *s, const struct message *m)
1346 {
1347         const char *id = astman_get_header(m,"ActionID");
1348         char idText[256] = "";
1349         char chanbuf[256];
1350         struct agent_pvt *p;
1351         char *username = NULL;
1352         char *loginChan = NULL;
1353         char *talkingtoChan = NULL;
1354         char *status = NULL;
1355
1356         if (!ast_strlen_zero(id))
1357                 snprintf(idText, sizeof(idText) ,"ActionID: %s\r\n", id);
1358         astman_send_ack(s, m, "Agents will follow");
1359         AST_LIST_LOCK(&agents);
1360         AST_LIST_TRAVERSE(&agents, p, list) {
1361                 ast_mutex_lock(&p->lock);
1362
1363                 /* Status Values:
1364                    AGENT_LOGGEDOFF - Agent isn't logged in
1365                    AGENT_IDLE      - Agent is logged in, and waiting for call
1366                    AGENT_ONCALL    - Agent is logged in, and on a call
1367                    AGENT_UNKNOWN   - Don't know anything about agent. Shouldn't ever get this. */
1368
1369                 username = S_OR(p->name, "None");
1370
1371                 /* Set a default status. It 'should' get changed. */
1372                 status = "AGENT_UNKNOWN";
1373
1374                 if (!ast_strlen_zero(p->loginchan) && !p->chan) {
1375                         loginChan = p->loginchan;
1376                         talkingtoChan = "n/a";
1377                         status = "AGENT_IDLE";
1378                         if (p->acknowledged) {
1379                                 snprintf(chanbuf, sizeof(chanbuf), " %s (Confirmed)", p->loginchan);
1380                                 loginChan = chanbuf;
1381                         }
1382                 } else if (p->chan) {
1383                         loginChan = ast_strdupa(p->chan->name);
1384                         if (p->owner && p->owner->_bridge) {
1385                                 talkingtoChan = p->chan->cid.cid_num;
1386                                 status = "AGENT_ONCALL";
1387                         } else {
1388                                 talkingtoChan = "n/a";
1389                                 status = "AGENT_IDLE";
1390                         }
1391                 } else {
1392                         loginChan = "n/a";
1393                         talkingtoChan = "n/a";
1394                         status = "AGENT_LOGGEDOFF";
1395                 }
1396
1397                 astman_append(s, "Event: Agents\r\n"
1398                         "Agent: %s\r\n"
1399                         "Name: %s\r\n"
1400                         "Status: %s\r\n"
1401                         "LoggedInChan: %s\r\n"
1402                         "LoggedInTime: %d\r\n"
1403                         "TalkingTo: %s\r\n"
1404                         "%s"
1405                         "\r\n",
1406                         p->agent, username, status, loginChan, (int)p->loginstart, talkingtoChan, idText);
1407                 ast_mutex_unlock(&p->lock);
1408         }
1409         AST_LIST_UNLOCK(&agents);
1410         astman_append(s, "Event: AgentsComplete\r\n"
1411                 "%s"
1412                 "\r\n",idText);
1413         return 0;
1414 }
1415
1416 static void agent_logoff_maintenance(struct agent_pvt *p, char *loginchan, long logintime, const char *uniqueid, char *logcommand)
1417 {
1418         char *tmp = NULL;
1419         char agent[AST_MAX_AGENT];
1420
1421         if (!ast_strlen_zero(logcommand))
1422                 tmp = logcommand;
1423         else
1424                 tmp = ast_strdupa("");
1425
1426         snprintf(agent, sizeof(agent), "Agent/%s", p->agent);
1427
1428         if (!ast_strlen_zero(uniqueid)) {
1429                 manager_event(EVENT_FLAG_AGENT, "Agentcallbacklogoff",
1430                                 "Agent: %s\r\n"
1431                                 "Reason: %s\r\n"
1432                                 "Loginchan: %s\r\n"
1433                                 "Logintime: %ld\r\n"
1434                                 "Uniqueid: %s\r\n", 
1435                                 p->agent, tmp, loginchan, logintime, uniqueid);
1436         } else {
1437                 manager_event(EVENT_FLAG_AGENT, "Agentcallbacklogoff",
1438                                 "Agent: %s\r\n"
1439                                 "Reason: %s\r\n"
1440                                 "Loginchan: %s\r\n"
1441                                 "Logintime: %ld\r\n",
1442                                 p->agent, tmp, loginchan, logintime);
1443         }
1444
1445         ast_queue_log("NONE", ast_strlen_zero(uniqueid) ? "NONE" : uniqueid, agent, "AGENTCALLBACKLOGOFF", "%s|%ld|%s", loginchan, logintime, tmp);
1446         set_agentbycallerid(p->logincallerid, NULL);
1447         p->loginchan[0] ='\0';
1448         p->logincallerid[0] = '\0';
1449         ast_device_state_changed("Agent/%s", p->agent);
1450         if (persistent_agents)
1451                 dump_agents();  
1452
1453 }
1454
1455 static int agent_logoff(const char *agent, int soft)
1456 {
1457         struct agent_pvt *p;
1458         long logintime;
1459         int ret = -1; /* Return -1 if no agent if found */
1460
1461         AST_LIST_TRAVERSE(&agents, p, list) {
1462                 if (!strcasecmp(p->agent, agent)) {
1463                         ret = 0;
1464                         if (p->owner || p->chan) {
1465                                 p->deferlogoff = 1;
1466                                 if (!soft) {
1467                                         if (p->owner)
1468                                                 ast_softhangup(p->owner, AST_SOFTHANGUP_EXPLICIT);
1469                                         if (p->chan)
1470                                                 ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1471                                 }
1472                         } else {
1473                                 logintime = time(NULL) - p->loginstart;
1474                                 p->loginstart = 0;
1475                                 agent_logoff_maintenance(p, p->loginchan, logintime, NULL, "CommandLogoff");
1476                         }
1477                         break;
1478                 }
1479         }
1480
1481         return ret;
1482 }
1483
1484 static int agent_logoff_cmd(int fd, int argc, char **argv)
1485 {
1486         int ret;
1487         char *agent;
1488
1489         if (argc < 3 || argc > 4)
1490                 return RESULT_SHOWUSAGE;
1491         if (argc == 4 && strcasecmp(argv[3], "soft"))
1492                 return RESULT_SHOWUSAGE;
1493
1494         agent = argv[2] + 6;
1495         ret = agent_logoff(agent, argc == 4);
1496         if (ret == 0)
1497                 ast_cli(fd, "Logging out %s\n", agent);
1498
1499         return RESULT_SUCCESS;
1500 }
1501
1502 /*!
1503  * Sets an agent as no longer logged in in the Manager API.
1504  * It is registered on load_module() and it gets called by the manager backend.
1505  * \param s
1506  * \param m
1507  * \returns 
1508  * \sa action_agents(), load_module().
1509  */
1510 static int action_agent_logoff(struct mansession *s, const struct message *m)
1511 {
1512         const char *agent = astman_get_header(m, "Agent");
1513         const char *soft_s = astman_get_header(m, "Soft"); /* "true" is don't hangup */
1514         int soft;
1515         int ret; /* return value of agent_logoff */
1516
1517         if (ast_strlen_zero(agent)) {
1518                 astman_send_error(s, m, "No agent specified");
1519                 return 0;
1520         }
1521
1522         soft = ast_true(soft_s) ? 1 : 0;
1523         ret = agent_logoff(agent, soft);
1524         if (ret == 0)
1525                 astman_send_ack(s, m, "Agent logged out");
1526         else
1527                 astman_send_error(s, m, "No such agent");
1528
1529         return 0;
1530 }
1531
1532 static char *complete_agent_logoff_cmd(const char *line, const char *word, int pos, int state)
1533 {
1534         if (pos == 2) {
1535                 struct agent_pvt *p;
1536                 char name[AST_MAX_AGENT];
1537                 int which = 0, len = strlen(word);
1538
1539                 AST_LIST_TRAVERSE(&agents, p, list) {
1540                         snprintf(name, sizeof(name), "Agent/%s", p->agent);
1541                         if (!strncasecmp(word, name, len) && p->loginstart && ++which > state)
1542                                 return ast_strdup(name);
1543                 }
1544         } else if (pos == 3 && state == 0) 
1545                 return ast_strdup("soft");
1546         
1547         return NULL;
1548 }
1549
1550 /*!
1551  * Show agents in cli.
1552  */
1553 static int agents_show(int fd, int argc, char **argv)
1554 {
1555         struct agent_pvt *p;
1556         char username[AST_MAX_BUF];
1557         char location[AST_MAX_BUF] = "";
1558         char talkingto[AST_MAX_BUF] = "";
1559         char moh[AST_MAX_BUF];
1560         int count_agents = 0;           /*!< Number of agents configured */
1561         int online_agents = 0;          /*!< Number of online agents */
1562         int offline_agents = 0;         /*!< Number of offline agents */
1563         if (argc != 2)
1564                 return RESULT_SHOWUSAGE;
1565         AST_LIST_LOCK(&agents);
1566         AST_LIST_TRAVERSE(&agents, p, list) {
1567                 ast_mutex_lock(&p->lock);
1568                 if (p->pending) {
1569                         if (p->group)
1570                                 ast_cli(fd, "-- Pending call to group %d\n", powerof(p->group));
1571                         else
1572                                 ast_cli(fd, "-- Pending call to agent %s\n", p->agent);
1573                 } else {
1574                         if (!ast_strlen_zero(p->name))
1575                                 snprintf(username, sizeof(username), "(%s) ", p->name);
1576                         else
1577                                 username[0] = '\0';
1578                         if (p->chan) {
1579                                 snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
1580                                 if (p->owner && ast_bridged_channel(p->owner))
1581                                         snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(p->owner)->name);
1582                                  else 
1583                                         strcpy(talkingto, " is idle");
1584                                 online_agents++;
1585                         } else if (!ast_strlen_zero(p->loginchan)) {
1586                                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0 || !(p->lastdisc.tv_sec)) 
1587                                         snprintf(location, sizeof(location) - 20, "available at '%s'", p->loginchan);
1588                                 else 
1589                                         snprintf(location, sizeof(location) - 20, "wrapping up at '%s'", p->loginchan);
1590                                 talkingto[0] = '\0';
1591                                 online_agents++;
1592                                 if (p->acknowledged)
1593                                         strncat(location, " (Confirmed)", sizeof(location) - strlen(location) - 1);
1594                         } else {
1595                                 strcpy(location, "not logged in");
1596                                 talkingto[0] = '\0';
1597                                 offline_agents++;
1598                         }
1599                         if (!ast_strlen_zero(p->moh))
1600                                 snprintf(moh, sizeof(moh), " (musiconhold is '%s')", p->moh);
1601                         ast_cli(fd, "%-12.12s %s%s%s%s\n", p->agent, 
1602                                 username, location, talkingto, moh);
1603                         count_agents++;
1604                 }
1605                 ast_mutex_unlock(&p->lock);
1606         }
1607         AST_LIST_UNLOCK(&agents);
1608         if ( !count_agents ) 
1609                 ast_cli(fd, "No Agents are configured in %s\n",config);
1610         else 
1611                 ast_cli(fd, "%d agents configured [%d online , %d offline]\n",count_agents, online_agents, offline_agents);
1612         ast_cli(fd, "\n");
1613                         
1614         return RESULT_SUCCESS;
1615 }
1616
1617
1618 static int agents_show_online(int fd, int argc, char **argv)
1619 {
1620         struct agent_pvt *p;
1621         char username[AST_MAX_BUF];
1622         char location[AST_MAX_BUF] = "";
1623         char talkingto[AST_MAX_BUF] = "";
1624         char moh[AST_MAX_BUF];
1625         int count_agents = 0;           /* Number of agents configured */
1626         int online_agents = 0;          /* Number of online agents */
1627         int agent_status = 0;           /* 0 means offline, 1 means online */
1628         if (argc != 3)
1629                 return RESULT_SHOWUSAGE;
1630         AST_LIST_LOCK(&agents);
1631         AST_LIST_TRAVERSE(&agents, p, list) {
1632                 agent_status = 0;       /* reset it to offline */
1633                 ast_mutex_lock(&p->lock);
1634                 if (!ast_strlen_zero(p->name))
1635                         snprintf(username, sizeof(username), "(%s) ", p->name);
1636                 else
1637                         username[0] = '\0';
1638                 if (p->chan) {
1639                         snprintf(location, sizeof(location), "logged in on %s", p->chan->name);
1640                         if (p->owner && ast_bridged_channel(p->owner)) 
1641                                 snprintf(talkingto, sizeof(talkingto), " talking to %s", ast_bridged_channel(p->owner)->name);
1642                         else 
1643                                 strcpy(talkingto, " is idle");
1644                         agent_status = 1;
1645                         online_agents++;
1646                 } else if (!ast_strlen_zero(p->loginchan)) {
1647                         snprintf(location, sizeof(location) - 20, "available at '%s'", p->loginchan);
1648                         talkingto[0] = '\0';
1649                         agent_status = 1;
1650                         online_agents++;
1651                         if (p->acknowledged)
1652                                 strncat(location, " (Confirmed)", sizeof(location) - strlen(location) - 1);
1653                 }
1654                 if (!ast_strlen_zero(p->moh))
1655                         snprintf(moh, sizeof(moh), " (musiconhold is '%s')", p->moh);
1656                 if (agent_status)
1657                         ast_cli(fd, "%-12.12s %s%s%s%s\n", p->agent, username, location, talkingto, moh);
1658                 count_agents++;
1659                 ast_mutex_unlock(&p->lock);
1660         }
1661         AST_LIST_UNLOCK(&agents);
1662         if (!count_agents) 
1663                 ast_cli(fd, "No Agents are configured in %s\n", config);
1664         else
1665                 ast_cli(fd, "%d agents online\n", online_agents);
1666         ast_cli(fd, "\n");
1667         return RESULT_SUCCESS;
1668 }
1669
1670
1671
1672 static const char show_agents_usage[] = 
1673 "Usage: agent show\n"
1674 "       Provides summary information on agents.\n";
1675
1676 static const char show_agents_online_usage[] =
1677 "Usage: agent show online\n"
1678 "       Provides a list of all online agents.\n";
1679
1680 static const char agent_logoff_usage[] =
1681 "Usage: agent logoff <channel> [soft]\n"
1682 "       Sets an agent as no longer logged in.\n"
1683 "       If 'soft' is specified, do not hangup existing calls.\n";
1684
1685 static struct ast_cli_entry cli_agents[] = {
1686         { { "agent", "show", NULL },
1687         agents_show, "Show status of agents",
1688         show_agents_usage },
1689
1690         { { "agent", "show", "online" },
1691         agents_show_online, "Show all online agents",
1692         show_agents_online_usage },
1693
1694         { { "agent", "logoff", NULL },
1695         agent_logoff_cmd, "Sets an agent offline",
1696         agent_logoff_usage, complete_agent_logoff_cmd },
1697 };
1698
1699 /*!
1700  * Called by the AgentLogin application (from the dial plan).
1701  * 
1702  * \brief Log in agent application.
1703  *
1704  * \param chan
1705  * \param data
1706  * \returns
1707  * \sa agentmonitoroutgoing_exec(), load_module().
1708  */
1709 static int login_exec(struct ast_channel *chan, void *data)
1710 {
1711         int res=0;
1712         int tries = 0;
1713         int max_login_tries = maxlogintries;
1714         struct agent_pvt *p;
1715         struct ast_module_user *u;
1716         int login_state = 0;
1717         char user[AST_MAX_AGENT] = "";
1718         char pass[AST_MAX_AGENT];
1719         char agent[AST_MAX_AGENT] = "";
1720         char xpass[AST_MAX_AGENT] = "";
1721         char *errmsg;
1722         char *parse;
1723         AST_DECLARE_APP_ARGS(args,
1724                              AST_APP_ARG(agent_id);
1725                              AST_APP_ARG(options);
1726                              AST_APP_ARG(extension);
1727                 );
1728         const char *tmpoptions = NULL;
1729         int play_announcement = 1;
1730         char agent_goodbye[AST_MAX_FILENAME_LEN];
1731         int update_cdr = updatecdr;
1732         char *filename = "agent-loginok";
1733
1734         u = ast_module_user_add(chan);
1735
1736         parse = ast_strdupa(data);
1737
1738         AST_STANDARD_APP_ARGS(args, parse);
1739
1740         ast_copy_string(agent_goodbye, agentgoodbye, sizeof(agent_goodbye));
1741
1742         /* Set Channel Specific Login Overrides */
1743         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTLMAXLOGINTRIES"))) {
1744                 max_login_tries = atoi(pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES"));
1745                 if (max_login_tries < 0)
1746                         max_login_tries = 0;
1747                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTMAXLOGINTRIES");
1748                 if (option_verbose > 2)
1749                         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);
1750         }
1751         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR"))) {
1752                 if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR")))
1753                         update_cdr = 1;
1754                 else
1755                         update_cdr = 0;
1756                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR");
1757                 if (option_verbose > 2)
1758                         ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTUPDATECDR=%s, setting update_cdr to: %d on Channel '%s'.\n",tmpoptions,update_cdr,chan->name);
1759         }
1760         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"))) {
1761                 strcpy(agent_goodbye, pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"));
1762                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTGOODBYE");
1763                 if (option_verbose > 2)
1764                         ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTGOODBYE=%s, setting agent_goodbye to: %s on Channel '%s'.\n",tmpoptions,agent_goodbye,chan->name);
1765         }
1766         /* End Channel Specific Login Overrides */
1767         
1768         if (!ast_strlen_zero(args.options)) {
1769                 if (strchr(args.options, 's')) {
1770                         play_announcement = 0;
1771                 }
1772         }
1773
1774         if (chan->_state != AST_STATE_UP)
1775                 res = ast_answer(chan);
1776         if (!res) {
1777                 if (!ast_strlen_zero(args.agent_id))
1778                         ast_copy_string(user, args.agent_id, AST_MAX_AGENT);
1779                 else
1780                         res = ast_app_getdata(chan, "agent-user", user, sizeof(user) - 1, 0);
1781         }
1782         while (!res && (max_login_tries==0 || tries < max_login_tries)) {
1783                 tries++;
1784                 /* Check for password */
1785                 AST_LIST_LOCK(&agents);
1786                 AST_LIST_TRAVERSE(&agents, p, list) {
1787                         if (!strcmp(p->agent, user) && !p->pending)
1788                                 ast_copy_string(xpass, p->password, sizeof(xpass));
1789                 }
1790                 AST_LIST_UNLOCK(&agents);
1791                 if (!res) {
1792                         if (!ast_strlen_zero(xpass))
1793                                 res = ast_app_getdata(chan, "agent-pass", pass, sizeof(pass) - 1, 0);
1794                         else
1795                                 pass[0] = '\0';
1796                 }
1797                 errmsg = "agent-incorrect";
1798
1799 #if 0
1800                 ast_log(LOG_NOTICE, "user: %s, pass: %s\n", user, pass);
1801 #endif          
1802
1803                 /* Check again for accuracy */
1804                 AST_LIST_LOCK(&agents);
1805                 AST_LIST_TRAVERSE(&agents, p, list) {
1806                         ast_mutex_lock(&p->lock);
1807                         if (!strcmp(p->agent, user) &&
1808                             !strcmp(p->password, pass) && !p->pending) {
1809                                 login_state = 1; /* Successful Login */
1810
1811                                 /* Ensure we can't be gotten until we're done */
1812                                 gettimeofday(&p->lastdisc, NULL);
1813                                 p->lastdisc.tv_sec++;
1814
1815                                 /* Set Channel Specific Agent Overrides */
1816                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"))) {
1817                                         if (!strcasecmp(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"), "always"))
1818                                                 p->ackcall = 2;
1819                                         else if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTACKCALL")))
1820                                                 p->ackcall = 1;
1821                                         else
1822                                                 p->ackcall = 0;
1823                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTACKCALL");
1824                                         if (option_verbose > 2)
1825                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTACKCALL=%s, setting ackcall to: %d for Agent '%s'.\n",tmpoptions,p->ackcall,p->agent);
1826                                 }
1827                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"))) {
1828                                         p->autologoff = atoi(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"));
1829                                         if (p->autologoff < 0)
1830                                                 p->autologoff = 0;
1831                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF");
1832                                         if (option_verbose > 2)
1833                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTAUTOLOGOFF=%s, setting autologff to: %d for Agent '%s'.\n",tmpoptions,p->autologoff,p->agent);
1834                                 }
1835                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"))) {
1836                                         p->wrapuptime = atoi(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"));
1837                                         if (p->wrapuptime < 0)
1838                                                 p->wrapuptime = 0;
1839                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME");
1840                                         if (option_verbose > 2)
1841                                                 ast_verbose(VERBOSE_PREFIX_3 "Saw variable AGENTWRAPUPTIME=%s, setting wrapuptime to: %d for Agent '%s'.\n",tmpoptions,p->wrapuptime,p->agent);
1842                                 }
1843                                 /* End Channel Specific Agent Overrides */
1844                                 if (!p->chan) {
1845                                         long logintime;
1846                                         snprintf(agent, sizeof(agent), "Agent/%s", p->agent);
1847
1848                                         p->loginchan[0] = '\0';
1849                                         p->logincallerid[0] = '\0';
1850                                         p->acknowledged = 0;
1851                                         
1852                                         ast_mutex_unlock(&p->lock);
1853                                         AST_LIST_UNLOCK(&agents);
1854                                         if( !res && play_announcement==1 )
1855                                                 res = ast_streamfile(chan, filename, chan->language);
1856                                         if (!res)
1857                                                 ast_waitstream(chan, "");
1858                                         AST_LIST_LOCK(&agents);
1859                                         ast_mutex_lock(&p->lock);
1860                                         if (!res) {
1861                                                 res = ast_set_read_format(chan, ast_best_codec(chan->nativeformats));
1862                                                 if (res)
1863                                                         ast_log(LOG_WARNING, "Unable to set read format to %d\n", ast_best_codec(chan->nativeformats));
1864                                         }
1865                                         if (!res) {
1866                                                 res = ast_set_write_format(chan, ast_best_codec(chan->nativeformats));
1867                                                 if (res)
1868                                                         ast_log(LOG_WARNING, "Unable to set write format to %d\n", ast_best_codec(chan->nativeformats));
1869                                         }
1870                                         /* Check once more just in case */
1871                                         if (p->chan)
1872                                                 res = -1;
1873                                         if (!res) {
1874                                                 ast_indicate_data(chan, AST_CONTROL_HOLD, 
1875                                                         S_OR(p->moh, NULL), 
1876                                                         !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
1877                                                 if (p->loginstart == 0)
1878                                                         time(&p->loginstart);
1879                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogin",
1880                                                               "Agent: %s\r\n"
1881                                                               "Channel: %s\r\n"
1882                                                               "Uniqueid: %s\r\n",
1883                                                               p->agent, chan->name, chan->uniqueid);
1884                                                 if (update_cdr && chan->cdr)
1885                                                         snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
1886                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGIN", "%s", chan->name);
1887                                                 if (option_verbose > 1)
1888                                                         ast_verbose(VERBOSE_PREFIX_2 "Agent '%s' logged in (format %s/%s)\n", p->agent,
1889                                                                     ast_getformatname(chan->readformat), ast_getformatname(chan->writeformat));
1890                                                 /* Login this channel and wait for it to go away */
1891                                                 p->chan = chan;
1892                                                 if (p->ackcall > 1)
1893                                                         check_beep(p, 0);
1894                                                 else
1895                                                         check_availability(p, 0);
1896                                                 ast_mutex_unlock(&p->lock);
1897                                                 AST_LIST_UNLOCK(&agents);
1898                                                 ast_device_state_changed("Agent/%s", p->agent);
1899                                                 while (res >= 0) {
1900                                                         ast_mutex_lock(&p->lock);
1901                                                         if (p->chan != chan)
1902                                                                 res = -1;
1903                                                         ast_mutex_unlock(&p->lock);
1904                                                         /* Yield here so other interested threads can kick in. */
1905                                                         sched_yield();
1906                                                         if (res)
1907                                                                 break;
1908
1909                                                         AST_LIST_LOCK(&agents);
1910                                                         ast_mutex_lock(&p->lock);
1911                                                         if (p->lastdisc.tv_sec) {
1912                                                                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > p->wrapuptime) {
1913                                                                         ast_debug(1, "Wrapup time for %s expired!\n", p->agent);
1914                                                                         p->lastdisc = ast_tv(0, 0);
1915                                                                         if (p->ackcall > 1)
1916                                                                                 check_beep(p, 0);
1917                                                                         else
1918                                                                                 check_availability(p, 0);
1919                                                                 }
1920                                                         }
1921                                                         ast_mutex_unlock(&p->lock);
1922                                                         AST_LIST_UNLOCK(&agents);
1923                                                         /*      Synchronize channel ownership between call to agent and itself. */
1924                                                         ast_mutex_lock( &p->app_lock );
1925                                                         ast_mutex_lock(&p->lock);
1926                                                         p->owning_app = pthread_self();
1927                                                         ast_mutex_unlock(&p->lock);
1928                                                         if (p->ackcall > 1) 
1929                                                                 res = agent_ack_sleep(p);
1930                                                         else
1931                                                                 res = ast_safe_sleep_conditional( chan, 1000, agent_cont_sleep, p );
1932                                                         ast_mutex_unlock( &p->app_lock );
1933                                                         if ((p->ackcall > 1)  && (res == 1)) {
1934                                                                 AST_LIST_LOCK(&agents);
1935                                                                 ast_mutex_lock(&p->lock);
1936                                                                 check_availability(p, 0);
1937                                                                 ast_mutex_unlock(&p->lock);
1938                                                                 AST_LIST_UNLOCK(&agents);
1939                                                                 res = 0;
1940                                                         }
1941                                                         sched_yield();
1942                                                 }
1943                                                 ast_mutex_lock(&p->lock);
1944                                                 if (res && p->owner) 
1945                                                         ast_log(LOG_WARNING, "Huh?  We broke out when there was still an owner?\n");
1946                                                 /* Log us off if appropriate */
1947                                                 if (p->chan == chan)
1948                                                         p->chan = NULL;
1949                                                 p->acknowledged = 0;
1950                                                 logintime = time(NULL) - p->loginstart;
1951                                                 p->loginstart = 0;
1952                                                 ast_mutex_unlock(&p->lock);
1953                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogoff",
1954                                                               "Agent: %s\r\n"
1955                                                               "Logintime: %ld\r\n"
1956                                                               "Uniqueid: %s\r\n",
1957                                                               p->agent, logintime, chan->uniqueid);
1958                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGOFF", "%s|%ld", chan->name, logintime);
1959                                                 if (option_verbose > 1)
1960                                                         ast_verbose(VERBOSE_PREFIX_2 "Agent '%s' logged out\n", p->agent);
1961                                                 /* If there is no owner, go ahead and kill it now */
1962                                                 ast_device_state_changed("Agent/%s", p->agent);
1963                                                 if (p->dead && !p->owner) {
1964                                                         ast_mutex_destroy(&p->lock);
1965                                                         ast_mutex_destroy(&p->app_lock);
1966                                                         ast_free(p);
1967                                                 }
1968                                         }
1969                                         else {
1970                                                 ast_mutex_unlock(&p->lock);
1971                                                 p = NULL;
1972                                         }
1973                                         res = -1;
1974                                 } else {
1975                                         ast_mutex_unlock(&p->lock);
1976                                         errmsg = "agent-alreadyon";
1977                                         p = NULL;
1978                                 }
1979                                 break;
1980                         }
1981                         ast_mutex_unlock(&p->lock);
1982                 }
1983                 if (!p)
1984                         AST_LIST_UNLOCK(&agents);
1985
1986                 if (!res && (max_login_tries==0 || tries < max_login_tries))
1987                         res = ast_app_getdata(chan, errmsg, user, sizeof(user) - 1, 0);
1988         }
1989                 
1990         if (!res)
1991                 res = ast_safe_sleep(chan, 500);
1992
1993         ast_module_user_remove(u);
1994         
1995         return -1;
1996 }
1997
1998 /*!
1999  *  \brief Called by the AgentMonitorOutgoing application (from the dial plan).
2000  *
2001  * \param chan
2002  * \param data
2003  * \returns
2004  * \sa login_exec(), load_module().
2005  */
2006 static int agentmonitoroutgoing_exec(struct ast_channel *chan, void *data)
2007 {
2008         int exitifnoagentid = 0;
2009         int nowarnings = 0;
2010         int changeoutgoing = 0;
2011         int res = 0;
2012         char agent[AST_MAX_AGENT];
2013
2014         if (data) {
2015                 if (strchr(data, 'd'))
2016                         exitifnoagentid = 1;
2017                 if (strchr(data, 'n'))
2018                         nowarnings = 1;
2019                 if (strchr(data, 'c'))
2020                         changeoutgoing = 1;
2021         }
2022         if (chan->cid.cid_num) {
2023                 const char *tmp;
2024                 char agentvar[AST_MAX_BUF];
2025                 snprintf(agentvar, sizeof(agentvar), "%s_%s", GETAGENTBYCALLERID, chan->cid.cid_num);
2026                 if ((tmp = pbx_builtin_getvar_helper(NULL, agentvar))) {
2027                         struct agent_pvt *p;
2028                         ast_copy_string(agent, tmp, sizeof(agent));
2029                         AST_LIST_LOCK(&agents);
2030                         AST_LIST_TRAVERSE(&agents, p, list) {
2031                                 if (!strcasecmp(p->agent, tmp)) {
2032                                         if (changeoutgoing) snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
2033                                         __agent_start_monitoring(chan, p, 1);
2034                                         break;
2035                                 }
2036                         }
2037                         AST_LIST_UNLOCK(&agents);
2038                         
2039                 } else {
2040                         res = -1;
2041                         if (!nowarnings)
2042                                 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);
2043                 }
2044         } else {
2045                 res = -1;
2046                 if (!nowarnings)
2047                         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");
2048         }
2049         if (res) {
2050                 if (exitifnoagentid)
2051                         return res;
2052         }
2053         return 0;
2054 }
2055
2056 /*!
2057  * \brief Dump AgentCallbackLogin agents to the ASTdb database for persistence
2058  */
2059 static void dump_agents(void)
2060 {
2061         struct agent_pvt *cur_agent = NULL;
2062         char buf[256];
2063
2064         AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2065                 if (cur_agent->chan)
2066                         continue;
2067
2068                 if (!ast_strlen_zero(cur_agent->loginchan)) {
2069                         snprintf(buf, sizeof(buf), "%s;%s", cur_agent->loginchan, cur_agent->logincallerid);
2070                         if (ast_db_put(pa_family, cur_agent->agent, buf))
2071                                 ast_log(LOG_WARNING, "failed to create persistent entry in ASTdb for %s!\n", buf);
2072                         else
2073                                 ast_debug(1, "Saved Agent: %s on %s\n", cur_agent->agent, cur_agent->loginchan);
2074                 } else {
2075                         /* Delete -  no agent or there is an error */
2076                         ast_db_del(pa_family, cur_agent->agent);
2077                 }
2078         }
2079 }
2080
2081 /*!
2082  * \brief Reload the persistent agents from astdb.
2083  */
2084 static void reload_agents(void)
2085 {
2086         char *agent_num;
2087         struct ast_db_entry *db_tree;
2088         struct ast_db_entry *entry;
2089         struct agent_pvt *cur_agent;
2090         char agent_data[256];
2091         char *parse;
2092         char *agent_chan;
2093         char *agent_callerid;
2094
2095         db_tree = ast_db_gettree(pa_family, NULL);
2096
2097         AST_LIST_LOCK(&agents);
2098         for (entry = db_tree; entry; entry = entry->next) {
2099                 agent_num = entry->key + strlen(pa_family) + 2;
2100                 AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2101                         ast_mutex_lock(&cur_agent->lock);
2102                         if (strcmp(agent_num, cur_agent->agent) == 0)
2103                                 break;
2104                         ast_mutex_unlock(&cur_agent->lock);
2105                 }
2106                 if (!cur_agent) {
2107                         ast_db_del(pa_family, agent_num);
2108                         continue;
2109                 } else
2110                         ast_mutex_unlock(&cur_agent->lock);
2111                 if (!ast_db_get(pa_family, agent_num, agent_data, sizeof(agent_data)-1)) {
2112                         ast_debug(1, "Reload Agent from AstDB: %s on %s\n", cur_agent->agent, agent_data);
2113                         parse = agent_data;
2114                         agent_chan = strsep(&parse, ";");
2115                         agent_callerid = strsep(&parse, ";");
2116                         ast_copy_string(cur_agent->loginchan, agent_chan, sizeof(cur_agent->loginchan));
2117                         if (agent_callerid) {
2118                                 ast_copy_string(cur_agent->logincallerid, agent_callerid, sizeof(cur_agent->logincallerid));
2119                                 set_agentbycallerid(cur_agent->logincallerid, cur_agent->agent);
2120                         } else
2121                                 cur_agent->logincallerid[0] = '\0';
2122                         if (cur_agent->loginstart == 0)
2123                                 time(&cur_agent->loginstart);
2124                         ast_device_state_changed("Agent/%s", cur_agent->agent); 
2125                 }
2126         }
2127         AST_LIST_UNLOCK(&agents);
2128         if (db_tree) {
2129                 ast_log(LOG_NOTICE, "Agents successfully reloaded from database.\n");
2130                 ast_db_freetree(db_tree);
2131         }
2132 }
2133
2134 /*! \brief Part of PBX channel interface */
2135 static int agent_devicestate(void *data)
2136 {
2137         struct agent_pvt *p;
2138         char *s;
2139         ast_group_t groupmatch;
2140         int groupoff;
2141         int waitforagent=0;
2142         int res = AST_DEVICE_INVALID;
2143         
2144         s = data;
2145         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1))
2146                 groupmatch = (1 << groupoff);
2147         else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
2148                 groupmatch = (1 << groupoff);
2149                 waitforagent = 1;
2150         } else 
2151                 groupmatch = 0;
2152
2153         /* Check actual logged in agents first */
2154         AST_LIST_LOCK(&agents);
2155         AST_LIST_TRAVERSE(&agents, p, list) {
2156                 ast_mutex_lock(&p->lock);
2157                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
2158                         if (p->owner) {
2159                                 if (res != AST_DEVICE_INUSE)
2160                                         res = AST_DEVICE_BUSY;
2161                         } else {
2162                                 if (res == AST_DEVICE_BUSY)
2163                                         res = AST_DEVICE_INUSE;
2164                                 if (p->chan || !ast_strlen_zero(p->loginchan)) {
2165                                         if (res == AST_DEVICE_INVALID)
2166                                                 res = AST_DEVICE_UNKNOWN;
2167                                 } else if (res == AST_DEVICE_INVALID)   
2168                                         res = AST_DEVICE_UNAVAILABLE;
2169                         }
2170                         if (!strcmp(data, p->agent)) {
2171                                 ast_mutex_unlock(&p->lock);
2172                                 break;
2173                         }
2174                 }
2175                 ast_mutex_unlock(&p->lock);
2176         }
2177         AST_LIST_UNLOCK(&agents);
2178         return res;
2179 }
2180
2181 static struct agent_pvt *find_agent(char *agentid)
2182 {
2183         struct agent_pvt *cur;
2184
2185         AST_LIST_TRAVERSE(&agents, cur, list) {
2186                 if (!strcmp(cur->agent, agentid))
2187                         break;  
2188         }
2189
2190         return cur;     
2191 }
2192
2193 static int function_agent(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
2194 {
2195         char *parse;    
2196         AST_DECLARE_APP_ARGS(args,
2197                 AST_APP_ARG(agentid);
2198                 AST_APP_ARG(item);
2199         );
2200         char *tmp;
2201         struct agent_pvt *agent;
2202
2203         buf[0] = '\0';
2204
2205         if (ast_strlen_zero(data)) {
2206                 ast_log(LOG_WARNING, "The AGENT function requires an argument - agentid!\n");
2207                 return -1;
2208         }
2209
2210         parse = ast_strdupa(data);
2211
2212         AST_NONSTANDARD_APP_ARGS(args, parse, ':');
2213         if (!args.item)
2214                 args.item = "status";
2215
2216         if (!(agent = find_agent(args.agentid))) {
2217                 ast_log(LOG_WARNING, "Agent '%s' not found!\n", args.agentid);
2218                 return -1;
2219         }
2220
2221         if (!strcasecmp(args.item, "status")) {
2222                 char *status = "LOGGEDOUT";
2223                 if (agent->chan || !ast_strlen_zero(agent->loginchan)) 
2224                         status = "LOGGEDIN";    
2225                 ast_copy_string(buf, status, len);
2226         } else if (!strcasecmp(args.item, "password")) 
2227                 ast_copy_string(buf, agent->password, len);
2228         else if (!strcasecmp(args.item, "name"))
2229                 ast_copy_string(buf, agent->name, len);
2230         else if (!strcasecmp(args.item, "mohclass"))
2231                 ast_copy_string(buf, agent->moh, len);
2232         else if (!strcasecmp(args.item, "channel")) {
2233                 if (agent->chan) {
2234                         ast_copy_string(buf, agent->chan->name, len);
2235                         tmp = strrchr(buf, '-');
2236                         if (tmp)
2237                                 *tmp = '\0';
2238                 } 
2239         } else if (!strcasecmp(args.item, "exten"))
2240                 ast_copy_string(buf, agent->loginchan, len);    
2241
2242         return 0;
2243 }
2244
2245 struct ast_custom_function agent_function = {
2246         .name = "AGENT",
2247         .synopsis = "Gets information about an Agent",
2248         .syntax = "AGENT(<agentid>[:item])",
2249         .read = function_agent,
2250         .desc = "The valid items to retrieve are:\n"
2251         "- status (default)      The status of the agent\n"
2252         "                          LOGGEDIN | LOGGEDOUT\n"
2253         "- password              The password of the agent\n"
2254         "- name                  The name of the agent\n"
2255         "- mohclass              MusicOnHold class\n"
2256         "- exten                 The callback extension for the Agent (AgentCallbackLogin)\n"
2257         "- channel               The name of the active channel for the Agent (AgentLogin)\n"
2258 };
2259
2260
2261 /*!
2262  * \brief Initialize the Agents module.
2263  * This function is being called by Asterisk when loading the module. 
2264  * Among other things it registers applications, cli commands and reads the cofiguration file.
2265  *
2266  * \returns int Always 0.
2267  */
2268 static int load_module(void)
2269 {
2270         /* Make sure we can register our agent channel type */
2271         if (ast_channel_register(&agent_tech)) {
2272                 ast_log(LOG_ERROR, "Unable to register channel class 'Agent'\n");
2273                 return -1;
2274         }
2275         /* Read in the config */
2276         if (!read_agent_config())
2277                 return AST_MODULE_LOAD_DECLINE;
2278         if (persistent_agents)
2279                 reload_agents();
2280         /* Dialplan applications */
2281         ast_register_application(app, login_exec, synopsis, descrip);
2282         ast_register_application(app3, agentmonitoroutgoing_exec, synopsis3, descrip3);
2283
2284         /* Manager commands */
2285         ast_manager_register2("Agents", EVENT_FLAG_AGENT, action_agents, "Lists agents and their status", mandescr_agents);
2286         ast_manager_register2("AgentLogoff", EVENT_FLAG_AGENT, action_agent_logoff, "Sets an agent as no longer logged in", mandescr_agent_logoff);
2287
2288         /* CLI Commands */
2289         ast_cli_register_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2290
2291         /* Dialplan Functions */
2292         ast_custom_function_register(&agent_function);
2293
2294         return 0;
2295 }
2296
2297 static int reload(void)
2298 {
2299         read_agent_config();
2300         if (persistent_agents)
2301                 reload_agents();
2302         return 0;
2303 }
2304
2305 static int unload_module(void)
2306 {
2307         struct agent_pvt *p;
2308         /* First, take us out of the channel loop */
2309         ast_channel_unregister(&agent_tech);
2310         /* Unregister dialplan functions */
2311         ast_custom_function_unregister(&agent_function);        
2312         /* Unregister CLI commands */
2313         ast_cli_unregister_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2314         /* Unregister dialplan applications */
2315         ast_unregister_application(app);
2316         ast_unregister_application(app3);
2317         /* Unregister manager command */
2318         ast_manager_unregister("Agents");
2319         ast_manager_unregister("AgentLogoff");
2320         /* Unregister channel */
2321         AST_LIST_LOCK(&agents);
2322         /* Hangup all interfaces if they have an owner */
2323         while ((p = AST_LIST_REMOVE_HEAD(&agents, list))) {
2324                 if (p->owner)
2325                         ast_softhangup(p->owner, AST_SOFTHANGUP_APPUNLOAD);
2326                 ast_free(p);
2327         }
2328         AST_LIST_UNLOCK(&agents);
2329         AST_LIST_HEAD_DESTROY(&agents);
2330         return 0;
2331 }
2332
2333 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Agent Proxy Channel",
2334                 .load = load_module,
2335                 .unload = unload_module,
2336                 .reload = reload,
2337                );