6b3db5c93eb6f410098341aae20e7b44bd9e5496
[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 && !p->chan->generator)  \
195                         ast_set_read_format(p->chan, ast->rawreadformat); \
196                 if (p->chan->writeformat != ast->rawwriteformat && !p->chan->generator) \
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, filename);
394                 ast_monitor_start(ast, recordformat, tmp, needlock, X_REC_IN | X_REC_OUT);
395                 ast_monitor_setjoinfiles(ast, 1);
396                 snprintf(tmp2, sizeof(tmp2), "%s%s.%s", 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                                         ast_verb(3, "%s answered, waiting for '#' to acknowledge\n", p->chan->name);
462                                         /* Don't pass answer along */
463                                         ast_frfree(f);
464                                         f = &ast_null_frame;
465                                 } else {
466                                         p->acknowledged = 1;
467                                         /* Use the builtin answer frame for the 
468                                            recording start check below. */
469                                         ast_frfree(f);
470                                         f = &answer_frame;
471                                 }
472                         }
473                         break;
474                 case AST_FRAME_DTMF_BEGIN:
475                 case AST_FRAME_DTMF_END:
476                         if (!p->acknowledged && (f->subclass == '#')) {
477                                 ast_verb(3, "%s acknowledged\n", p->chan->name);
478                                 p->acknowledged = 1;
479                                 ast_frfree(f);
480                                 f = &answer_frame;
481                         } else if (f->subclass == '*' && endcall) {
482                                 /* terminates call */
483                                 ast_frfree(f);
484                                 f = NULL;
485                         }
486                         break;
487                 case AST_FRAME_VOICE:
488                 case AST_FRAME_VIDEO:
489                         /* don't pass voice or video until the call is acknowledged */
490                         if (!p->acknowledged) {
491                                 ast_frfree(f);
492                                 f = &ast_null_frame;
493                         }
494                 default:
495                         /* pass everything else on through */
496                         break;
497                 }
498         }
499
500         CLEANUP(ast,p);
501         if (p->chan && !p->chan->_bridge) {
502                 if (strcasecmp(p->chan->tech->type, "Local")) {
503                         p->chan->_bridge = ast;
504                         if (p->chan)
505                                 ast_debug(1, "Bridge on '%s' being set to '%s' (3)\n", p->chan->name, p->chan->_bridge->name);
506                 }
507         }
508         ast_mutex_unlock(&p->lock);
509         if (recordagentcalls && f == &answer_frame)
510                 agent_start_monitoring(ast,0);
511         return f;
512 }
513
514 static int agent_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen)
515 {
516         struct agent_pvt *p = ast->tech_pvt;
517         int res = -1;
518         ast_mutex_lock(&p->lock);
519         if (p->chan) 
520                 res = ast_channel_sendhtml(p->chan, subclass, data, datalen);
521         ast_mutex_unlock(&p->lock);
522         return res;
523 }
524
525 static int agent_sendtext(struct ast_channel *ast, const char *text)
526 {
527         struct agent_pvt *p = ast->tech_pvt;
528         int res = -1;
529         ast_mutex_lock(&p->lock);
530         if (p->chan) 
531                 res = ast_sendtext(p->chan, text);
532         ast_mutex_unlock(&p->lock);
533         return res;
534 }
535
536 static int agent_write(struct ast_channel *ast, struct ast_frame *f)
537 {
538         struct agent_pvt *p = ast->tech_pvt;
539         int res = -1;
540         CHECK_FORMATS(ast, p);
541         ast_mutex_lock(&p->lock);
542         if (!p->chan) 
543                 res = 0;
544         else {
545                 if ((f->frametype != AST_FRAME_VOICE) ||
546                     (f->frametype != AST_FRAME_VIDEO) ||
547                     (f->subclass == p->chan->writeformat)) {
548                         res = ast_write(p->chan, f);
549                 } else {
550                         ast_debug(1, "Dropping one incompatible %s frame on '%s' to '%s'\n", 
551                                 f->frametype == AST_FRAME_VOICE ? "audio" : "video",
552                                 ast->name, p->chan->name);
553                         res = 0;
554                 }
555         }
556         CLEANUP(ast, p);
557         ast_mutex_unlock(&p->lock);
558         return res;
559 }
560
561 static int agent_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
562 {
563         struct agent_pvt *p = newchan->tech_pvt;
564         ast_mutex_lock(&p->lock);
565         if (p->owner != oldchan) {
566                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
567                 ast_mutex_unlock(&p->lock);
568                 return -1;
569         }
570         p->owner = newchan;
571         ast_mutex_unlock(&p->lock);
572         return 0;
573 }
574
575 static int agent_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen)
576 {
577         struct agent_pvt *p = ast->tech_pvt;
578         int res = -1;
579         ast_mutex_lock(&p->lock);
580         if (p->chan)
581                 res = p->chan->tech->indicate ? p->chan->tech->indicate(p->chan, condition, data, datalen) : -1;
582         else
583                 res = 0;
584         ast_mutex_unlock(&p->lock);
585         return res;
586 }
587
588 static int agent_digit_begin(struct ast_channel *ast, char digit)
589 {
590         struct agent_pvt *p = ast->tech_pvt;
591         ast_mutex_lock(&p->lock);
592         ast_senddigit_begin(p->chan, digit);
593         ast_mutex_unlock(&p->lock);
594         return 0;
595 }
596
597 static int agent_digit_end(struct ast_channel *ast, char digit, unsigned int duration)
598 {
599         struct agent_pvt *p = ast->tech_pvt;
600         ast_mutex_lock(&p->lock);
601         ast_senddigit_end(p->chan, digit, duration);
602         ast_mutex_unlock(&p->lock);
603         return 0;
604 }
605
606 static int agent_call(struct ast_channel *ast, char *dest, int timeout)
607 {
608         struct agent_pvt *p = ast->tech_pvt;
609         int res = -1;
610         int newstate=0;
611         ast_mutex_lock(&p->lock);
612         p->acknowledged = 0;
613         if (!p->chan) {
614                 if (p->pending) {
615                         ast_debug(1, "Pretending to dial on pending agent\n");
616                         newstate = AST_STATE_DIALING;
617                         res = 0;
618                 } else {
619                         ast_log(LOG_NOTICE, "Whoa, they hung up between alloc and call...  what are the odds of that?\n");
620                         res = -1;
621                 }
622                 ast_mutex_unlock(&p->lock);
623                 if (newstate)
624                         ast_setstate(ast, newstate);
625                 return res;
626         } else if (!ast_strlen_zero(p->loginchan)) {
627                 time(&p->start);
628                 /* Call on this agent */
629                 ast_verb(3, "outgoing agentcall, to agent '%s', on '%s'\n", p->agent, p->chan->name);
630                 ast_set_callerid(p->chan,
631                         ast->cid.cid_num, ast->cid.cid_name, NULL);
632                 ast_channel_inherit_variables(ast, p->chan);
633                 res = ast_call(p->chan, p->loginchan, 0);
634                 CLEANUP(ast,p);
635                 ast_mutex_unlock(&p->lock);
636                 return res;
637         }
638         ast_verb(3, "agent_call, call to agent '%s' call on '%s'\n", p->agent, p->chan->name);
639         ast_debug(3, "Playing beep, lang '%s'\n", p->chan->language);
640         res = ast_streamfile(p->chan, beep, p->chan->language);
641         ast_debug(3, "Played beep, result '%d'\n", res);
642         if (!res) {
643                 res = ast_waitstream(p->chan, "");
644                 ast_debug(3, "Waited for stream, result '%d'\n", res);
645         }
646         if (!res) {
647                 res = ast_set_read_format(p->chan, ast_best_codec(p->chan->nativeformats));
648                 ast_debug(3, "Set read format, result '%d'\n", res);
649                 if (res)
650                         ast_log(LOG_WARNING, "Unable to set read format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
651         } else {
652                 /* Agent hung-up */
653                 p->chan = NULL;
654         }
655
656         if (!res) {
657                 res = ast_set_write_format(p->chan, ast_best_codec(p->chan->nativeformats));
658                 ast_debug(3, "Set write format, result '%d'\n", res);
659                 if (res)
660                         ast_log(LOG_WARNING, "Unable to set write format to %s\n", ast_getformatname(ast_best_codec(p->chan->nativeformats)));
661         }
662         if(!res) {
663                 /* Call is immediately up, or might need ack */
664                 if (p->ackcall > 1)
665                         newstate = AST_STATE_RINGING;
666                 else {
667                         newstate = AST_STATE_UP;
668                         if (recordagentcalls)
669                                 agent_start_monitoring(ast, 0);
670                         p->acknowledged = 1;
671                 }
672                 res = 0;
673         }
674         CLEANUP(ast, p);
675         ast_mutex_unlock(&p->lock);
676         if (newstate)
677                 ast_setstate(ast, newstate);
678         return res;
679 }
680
681 /*! \brief store/clear the global variable that stores agentid based on the callerid */
682 static void set_agentbycallerid(const char *callerid, const char *agent)
683 {
684         char buf[AST_MAX_BUF];
685
686         /* if there is no Caller ID, nothing to do */
687         if (ast_strlen_zero(callerid))
688                 return;
689
690         snprintf(buf, sizeof(buf), "%s_%s", GETAGENTBYCALLERID, callerid);
691         pbx_builtin_setvar_helper(NULL, buf, agent);
692 }
693
694 static int agent_hangup(struct ast_channel *ast)
695 {
696         struct agent_pvt *p = ast->tech_pvt;
697         int howlong = 0;
698         const char *status;
699         ast_mutex_lock(&p->lock);
700         p->owner = NULL;
701         ast->tech_pvt = NULL;
702         p->app_sleep_cond = 1;
703         p->acknowledged = 0;
704
705         /* if they really are hung up then set start to 0 so the test
706          * later if we're called on an already downed channel
707          * doesn't cause an agent to be logged out like when
708          * agent_request() is followed immediately by agent_hangup()
709          * as in apps/app_chanisavail.c:chanavail_exec()
710          */
711
712         ast_debug(1, "Hangup called for state %s\n", ast_state2str(ast->_state));
713         if (p->start && (ast->_state != AST_STATE_UP)) {
714                 howlong = time(NULL) - p->start;
715                 p->start = 0;
716         } else if (ast->_state == AST_STATE_RESERVED) 
717                 howlong = 0;
718         else
719                 p->start = 0; 
720         if (p->chan) {
721                 p->chan->_bridge = NULL;
722                 /* If they're dead, go ahead and hang up on the agent now */
723                 if (!ast_strlen_zero(p->loginchan)) {
724                         /* Store last disconnect time */
725                         if (p->wrapuptime)
726                                 p->lastdisc = ast_tvadd(ast_tvnow(), ast_samp2tv(p->wrapuptime, 1000));
727                         else
728                                 p->lastdisc = ast_tv(0,0);
729                         if (p->chan) {
730                                 status = pbx_builtin_getvar_helper(p->chan, "CHANLOCALSTATUS");
731                                 if (autologoffunavail && status && !strcasecmp(status, "CHANUNAVAIL")) {
732                                         long logintime = time(NULL) - p->loginstart;
733                                         p->loginstart = 0;
734                                         ast_log(LOG_NOTICE, "Agent hangup: '%s' is not available now, auto logoff\n", p->name);
735                                         agent_logoff_maintenance(p, p->loginchan, logintime, ast->uniqueid, "Chanunavail");
736                                 }
737                                 /* Recognize the hangup and pass it along immediately */
738                                 ast_hangup(p->chan);
739                                 p->chan = NULL;
740                         }
741                         ast_debug(1, "Hungup, howlong is %d, autologoff is %d\n", howlong, p->autologoff);
742                         if ((p->deferlogoff) || (howlong && p->autologoff && (howlong > p->autologoff))) {
743                                 long logintime = time(NULL) - p->loginstart;
744                                 p->loginstart = 0;
745                                 if (!p->deferlogoff)
746                                         ast_log(LOG_NOTICE, "Agent '%s' didn't answer/confirm within %d seconds (waited %d)\n", p->name, p->autologoff, howlong);
747                                 p->deferlogoff = 0;
748                                 agent_logoff_maintenance(p, p->loginchan, logintime, ast->uniqueid, "Autologoff");
749                                 if (persistent_agents)
750                                         dump_agents();
751                         }
752                 } else if (p->dead) {
753                         ast_channel_lock(p->chan);
754                         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
755                         ast_channel_unlock(p->chan);
756                 } else if (p->loginstart) {
757                         ast_channel_lock(p->chan);
758                         ast_indicate_data(p->chan, AST_CONTROL_HOLD, 
759                                 S_OR(p->moh, NULL),
760                                 !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
761                         ast_channel_unlock(p->chan);
762                 }
763         }
764         ast_mutex_unlock(&p->lock);
765
766         /* Only register a device state change if the agent is still logged in */
767         if (!p->loginstart) {
768                 p->loginchan[0] = '\0';
769                 p->logincallerid[0] = '\0';
770                 if (persistent_agents)
771                         dump_agents();
772         } else {
773                 ast_device_state_changed("Agent/%s", p->agent);
774         }
775
776         if (p->pending) {
777                 AST_LIST_LOCK(&agents);
778                 AST_LIST_REMOVE(&agents, p, list);
779                 AST_LIST_UNLOCK(&agents);
780         }
781         if (p->abouttograb) {
782                 /* Let the "about to grab" thread know this isn't valid anymore, and let it
783                    kill it later */
784                 p->abouttograb = 0;
785         } else if (p->dead) {
786                 ast_mutex_destroy(&p->lock);
787                 ast_mutex_destroy(&p->app_lock);
788                 ast_free(p);
789         } else {
790                 if (p->chan) {
791                         /* Not dead -- check availability now */
792                         ast_mutex_lock(&p->lock);
793                         /* Store last disconnect time */
794                         p->lastdisc = ast_tvadd(ast_tvnow(), ast_samp2tv(p->wrapuptime, 1000));
795                         ast_mutex_unlock(&p->lock);
796                 }
797                 /* Release ownership of the agent to other threads (presumably running the login app). */
798                 if (ast_strlen_zero(p->loginchan))
799                         ast_mutex_unlock(&p->app_lock);
800         }
801         return 0;
802 }
803
804 static int agent_cont_sleep( void *data )
805 {
806         struct agent_pvt *p;
807         int res;
808
809         p = (struct agent_pvt *)data;
810
811         ast_mutex_lock(&p->lock);
812         res = p->app_sleep_cond;
813         if (p->lastdisc.tv_sec) {
814                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0) 
815                         res = 1;
816         }
817         ast_mutex_unlock(&p->lock);
818
819         if (!res)
820                 ast_debug(5, "agent_cont_sleep() returning %d\n", res );
821
822         return res;
823 }
824
825 static int agent_ack_sleep(void *data)
826 {
827         struct agent_pvt *p;
828         int res=0;
829         int to = 1000;
830         struct ast_frame *f;
831
832         /* Wait a second and look for something */
833
834         p = (struct agent_pvt *) data;
835         if (!p->chan) 
836                 return -1;
837
838         for(;;) {
839                 to = ast_waitfor(p->chan, to);
840                 if (to < 0) 
841                         return -1;
842                 if (!to) 
843                         return 0;
844                 f = ast_read(p->chan);
845                 if (!f) 
846                         return -1;
847                 if (f->frametype == AST_FRAME_DTMF)
848                         res = f->subclass;
849                 else
850                         res = 0;
851                 ast_frfree(f);
852                 ast_mutex_lock(&p->lock);
853                 if (!p->app_sleep_cond) {
854                         ast_mutex_unlock(&p->lock);
855                         return 0;
856                 } else if (res == '#') {
857                         ast_mutex_unlock(&p->lock);
858                         return 1;
859                 }
860                 ast_mutex_unlock(&p->lock);
861                 res = 0;
862         }
863         return res;
864 }
865
866 static struct ast_channel *agent_bridgedchannel(struct ast_channel *chan, struct ast_channel *bridge)
867 {
868         struct agent_pvt *p = bridge->tech_pvt;
869         struct ast_channel *ret = NULL;
870
871         if (p) {
872                 if (chan == p->chan)
873                         ret = bridge->_bridge;
874                 else if (chan == bridge->_bridge)
875                         ret = p->chan;
876         }
877
878         ast_debug(1, "Asked for bridged channel on '%s'/'%s', returning '%s'\n", chan->name, bridge->name, ret ? ret->name : "<none>");
879         return ret;
880 }
881
882 /*! \brief Create new agent channel */
883 static struct ast_channel *agent_new(struct agent_pvt *p, int state)
884 {
885         struct ast_channel *tmp;
886 #if 0
887         if (!p->chan) {
888                 ast_log(LOG_WARNING, "No channel? :(\n");
889                 return NULL;
890         }
891 #endif  
892         if (p->pending)
893                 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);
894         else
895                 tmp = ast_channel_alloc(0, state, 0, 0, "", p->chan ? p->chan->exten:"", p->chan ? p->chan->context:"", 0, "Agent/%s", p->agent);
896         if (!tmp) {
897                 ast_log(LOG_WARNING, "Unable to allocate agent channel structure\n");
898                 return NULL;
899         }
900
901         tmp->tech = &agent_tech;
902         if (p->chan) {
903                 tmp->nativeformats = p->chan->nativeformats;
904                 tmp->writeformat = p->chan->writeformat;
905                 tmp->rawwriteformat = p->chan->writeformat;
906                 tmp->readformat = p->chan->readformat;
907                 tmp->rawreadformat = p->chan->readformat;
908                 ast_string_field_set(tmp, language, p->chan->language);
909                 ast_copy_string(tmp->context, p->chan->context, sizeof(tmp->context));
910                 ast_copy_string(tmp->exten, p->chan->exten, sizeof(tmp->exten));
911                 /* XXX Is this really all we copy form the originating channel?? */
912         } else {
913                 tmp->nativeformats = AST_FORMAT_SLINEAR;
914                 tmp->writeformat = AST_FORMAT_SLINEAR;
915                 tmp->rawwriteformat = AST_FORMAT_SLINEAR;
916                 tmp->readformat = AST_FORMAT_SLINEAR;
917                 tmp->rawreadformat = AST_FORMAT_SLINEAR;
918         }
919         /* Safe, agentlock already held */
920         tmp->tech_pvt = p;
921         p->owner = tmp;
922         tmp->priority = 1;
923         /* Wake up and wait for other applications (by definition the login app)
924          * to release this channel). Takes ownership of the agent channel
925          * to this thread only.
926          * For signalling the other thread, ast_queue_frame is used until we
927          * can safely use signals for this purpose. The pselect() needs to be
928          * implemented in the kernel for this.
929          */
930         p->app_sleep_cond = 0;
931         if(ast_strlen_zero(p->loginchan) && ast_mutex_trylock(&p->app_lock)) {
932                 if (p->chan) {
933                         ast_queue_frame(p->chan, &ast_null_frame);
934                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
935                         ast_mutex_lock(&p->app_lock);
936                         ast_mutex_lock(&p->lock);
937                 } else {
938                         ast_log(LOG_WARNING, "Agent disconnected while we were connecting the call\n");
939                         p->owner = NULL;
940                         tmp->tech_pvt = NULL;
941                         p->app_sleep_cond = 1;
942                         ast_channel_free( tmp );
943                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
944                         ast_mutex_unlock(&p->app_lock);
945                         return NULL;
946                 }
947         } else if (!ast_strlen_zero(p->loginchan)) {
948                 if (p->chan)
949                         ast_queue_frame(p->chan, &ast_null_frame);
950                 if (!p->chan) {
951                         ast_log(LOG_WARNING, "Agent disconnected while we were connecting the call\n");
952                         p->owner = NULL;
953                         tmp->tech_pvt = NULL;
954                         p->app_sleep_cond = 1;
955                         ast_channel_free( tmp );
956                         ast_mutex_unlock(&p->lock);     /* For other thread to read the condition. */
957                         return NULL;
958                 }       
959         } 
960         if (p->chan)
961                 ast_indicate(p->chan, AST_CONTROL_UNHOLD);
962         p->owning_app = pthread_self();
963         /* After the above step, there should not be any blockers. */
964         if (p->chan) {
965                 if (ast_test_flag(p->chan, AST_FLAG_BLOCKING)) {
966                         ast_log( LOG_ERROR, "A blocker exists after agent channel ownership acquired\n" );
967                         CRASH;
968                 }
969         }
970         return tmp;
971 }
972
973
974 /*!
975  * Read configuration data. The file named agents.conf.
976  *
977  * \returns Always 0, or so it seems.
978  */
979 static int read_agent_config(void)
980 {
981         struct ast_config *cfg;
982         struct ast_config *ucfg;
983         struct ast_variable *v;
984         struct agent_pvt *p;
985         const char *general_val;
986         const char *catname;
987         const char *hasagent;
988         int genhasagent;
989
990         group = 0;
991         autologoff = 0;
992         wrapuptime = 0;
993         ackcall = 0;
994         endcall = 1;
995         cfg = ast_config_load(config);
996         if (!cfg) {
997                 ast_log(LOG_NOTICE, "No agent configuration found -- agent support disabled\n");
998                 return 0;
999         }
1000         AST_LIST_LOCK(&agents);
1001         AST_LIST_TRAVERSE(&agents, p, list) {
1002                 p->dead = 1;
1003         }
1004         strcpy(moh, "default");
1005         /* set the default recording values */
1006         recordagentcalls = 0;
1007         strcpy(recordformat, "wav");
1008         strcpy(recordformatext, "wav");
1009         urlprefix[0] = '\0';
1010         savecallsin[0] = '\0';
1011
1012         /* Read in [general] section for persistence */
1013         if ((general_val = ast_variable_retrieve(cfg, "general", "persistentagents")))
1014                 persistent_agents = ast_true(general_val);
1015         multiplelogin = ast_true(ast_variable_retrieve(cfg, "general", "multiplelogin"));
1016
1017         /* Read in the [agents] section */
1018         v = ast_variable_browse(cfg, "agents");
1019         while(v) {
1020                 /* Create the interface list */
1021                 if (!strcasecmp(v->name, "agent")) {
1022                         add_agent(v->value, 0);
1023                 } else if (!strcasecmp(v->name, "group")) {
1024                         group = ast_get_group(v->value);
1025                 } else if (!strcasecmp(v->name, "autologoff")) {
1026                         autologoff = atoi(v->value);
1027                         if (autologoff < 0)
1028                                 autologoff = 0;
1029                 } else if (!strcasecmp(v->name, "ackcall")) {
1030                         if (!strcasecmp(v->value, "always"))
1031                                 ackcall = 2;
1032                         else if (ast_true(v->value))
1033                                 ackcall = 1;
1034                         else
1035                                 ackcall = 0;
1036                 } else if (!strcasecmp(v->name, "endcall")) {
1037                         endcall = ast_true(v->value);
1038                 } else if (!strcasecmp(v->name, "wrapuptime")) {
1039                         wrapuptime = atoi(v->value);
1040                         if (wrapuptime < 0)
1041                                 wrapuptime = 0;
1042                 } else if (!strcasecmp(v->name, "maxlogintries") && !ast_strlen_zero(v->value)) {
1043                         maxlogintries = atoi(v->value);
1044                         if (maxlogintries < 0)
1045                                 maxlogintries = 0;
1046                 } else if (!strcasecmp(v->name, "goodbye") && !ast_strlen_zero(v->value)) {
1047                         strcpy(agentgoodbye,v->value);
1048                 } else if (!strcasecmp(v->name, "musiconhold")) {
1049                         ast_copy_string(moh, v->value, sizeof(moh));
1050                 } else if (!strcasecmp(v->name, "updatecdr")) {
1051                         if (ast_true(v->value))
1052                                 updatecdr = 1;
1053                         else
1054                                 updatecdr = 0;
1055                 } else if (!strcasecmp(v->name, "autologoffunavail")) {
1056                         if (ast_true(v->value))
1057                                 autologoffunavail = 1;
1058                         else
1059                                 autologoffunavail = 0;
1060                 } else if (!strcasecmp(v->name, "recordagentcalls")) {
1061                         recordagentcalls = ast_true(v->value);
1062                 } else if (!strcasecmp(v->name, "recordformat")) {
1063                         ast_copy_string(recordformat, v->value, sizeof(recordformat));
1064                         if (!strcasecmp(v->value, "wav49"))
1065                                 strcpy(recordformatext, "WAV");
1066                         else
1067                                 ast_copy_string(recordformatext, v->value, sizeof(recordformatext));
1068                 } else if (!strcasecmp(v->name, "urlprefix")) {
1069                         ast_copy_string(urlprefix, v->value, sizeof(urlprefix));
1070                         if (urlprefix[strlen(urlprefix) - 1] != '/')
1071                                 strncat(urlprefix, "/", sizeof(urlprefix) - strlen(urlprefix) - 1);
1072                 } else if (!strcasecmp(v->name, "savecallsin")) {
1073                         if (v->value[0] == '/')
1074                                 ast_copy_string(savecallsin, v->value, sizeof(savecallsin));
1075                         else
1076                                 snprintf(savecallsin, sizeof(savecallsin) - 2, "/%s", v->value);
1077                         if (savecallsin[strlen(savecallsin) - 1] != '/')
1078                                 strncat(savecallsin, "/", sizeof(savecallsin) - strlen(savecallsin) - 1);
1079                 } else if (!strcasecmp(v->name, "custom_beep")) {
1080                         ast_copy_string(beep, v->value, sizeof(beep));
1081                 }
1082                 v = v->next;
1083         }
1084         if ((ucfg = ast_config_load("users.conf"))) {
1085                 genhasagent = ast_true(ast_variable_retrieve(ucfg, "general", "hasagent"));
1086                 catname = ast_category_browse(ucfg, NULL);
1087                 while(catname) {
1088                         if (strcasecmp(catname, "general")) {
1089                                 hasagent = ast_variable_retrieve(ucfg, catname, "hasagent");
1090                                 if (ast_true(hasagent) || (!hasagent && genhasagent)) {
1091                                         char tmp[256];
1092                                         const char *fullname = ast_variable_retrieve(ucfg, catname, "fullname");
1093                                         const char *secret = ast_variable_retrieve(ucfg, catname, "secret");
1094                                         if (!fullname)
1095                                                 fullname = "";
1096                                         if (!secret)
1097                                                 secret = "";
1098                                         snprintf(tmp, sizeof(tmp), "%s,%s,%s", catname, secret,fullname);
1099                                         add_agent(tmp, 0);
1100                                 }
1101                         }
1102                         catname = ast_category_browse(ucfg, catname);
1103                 }
1104                 ast_config_destroy(ucfg);
1105         }
1106         AST_LIST_TRAVERSE_SAFE_BEGIN(&agents, p, list) {
1107                 if (p->dead) {
1108                         AST_LIST_REMOVE_CURRENT(&agents, list);
1109                         /* Destroy if  appropriate */
1110                         if (!p->owner) {
1111                                 if (!p->chan) {
1112                                         ast_mutex_destroy(&p->lock);
1113                                         ast_mutex_destroy(&p->app_lock);
1114                                         ast_free(p);
1115                                 } else {
1116                                         /* Cause them to hang up */
1117                                         ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1118                                 }
1119                         }
1120                 }
1121         }
1122         AST_LIST_TRAVERSE_SAFE_END
1123         AST_LIST_UNLOCK(&agents);
1124         ast_config_destroy(cfg);
1125         return 1;
1126 }
1127
1128 static int check_availability(struct agent_pvt *newlyavailable, int needlock)
1129 {
1130         struct ast_channel *chan=NULL, *parent=NULL;
1131         struct agent_pvt *p;
1132         int res;
1133
1134         ast_debug(1, "Checking availability of '%s'\n", newlyavailable->agent);
1135         if (needlock)
1136                 AST_LIST_LOCK(&agents);
1137         AST_LIST_TRAVERSE(&agents, p, list) {
1138                 if (p == newlyavailable) {
1139                         continue;
1140                 }
1141                 ast_mutex_lock(&p->lock);
1142                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1143                         ast_debug(1, "Call '%s' looks like a winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1144                         /* We found a pending call, time to merge */
1145                         chan = agent_new(newlyavailable, AST_STATE_DOWN);
1146                         parent = p->owner;
1147                         p->abouttograb = 1;
1148                         ast_mutex_unlock(&p->lock);
1149                         break;
1150                 }
1151                 ast_mutex_unlock(&p->lock);
1152         }
1153         if (needlock)
1154                 AST_LIST_UNLOCK(&agents);
1155         if (parent && chan)  {
1156                 if (newlyavailable->ackcall > 1) {
1157                         /* Don't do beep here */
1158                         res = 0;
1159                 } else {
1160                         ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1161                         res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1162                         ast_debug(3, "Played beep, result '%d'\n", res);
1163                         if (!res) {
1164                                 res = ast_waitstream(newlyavailable->chan, "");
1165                                 ast_debug(1, "Waited for stream, result '%d'\n", res);
1166                         }
1167                 }
1168                 if (!res) {
1169                         /* Note -- parent may have disappeared */
1170                         if (p->abouttograb) {
1171                                 newlyavailable->acknowledged = 1;
1172                                 /* Safe -- agent lock already held */
1173                                 ast_setstate(parent, AST_STATE_UP);
1174                                 ast_setstate(chan, AST_STATE_UP);
1175                                 ast_copy_string(parent->context, chan->context, sizeof(parent->context));
1176                                 /* Go ahead and mark the channel as a zombie so that masquerade will
1177                                    destroy it for us, and we need not call ast_hangup */
1178                                 ast_mutex_lock(&parent->lock);
1179                                 ast_set_flag(chan, AST_FLAG_ZOMBIE);
1180                                 ast_channel_masquerade(parent, chan);
1181                                 ast_mutex_unlock(&parent->lock);
1182                                 p->abouttograb = 0;
1183                         } else {
1184                                 ast_debug(1, "Sneaky, parent disappeared in the mean time...\n");
1185                                 agent_cleanup(newlyavailable);
1186                         }
1187                 } else {
1188                         ast_debug(1, "Ugh...  Agent hung up at exactly the wrong time\n");
1189                         agent_cleanup(newlyavailable);
1190                 }
1191         }
1192         return 0;
1193 }
1194
1195 static int check_beep(struct agent_pvt *newlyavailable, int needlock)
1196 {
1197         struct agent_pvt *p;
1198         int res=0;
1199
1200         ast_debug(1, "Checking beep availability of '%s'\n", newlyavailable->agent);
1201         if (needlock)
1202                 AST_LIST_LOCK(&agents);
1203         AST_LIST_TRAVERSE(&agents, p, list) {
1204                 if (p == newlyavailable) {
1205                         continue;
1206                 }
1207                 ast_mutex_lock(&p->lock);
1208                 if (!p->abouttograb && p->pending && ((p->group && (newlyavailable->group & p->group)) || !strcmp(p->agent, newlyavailable->agent))) {
1209                         ast_debug(1, "Call '%s' looks like a would-be winner for agent '%s'\n", p->owner->name, newlyavailable->agent);
1210                         ast_mutex_unlock(&p->lock);
1211                         break;
1212                 }
1213                 ast_mutex_unlock(&p->lock);
1214         }
1215         if (needlock)
1216                 AST_LIST_UNLOCK(&agents);
1217         if (p) {
1218                 ast_mutex_unlock(&newlyavailable->lock);
1219                 ast_debug(3, "Playing beep, lang '%s'\n", newlyavailable->chan->language);
1220                 res = ast_streamfile(newlyavailable->chan, beep, newlyavailable->chan->language);
1221                 ast_debug(1, "Played beep, result '%d'\n", res);
1222                 if (!res) {
1223                         res = ast_waitstream(newlyavailable->chan, "");
1224                         ast_debug(1, "Waited for stream, result '%d'\n", res);
1225                 }
1226                 ast_mutex_lock(&newlyavailable->lock);
1227         }
1228         return res;
1229 }
1230
1231 /*! \brief Part of the Asterisk PBX interface */
1232 static struct ast_channel *agent_request(const char *type, int format, void *data, int *cause)
1233 {
1234         struct agent_pvt *p;
1235         struct ast_channel *chan = NULL;
1236         char *s;
1237         ast_group_t groupmatch;
1238         int groupoff;
1239         int waitforagent=0;
1240         int hasagent = 0;
1241         struct timeval tv;
1242
1243         s = data;
1244         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1245                 groupmatch = (1 << groupoff);
1246         } else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
1247                 groupmatch = (1 << groupoff);
1248                 waitforagent = 1;
1249         } else 
1250                 groupmatch = 0;
1251
1252         /* Check actual logged in agents first */
1253         AST_LIST_LOCK(&agents);
1254         AST_LIST_TRAVERSE(&agents, p, list) {
1255                 ast_mutex_lock(&p->lock);
1256                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent)) &&
1257                     ast_strlen_zero(p->loginchan)) {
1258                         if (p->chan)
1259                                 hasagent++;
1260                         tv = ast_tvnow();
1261                         if (!p->lastdisc.tv_sec || (tv.tv_sec >= p->lastdisc.tv_sec)) {
1262                                 p->lastdisc = ast_tv(0, 0);
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                                 if (!soft) {
1466                                         if (p->owner)
1467                                                 ast_softhangup(p->owner, AST_SOFTHANGUP_EXPLICIT);
1468                                         if (p->chan)
1469                                                 ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1470                                 } else
1471                                         p->deferlogoff = 1;
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                 ast_verb(3, "Saw variable AGENTMAXLOGINTRIES=%s, setting max_login_tries to: %d on Channel '%s'.\n",tmpoptions,max_login_tries,chan->name);
1749         }
1750         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR"))) {
1751                 if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR")))
1752                         update_cdr = 1;
1753                 else
1754                         update_cdr = 0;
1755                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTUPDATECDR");
1756                 ast_verb(3, "Saw variable AGENTUPDATECDR=%s, setting update_cdr to: %d on Channel '%s'.\n",tmpoptions,update_cdr,chan->name);
1757         }
1758         if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"))) {
1759                 strcpy(agent_goodbye, pbx_builtin_getvar_helper(chan, "AGENTGOODBYE"));
1760                 tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTGOODBYE");
1761                 ast_verb(3, "Saw variable AGENTGOODBYE=%s, setting agent_goodbye to: %s on Channel '%s'.\n",tmpoptions,agent_goodbye,chan->name);
1762         }
1763         /* End Channel Specific Login Overrides */
1764         
1765         if (!ast_strlen_zero(args.options)) {
1766                 if (strchr(args.options, 's')) {
1767                         play_announcement = 0;
1768                 }
1769         }
1770
1771         if (chan->_state != AST_STATE_UP)
1772                 res = ast_answer(chan);
1773         if (!res) {
1774                 if (!ast_strlen_zero(args.agent_id))
1775                         ast_copy_string(user, args.agent_id, AST_MAX_AGENT);
1776                 else
1777                         res = ast_app_getdata(chan, "agent-user", user, sizeof(user) - 1, 0);
1778         }
1779         while (!res && (max_login_tries==0 || tries < max_login_tries)) {
1780                 tries++;
1781                 /* Check for password */
1782                 AST_LIST_LOCK(&agents);
1783                 AST_LIST_TRAVERSE(&agents, p, list) {
1784                         if (!strcmp(p->agent, user) && !p->pending)
1785                                 ast_copy_string(xpass, p->password, sizeof(xpass));
1786                 }
1787                 AST_LIST_UNLOCK(&agents);
1788                 if (!res) {
1789                         if (!ast_strlen_zero(xpass))
1790                                 res = ast_app_getdata(chan, "agent-pass", pass, sizeof(pass) - 1, 0);
1791                         else
1792                                 pass[0] = '\0';
1793                 }
1794                 errmsg = "agent-incorrect";
1795
1796 #if 0
1797                 ast_log(LOG_NOTICE, "user: %s, pass: %s\n", user, pass);
1798 #endif          
1799
1800                 /* Check again for accuracy */
1801                 AST_LIST_LOCK(&agents);
1802                 AST_LIST_TRAVERSE(&agents, p, list) {
1803                         ast_mutex_lock(&p->lock);
1804                         if (!strcmp(p->agent, user) &&
1805                             !strcmp(p->password, pass) && !p->pending) {
1806                                 login_state = 1; /* Successful Login */
1807
1808                                 /* Ensure we can't be gotten until we're done */
1809                                 p->lastdisc = ast_tvnow();
1810                                 p->lastdisc.tv_sec++;
1811
1812                                 /* Set Channel Specific Agent Overrides */
1813                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"))) {
1814                                         if (!strcasecmp(pbx_builtin_getvar_helper(chan, "AGENTACKCALL"), "always"))
1815                                                 p->ackcall = 2;
1816                                         else if (ast_true(pbx_builtin_getvar_helper(chan, "AGENTACKCALL")))
1817                                                 p->ackcall = 1;
1818                                         else
1819                                                 p->ackcall = 0;
1820                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTACKCALL");
1821                                         ast_verb(3, "Saw variable AGENTACKCALL=%s, setting ackcall to: %d for Agent '%s'.\n",tmpoptions,p->ackcall,p->agent);
1822                                 }
1823                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"))) {
1824                                         p->autologoff = atoi(pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF"));
1825                                         if (p->autologoff < 0)
1826                                                 p->autologoff = 0;
1827                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTAUTOLOGOFF");
1828                                         ast_verb(3, "Saw variable AGENTAUTOLOGOFF=%s, setting autologff to: %d for Agent '%s'.\n",tmpoptions,p->autologoff,p->agent);
1829                                 }
1830                                 if (!ast_strlen_zero(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"))) {
1831                                         p->wrapuptime = atoi(pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME"));
1832                                         if (p->wrapuptime < 0)
1833                                                 p->wrapuptime = 0;
1834                                         tmpoptions=pbx_builtin_getvar_helper(chan, "AGENTWRAPUPTIME");
1835                                         ast_verb(3, "Saw variable AGENTWRAPUPTIME=%s, setting wrapuptime to: %d for Agent '%s'.\n",tmpoptions,p->wrapuptime,p->agent);
1836                                 }
1837                                 /* End Channel Specific Agent Overrides */
1838                                 if (!p->chan) {
1839                                         long logintime;
1840                                         snprintf(agent, sizeof(agent), "Agent/%s", p->agent);
1841
1842                                         p->loginchan[0] = '\0';
1843                                         p->logincallerid[0] = '\0';
1844                                         p->acknowledged = 0;
1845                                         
1846                                         ast_mutex_unlock(&p->lock);
1847                                         AST_LIST_UNLOCK(&agents);
1848                                         if( !res && play_announcement==1 )
1849                                                 res = ast_streamfile(chan, filename, chan->language);
1850                                         if (!res)
1851                                                 ast_waitstream(chan, "");
1852                                         AST_LIST_LOCK(&agents);
1853                                         ast_mutex_lock(&p->lock);
1854                                         if (!res) {
1855                                                 res = ast_set_read_format(chan, ast_best_codec(chan->nativeformats));
1856                                                 if (res)
1857                                                         ast_log(LOG_WARNING, "Unable to set read format to %d\n", ast_best_codec(chan->nativeformats));
1858                                         }
1859                                         if (!res) {
1860                                                 res = ast_set_write_format(chan, ast_best_codec(chan->nativeformats));
1861                                                 if (res)
1862                                                         ast_log(LOG_WARNING, "Unable to set write format to %d\n", ast_best_codec(chan->nativeformats));
1863                                         }
1864                                         /* Check once more just in case */
1865                                         if (p->chan)
1866                                                 res = -1;
1867                                         if (!res) {
1868                                                 ast_indicate_data(chan, AST_CONTROL_HOLD, 
1869                                                         S_OR(p->moh, NULL), 
1870                                                         !ast_strlen_zero(p->moh) ? strlen(p->moh) + 1 : 0);
1871                                                 if (p->loginstart == 0)
1872                                                         time(&p->loginstart);
1873                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogin",
1874                                                               "Agent: %s\r\n"
1875                                                               "Channel: %s\r\n"
1876                                                               "Uniqueid: %s\r\n",
1877                                                               p->agent, chan->name, chan->uniqueid);
1878                                                 if (update_cdr && chan->cdr)
1879                                                         snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
1880                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGIN", "%s", chan->name);
1881                                                 ast_verb(2, "Agent '%s' logged in (format %s/%s)\n", p->agent,
1882                                                                     ast_getformatname(chan->readformat), ast_getformatname(chan->writeformat));
1883                                                 /* Login this channel and wait for it to go away */
1884                                                 p->chan = chan;
1885                                                 if (p->ackcall > 1)
1886                                                         check_beep(p, 0);
1887                                                 else
1888                                                         check_availability(p, 0);
1889                                                 ast_mutex_unlock(&p->lock);
1890                                                 AST_LIST_UNLOCK(&agents);
1891                                                 ast_device_state_changed("Agent/%s", p->agent);
1892                                                 while (res >= 0) {
1893                                                         ast_mutex_lock(&p->lock);
1894                                                         if (p->deferlogoff && p->chan) {
1895                                                                 ast_softhangup(p->chan, AST_SOFTHANGUP_EXPLICIT);
1896                                                                 p->deferlogoff = 0;
1897                                                         }
1898                                                         if (p->chan != chan)
1899                                                                 res = -1;
1900                                                         ast_mutex_unlock(&p->lock);
1901                                                         /* Yield here so other interested threads can kick in. */
1902                                                         sched_yield();
1903                                                         if (res)
1904                                                                 break;
1905
1906                                                         AST_LIST_LOCK(&agents);
1907                                                         ast_mutex_lock(&p->lock);
1908                                                         if (p->lastdisc.tv_sec) {
1909                                                                 if (ast_tvdiff_ms(ast_tvnow(), p->lastdisc) > 0) {
1910                                                                         ast_debug(1, "Wrapup time for %s expired!\n", p->agent);
1911                                                                         p->lastdisc = ast_tv(0, 0);
1912                                                                         if (p->ackcall > 1)
1913                                                                                 check_beep(p, 0);
1914                                                                         else
1915                                                                                 check_availability(p, 0);
1916                                                                 }
1917                                                         }
1918                                                         ast_mutex_unlock(&p->lock);
1919                                                         AST_LIST_UNLOCK(&agents);
1920                                                         /*      Synchronize channel ownership between call to agent and itself. */
1921                                                         ast_mutex_lock( &p->app_lock );
1922                                                         ast_mutex_lock(&p->lock);
1923                                                         p->owning_app = pthread_self();
1924                                                         ast_mutex_unlock(&p->lock);
1925                                                         if (p->ackcall > 1) 
1926                                                                 res = agent_ack_sleep(p);
1927                                                         else
1928                                                                 res = ast_safe_sleep_conditional( chan, 1000, agent_cont_sleep, p );
1929                                                         ast_mutex_unlock( &p->app_lock );
1930                                                         if ((p->ackcall > 1)  && (res == 1)) {
1931                                                                 AST_LIST_LOCK(&agents);
1932                                                                 ast_mutex_lock(&p->lock);
1933                                                                 check_availability(p, 0);
1934                                                                 ast_mutex_unlock(&p->lock);
1935                                                                 AST_LIST_UNLOCK(&agents);
1936                                                                 res = 0;
1937                                                         }
1938                                                         sched_yield();
1939                                                 }
1940                                                 ast_mutex_lock(&p->lock);
1941                                                 if (res && p->owner) 
1942                                                         ast_log(LOG_WARNING, "Huh?  We broke out when there was still an owner?\n");
1943                                                 /* Log us off if appropriate */
1944                                                 if (p->chan == chan)
1945                                                         p->chan = NULL;
1946                                                 p->acknowledged = 0;
1947                                                 logintime = time(NULL) - p->loginstart;
1948                                                 p->loginstart = 0;
1949                                                 ast_mutex_unlock(&p->lock);
1950                                                 manager_event(EVENT_FLAG_AGENT, "Agentlogoff",
1951                                                               "Agent: %s\r\n"
1952                                                               "Logintime: %ld\r\n"
1953                                                               "Uniqueid: %s\r\n",
1954                                                               p->agent, logintime, chan->uniqueid);
1955                                                 ast_queue_log("NONE", chan->uniqueid, agent, "AGENTLOGOFF", "%s|%ld", chan->name, logintime);
1956                                                 ast_verb(2, "Agent '%s' logged out\n", p->agent);
1957                                                 /* If there is no owner, go ahead and kill it now */
1958                                                 ast_device_state_changed("Agent/%s", p->agent);
1959                                                 if (p->dead && !p->owner) {
1960                                                         ast_mutex_destroy(&p->lock);
1961                                                         ast_mutex_destroy(&p->app_lock);
1962                                                         ast_free(p);
1963                                                 }
1964                                         }
1965                                         else {
1966                                                 ast_mutex_unlock(&p->lock);
1967                                                 p = NULL;
1968                                         }
1969                                         res = -1;
1970                                 } else {
1971                                         ast_mutex_unlock(&p->lock);
1972                                         errmsg = "agent-alreadyon";
1973                                         p = NULL;
1974                                 }
1975                                 break;
1976                         }
1977                         ast_mutex_unlock(&p->lock);
1978                 }
1979                 if (!p)
1980                         AST_LIST_UNLOCK(&agents);
1981
1982                 if (!res && (max_login_tries==0 || tries < max_login_tries))
1983                         res = ast_app_getdata(chan, errmsg, user, sizeof(user) - 1, 0);
1984         }
1985                 
1986         if (!res)
1987                 res = ast_safe_sleep(chan, 500);
1988
1989         ast_module_user_remove(u);
1990         
1991         return -1;
1992 }
1993
1994 /*!
1995  *  \brief Called by the AgentMonitorOutgoing application (from the dial plan).
1996  *
1997  * \param chan
1998  * \param data
1999  * \returns
2000  * \sa login_exec(), load_module().
2001  */
2002 static int agentmonitoroutgoing_exec(struct ast_channel *chan, void *data)
2003 {
2004         int exitifnoagentid = 0;
2005         int nowarnings = 0;
2006         int changeoutgoing = 0;
2007         int res = 0;
2008         char agent[AST_MAX_AGENT];
2009
2010         if (data) {
2011                 if (strchr(data, 'd'))
2012                         exitifnoagentid = 1;
2013                 if (strchr(data, 'n'))
2014                         nowarnings = 1;
2015                 if (strchr(data, 'c'))
2016                         changeoutgoing = 1;
2017         }
2018         if (chan->cid.cid_num) {
2019                 const char *tmp;
2020                 char agentvar[AST_MAX_BUF];
2021                 snprintf(agentvar, sizeof(agentvar), "%s_%s", GETAGENTBYCALLERID, chan->cid.cid_num);
2022                 if ((tmp = pbx_builtin_getvar_helper(NULL, agentvar))) {
2023                         struct agent_pvt *p;
2024                         ast_copy_string(agent, tmp, sizeof(agent));
2025                         AST_LIST_LOCK(&agents);
2026                         AST_LIST_TRAVERSE(&agents, p, list) {
2027                                 if (!strcasecmp(p->agent, tmp)) {
2028                                         if (changeoutgoing) snprintf(chan->cdr->channel, sizeof(chan->cdr->channel), "Agent/%s", p->agent);
2029                                         __agent_start_monitoring(chan, p, 1);
2030                                         break;
2031                                 }
2032                         }
2033                         AST_LIST_UNLOCK(&agents);
2034                         
2035                 } else {
2036                         res = -1;
2037                         if (!nowarnings)
2038                                 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);
2039                 }
2040         } else {
2041                 res = -1;
2042                 if (!nowarnings)
2043                         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");
2044         }
2045         if (res) {
2046                 if (exitifnoagentid)
2047                         return res;
2048         }
2049         return 0;
2050 }
2051
2052 /*!
2053  * \brief Dump AgentCallbackLogin agents to the ASTdb database for persistence
2054  */
2055 static void dump_agents(void)
2056 {
2057         struct agent_pvt *cur_agent = NULL;
2058         char buf[256];
2059
2060         AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2061                 if (cur_agent->chan)
2062                         continue;
2063
2064                 if (!ast_strlen_zero(cur_agent->loginchan)) {
2065                         snprintf(buf, sizeof(buf), "%s;%s", cur_agent->loginchan, cur_agent->logincallerid);
2066                         if (ast_db_put(pa_family, cur_agent->agent, buf))
2067                                 ast_log(LOG_WARNING, "failed to create persistent entry in ASTdb for %s!\n", buf);
2068                         else
2069                                 ast_debug(1, "Saved Agent: %s on %s\n", cur_agent->agent, cur_agent->loginchan);
2070                 } else {
2071                         /* Delete -  no agent or there is an error */
2072                         ast_db_del(pa_family, cur_agent->agent);
2073                 }
2074         }
2075 }
2076
2077 /*!
2078  * \brief Reload the persistent agents from astdb.
2079  */
2080 static void reload_agents(void)
2081 {
2082         char *agent_num;
2083         struct ast_db_entry *db_tree;
2084         struct ast_db_entry *entry;
2085         struct agent_pvt *cur_agent;
2086         char agent_data[256];
2087         char *parse;
2088         char *agent_chan;
2089         char *agent_callerid;
2090
2091         db_tree = ast_db_gettree(pa_family, NULL);
2092
2093         AST_LIST_LOCK(&agents);
2094         for (entry = db_tree; entry; entry = entry->next) {
2095                 agent_num = entry->key + strlen(pa_family) + 2;
2096                 AST_LIST_TRAVERSE(&agents, cur_agent, list) {
2097                         ast_mutex_lock(&cur_agent->lock);
2098                         if (strcmp(agent_num, cur_agent->agent) == 0)
2099                                 break;
2100                         ast_mutex_unlock(&cur_agent->lock);
2101                 }
2102                 if (!cur_agent) {
2103                         ast_db_del(pa_family, agent_num);
2104                         continue;
2105                 } else
2106                         ast_mutex_unlock(&cur_agent->lock);
2107                 if (!ast_db_get(pa_family, agent_num, agent_data, sizeof(agent_data)-1)) {
2108                         ast_debug(1, "Reload Agent from AstDB: %s on %s\n", cur_agent->agent, agent_data);
2109                         parse = agent_data;
2110                         agent_chan = strsep(&parse, ";");
2111                         agent_callerid = strsep(&parse, ";");
2112                         ast_copy_string(cur_agent->loginchan, agent_chan, sizeof(cur_agent->loginchan));
2113                         if (agent_callerid) {
2114                                 ast_copy_string(cur_agent->logincallerid, agent_callerid, sizeof(cur_agent->logincallerid));
2115                                 set_agentbycallerid(cur_agent->logincallerid, cur_agent->agent);
2116                         } else
2117                                 cur_agent->logincallerid[0] = '\0';
2118                         if (cur_agent->loginstart == 0)
2119                                 time(&cur_agent->loginstart);
2120                         ast_device_state_changed("Agent/%s", cur_agent->agent); 
2121                 }
2122         }
2123         AST_LIST_UNLOCK(&agents);
2124         if (db_tree) {
2125                 ast_log(LOG_NOTICE, "Agents successfully reloaded from database.\n");
2126                 ast_db_freetree(db_tree);
2127         }
2128 }
2129
2130 /*! \brief Part of PBX channel interface */
2131 static int agent_devicestate(void *data)
2132 {
2133         struct agent_pvt *p;
2134         char *s;
2135         ast_group_t groupmatch;
2136         int groupoff;
2137         int res = AST_DEVICE_INVALID;
2138         
2139         s = data;
2140         if ((s[0] == '@') && (sscanf(s + 1, "%d", &groupoff) == 1))
2141                 groupmatch = (1 << groupoff);
2142         else if ((s[0] == ':') && (sscanf(s + 1, "%d", &groupoff) == 1)) {
2143                 groupmatch = (1 << groupoff);
2144         } else 
2145                 groupmatch = 0;
2146
2147         /* Check actual logged in agents first */
2148         AST_LIST_LOCK(&agents);
2149         AST_LIST_TRAVERSE(&agents, p, list) {
2150                 ast_mutex_lock(&p->lock);
2151                 if (!p->pending && ((groupmatch && (p->group & groupmatch)) || !strcmp(data, p->agent))) {
2152                         if (p->owner) {
2153                                 if (res != AST_DEVICE_INUSE)
2154                                         res = AST_DEVICE_BUSY;
2155                         } else {
2156                                 if (res == AST_DEVICE_BUSY)
2157                                         res = AST_DEVICE_INUSE;
2158                                 if (p->chan || !ast_strlen_zero(p->loginchan)) {
2159                                         if (res == AST_DEVICE_INVALID)
2160                                                 res = AST_DEVICE_UNKNOWN;
2161                                 } else if (res == AST_DEVICE_INVALID)   
2162                                         res = AST_DEVICE_UNAVAILABLE;
2163                         }
2164                         if (!strcmp(data, p->agent)) {
2165                                 ast_mutex_unlock(&p->lock);
2166                                 break;
2167                         }
2168                 }
2169                 ast_mutex_unlock(&p->lock);
2170         }
2171         AST_LIST_UNLOCK(&agents);
2172         return res;
2173 }
2174
2175 static struct agent_pvt *find_agent(char *agentid)
2176 {
2177         struct agent_pvt *cur;
2178
2179         AST_LIST_TRAVERSE(&agents, cur, list) {
2180                 if (!strcmp(cur->agent, agentid))
2181                         break;  
2182         }
2183
2184         return cur;     
2185 }
2186
2187 static int function_agent(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
2188 {
2189         char *parse;    
2190         AST_DECLARE_APP_ARGS(args,
2191                 AST_APP_ARG(agentid);
2192                 AST_APP_ARG(item);
2193         );
2194         char *tmp;
2195         struct agent_pvt *agent;
2196
2197         buf[0] = '\0';
2198
2199         if (ast_strlen_zero(data)) {
2200                 ast_log(LOG_WARNING, "The AGENT function requires an argument - agentid!\n");
2201                 return -1;
2202         }
2203
2204         parse = ast_strdupa(data);
2205
2206         AST_NONSTANDARD_APP_ARGS(args, parse, ':');
2207         if (!args.item)
2208                 args.item = "status";
2209
2210         if (!(agent = find_agent(args.agentid))) {
2211                 ast_log(LOG_WARNING, "Agent '%s' not found!\n", args.agentid);
2212                 return -1;
2213         }
2214
2215         if (!strcasecmp(args.item, "status")) {
2216                 char *status = "LOGGEDOUT";
2217                 if (agent->chan || !ast_strlen_zero(agent->loginchan)) 
2218                         status = "LOGGEDIN";    
2219                 ast_copy_string(buf, status, len);
2220         } else if (!strcasecmp(args.item, "password")) 
2221                 ast_copy_string(buf, agent->password, len);
2222         else if (!strcasecmp(args.item, "name"))
2223                 ast_copy_string(buf, agent->name, len);
2224         else if (!strcasecmp(args.item, "mohclass"))
2225                 ast_copy_string(buf, agent->moh, len);
2226         else if (!strcasecmp(args.item, "channel")) {
2227                 if (agent->chan) {
2228                         ast_copy_string(buf, agent->chan->name, len);
2229                         tmp = strrchr(buf, '-');
2230                         if (tmp)
2231                                 *tmp = '\0';
2232                 } 
2233         } else if (!strcasecmp(args.item, "exten"))
2234                 ast_copy_string(buf, agent->loginchan, len);    
2235
2236         return 0;
2237 }
2238
2239 struct ast_custom_function agent_function = {
2240         .name = "AGENT",
2241         .synopsis = "Gets information about an Agent",
2242         .syntax = "AGENT(<agentid>[:item])",
2243         .read = function_agent,
2244         .desc = "The valid items to retrieve are:\n"
2245         "- status (default)      The status of the agent\n"
2246         "                          LOGGEDIN | LOGGEDOUT\n"
2247         "- password              The password of the agent\n"
2248         "- name                  The name of the agent\n"
2249         "- mohclass              MusicOnHold class\n"
2250         "- exten                 The callback extension for the Agent (AgentCallbackLogin)\n"
2251         "- channel               The name of the active channel for the Agent (AgentLogin)\n"
2252 };
2253
2254
2255 /*!
2256  * \brief Initialize the Agents module.
2257  * This function is being called by Asterisk when loading the module. 
2258  * Among other things it registers applications, cli commands and reads the cofiguration file.
2259  *
2260  * \returns int Always 0.
2261  */
2262 static int load_module(void)
2263 {
2264         /* Make sure we can register our agent channel type */
2265         if (ast_channel_register(&agent_tech)) {
2266                 ast_log(LOG_ERROR, "Unable to register channel class 'Agent'\n");
2267                 return -1;
2268         }
2269         /* Read in the config */
2270         if (!read_agent_config())
2271                 return AST_MODULE_LOAD_DECLINE;
2272         if (persistent_agents)
2273                 reload_agents();
2274         /* Dialplan applications */
2275         ast_register_application(app, login_exec, synopsis, descrip);
2276         ast_register_application(app3, agentmonitoroutgoing_exec, synopsis3, descrip3);
2277
2278         /* Manager commands */
2279         ast_manager_register2("Agents", EVENT_FLAG_AGENT, action_agents, "Lists agents and their status", mandescr_agents);
2280         ast_manager_register2("AgentLogoff", EVENT_FLAG_AGENT, action_agent_logoff, "Sets an agent as no longer logged in", mandescr_agent_logoff);
2281
2282         /* CLI Commands */
2283         ast_cli_register_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2284
2285         /* Dialplan Functions */
2286         ast_custom_function_register(&agent_function);
2287
2288         return 0;
2289 }
2290
2291 static int reload(void)
2292 {
2293         read_agent_config();
2294         if (persistent_agents)
2295                 reload_agents();
2296         return 0;
2297 }
2298
2299 static int unload_module(void)
2300 {
2301         struct agent_pvt *p;
2302         /* First, take us out of the channel loop */
2303         ast_channel_unregister(&agent_tech);
2304         /* Unregister dialplan functions */
2305         ast_custom_function_unregister(&agent_function);        
2306         /* Unregister CLI commands */
2307         ast_cli_unregister_multiple(cli_agents, sizeof(cli_agents) / sizeof(struct ast_cli_entry));
2308         /* Unregister dialplan applications */
2309         ast_unregister_application(app);
2310         ast_unregister_application(app3);
2311         /* Unregister manager command */
2312         ast_manager_unregister("Agents");
2313         ast_manager_unregister("AgentLogoff");
2314         /* Unregister channel */
2315         AST_LIST_LOCK(&agents);
2316         /* Hangup all interfaces if they have an owner */
2317         while ((p = AST_LIST_REMOVE_HEAD(&agents, list))) {
2318                 if (p->owner)
2319                         ast_softhangup(p->owner, AST_SOFTHANGUP_APPUNLOAD);
2320                 ast_free(p);
2321         }
2322         AST_LIST_UNLOCK(&agents);
2323         AST_LIST_HEAD_DESTROY(&agents);
2324         return 0;
2325 }
2326
2327 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Agent Proxy Channel",
2328                 .load = load_module,
2329                 .unload = unload_module,
2330                 .reload = reload,
2331                );