Fix up some doxygen issues.
[asterisk/asterisk.git] / res / res_phoneprov.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Matthew Brooks <mbrooks@digium.com>
8  * Terry Wilson <twilson@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief Phone provisioning application for the asterisk internal http server
24  *
25  * \author Matthew Brooks <mbrooks@digium.com>
26  * \author Terry Wilson <twilson@digium.com>
27  */
28
29 #include "asterisk.h"
30
31 #include <sys/ioctl.h>
32 #include <sys/socket.h>
33 #include <net/if.h>
34 #ifdef SOLARIS
35 #include <sys/sockio.h>
36 #endif
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 96773 $")
38
39 #include "asterisk/file.h"
40 #include "asterisk/paths.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/cli.h"
43 #include "asterisk/module.h"
44 #include "asterisk/http.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/app.h"
47 #include "asterisk/strings.h"
48 #include "asterisk/stringfields.h"
49 #include "asterisk/options.h"
50 #include "asterisk/config.h"
51 #include "asterisk/acl.h"
52 #include "asterisk/astobj2.h"
53 #include "asterisk/version.h"
54
55 #ifdef LOW_MEMORY
56 #define MAX_PROFILE_BUCKETS 1
57 #define MAX_ROUTE_BUCKETS 1
58 #else
59 #define MAX_PROFILE_BUCKETS 17
60 #define MAX_ROUTE_BUCKETS 563
61 #endif /* LOW_MEMORY */
62
63 #define VAR_BUF_SIZE 4096
64
65 /*! \brief for use in lookup_iface */
66 static struct in_addr __ourip = { .s_addr = 0x00000000, };
67
68 /* \note This enum and the pp_variable_list must be in the same order or
69  * bad things happen! */
70 enum pp_variables {
71         PP_MACADDRESS,
72         PP_USERNAME,
73         PP_FULLNAME,
74         PP_SECRET,
75         PP_LABEL,
76         PP_CALLERID,
77         PP_TIMEZONE,
78         PP_VAR_LIST_LENGTH,     /* This entry must always be the last in the list */
79 };
80
81 /*! \brief Lookup table to translate between users.conf property names and
82  * variables for use in phoneprov templates */
83 static const struct pp_variable_lookup {
84         enum pp_variables id;
85         const char * const user_var;
86         const char * const template_var;
87 } pp_variable_list[] = {
88         { PP_MACADDRESS, "macaddress", "MAC" },
89         { PP_USERNAME, "username", "USERNAME" },
90         { PP_FULLNAME, "fullname", "DISPLAY_NAME" },
91         { PP_SECRET, "secret", "SECRET" },
92         { PP_LABEL, "label", "LABEL" },
93         { PP_CALLERID, "cid_number", "CALLERID" },
94         { PP_TIMEZONE, "timezone", "TIMEZONE" },
95 };
96
97 /*! \brief structure to hold file data */
98 struct phoneprov_file {
99         AST_DECLARE_STRING_FIELDS(
100                 AST_STRING_FIELD(format);       /*!< After variable substitution, becomes route->uri */
101                 AST_STRING_FIELD(template); /*!< Template/physical file location */
102                 AST_STRING_FIELD(mime_type);/*!< Mime-type of the file */
103         );
104         AST_LIST_ENTRY(phoneprov_file) entry;
105 };
106
107 /*! \brief structure to hold phone profiles read from phoneprov.conf */
108 struct phone_profile {
109         AST_DECLARE_STRING_FIELDS(
110                 AST_STRING_FIELD(name); /*!< Name of phone profile */
111                 AST_STRING_FIELD(default_mime_type);    /*!< Default mime type if it isn't provided */
112                 AST_STRING_FIELD(staticdir);    /*!< Subdirectory that static files are stored in */
113         );
114         struct varshead *headp; /*!< List of variables set with 'setvar' in phoneprov.conf */
115         AST_LIST_HEAD_NOLOCK(, phoneprov_file) static_files;    /*!< List of static files */
116         AST_LIST_HEAD_NOLOCK(, phoneprov_file) dynamic_files;   /*!< List of dynamic files */
117 };
118
119 /*! \brief structure to hold users read from users.conf */
120 struct user {
121         AST_DECLARE_STRING_FIELDS(
122                 AST_STRING_FIELD(name); /*!< Name of user */
123                 AST_STRING_FIELD(macaddress);   /*!< Mac address of user's phone */
124         );
125         struct phone_profile *profile;  /*!< Profile the phone belongs to */
126         struct varshead *headp; /*!< List of variables to substitute into templates */
127         AST_LIST_ENTRY(user) entry;
128 };
129
130 /*! \brief structure to hold http routes (valid URIs, and the files they link to) */
131 struct http_route {
132         AST_DECLARE_STRING_FIELDS(
133                 AST_STRING_FIELD(uri);  /*!< The URI requested */
134         );
135         struct phoneprov_file *file;    /*!< The file that links to the URI */
136         struct user *user;      /*!< The user that has variables to substitute into the file
137                                                  * NULL in the case of a static route */
138 };
139
140 static struct ao2_container *profiles;
141 static struct ao2_container *http_routes;
142 static AST_RWLIST_HEAD_STATIC(users, user);
143
144 /*! \brief Extensions whose mime types we think we know */
145 static struct {
146         char *ext;
147         char *mtype;
148 } mimetypes[] = {
149         { "png", "image/png" },
150         { "xml", "text/xml" },
151         { "jpg", "image/jpeg" },
152         { "js", "application/x-javascript" },
153         { "wav", "audio/x-wav" },
154         { "mp3", "audio/mpeg" },
155 };
156
157 char global_server[80] = "";    /*!< Server to substitute into templates */
158 char global_serverport[6] = ""; /*!< Server port to substitute into templates */
159 char global_default_profile[80] = "";   /*!< Default profile to use if one isn't specified */   
160
161 /*! \brief List of global variables currently available: VOICEMAIL_EXTEN, EXTENSION_LENGTH */
162 struct varshead global_variables;
163
164 /*! \brief Return mime type based on extension */
165 static char *ftype2mtype(const char *ftype)
166 {
167         int x;
168
169         if (ast_strlen_zero(ftype))
170                 return NULL;
171
172         for (x = 0;x < ARRAY_LEN(mimetypes);x++) {
173                 if (!strcasecmp(ftype, mimetypes[x].ext))
174                         return mimetypes[x].mtype;
175         }
176         
177         return NULL;
178 }
179
180 /* iface is the interface (e.g. eth0); address is the return value */
181 static int lookup_iface(const char *iface, struct in_addr *address)
182 {
183         int mysock, res = 0;
184         struct ifreq ifr;
185         struct sockaddr_in *sin;
186
187         memset(&ifr, 0, sizeof(ifr));
188         ast_copy_string(ifr.ifr_name, iface, sizeof(ifr.ifr_name));
189
190         mysock = socket(PF_INET, SOCK_DGRAM, IPPROTO_IP);
191         if (mysock < 0) {
192                 ast_log(LOG_ERROR, "Failed to create socket: %s\n", strerror(errno));
193                 return -1;
194         }
195
196         res = ioctl(mysock, SIOCGIFADDR, &ifr);
197
198         close(mysock);
199
200         if (res < 0) {
201                 ast_log(LOG_WARNING, "Unable to get IP of %s: %s\n", iface, strerror(errno));
202                 memcpy(address, &__ourip, sizeof(__ourip));
203                 return -1;
204         } else {
205                 sin = (struct sockaddr_in *)&ifr.ifr_addr;
206                 memcpy(address, &sin->sin_addr, sizeof(*address));
207                 return 0;
208         }
209 }
210
211 static struct phone_profile *unref_profile(struct phone_profile *prof)
212 {
213         ao2_ref(prof, -1);
214
215         return NULL;
216 }
217
218 /*! \brief Return a phone profile looked up by name */
219 static struct phone_profile *find_profile(const char *name)
220 {
221         struct phone_profile tmp = {
222                 .name = name,
223         };
224
225         return ao2_find(profiles, &tmp, OBJ_POINTER);
226 }
227
228 static int profile_hash_fn(const void *obj, const int flags)
229 {
230         const struct phone_profile *profile = obj;
231         
232         return ast_str_hash(profile->name);
233 }
234
235 static int profile_cmp_fn(void *obj, void *arg, int flags)
236 {
237         const struct phone_profile *profile1 = obj, *profile2 = arg;
238
239         return !strcasecmp(profile1->name, profile2->name) ? CMP_MATCH : 0;
240 }
241
242 static void delete_file(struct phoneprov_file *file)
243 {
244         ast_string_field_free_memory(file);
245         free(file);
246 }
247
248 static void profile_destructor(void *obj)
249 {
250         struct phone_profile *profile = obj;
251         struct phoneprov_file *file;
252         struct ast_var_t *var;
253
254         while ((file = AST_LIST_REMOVE_HEAD(&profile->static_files, entry)))
255                 delete_file(file);
256
257         while ((file = AST_LIST_REMOVE_HEAD(&profile->dynamic_files, entry)))
258                 delete_file(file);
259
260         while ((var = AST_LIST_REMOVE_HEAD(profile->headp, entries)))
261                 ast_var_delete(var);
262
263         free(profile->headp);
264         ast_string_field_free_memory(profile);
265 }
266
267 static struct http_route *unref_route(struct http_route *route)
268 {
269         ao2_ref(route, -1);
270
271         return NULL;
272 }
273
274 static int routes_hash_fn(const void *obj, const int flags)
275 {
276         const struct http_route *route = obj;
277         
278         return ast_str_hash(route->uri);
279 }
280
281 static int routes_cmp_fn(void *obj, void *arg, int flags)
282 {
283         const struct http_route *route1 = obj, *route2 = arg;
284
285         return !strcmp(route1->uri, route2->uri) ? CMP_MATCH : 0;
286 }
287
288 static void route_destructor(void *obj)
289 {
290         struct http_route *route = obj;
291
292         ast_string_field_free_memory(route);
293 }
294
295 /*! \brief Read a TEXT file into a string and return the length */
296 static int load_file(const char *filename, char **ret)
297 {
298         int len = 0;
299         FILE *f;
300         
301         if (!(f = fopen(filename, "r"))) {
302                 *ret = NULL;
303                 return -1;
304         }
305
306         fseek(f, 0, SEEK_END);
307         len = ftell(f);
308         fseek(f, 0, SEEK_SET);
309         if (!(*ret = ast_malloc(len + 1)))
310                 return -2;
311
312         if (len != fread(*ret, sizeof(char), len, f)) {
313                 free(*ret);
314                 *ret = NULL;
315                 return -3;
316         }
317
318         fclose(f);
319
320         (*ret)[len] = '\0';
321
322         return len;
323 }
324
325 /*! \brief Callback that is executed everytime an http request is received by this module */
326 static struct ast_str *phoneprov_callback(struct server_instance *ser, const char *uri, struct ast_variable *vars, int *status, char **title, int *contentlength)
327 {
328         struct http_route *route;
329         struct http_route search_route = {
330                 .uri = uri,
331         };
332         struct ast_str *result = ast_str_create(512);
333         char path[PATH_MAX];
334         char *file = NULL;
335         int len;
336         int fd;
337         char buf[256];
338         struct timeval tv = ast_tvnow();
339         struct ast_tm tm;
340
341         if (!(route = ao2_find(http_routes, &search_route, OBJ_POINTER)))
342                 goto out404;
343
344         snprintf(path, sizeof(path), "%s/phoneprov/%s", ast_config_AST_DATA_DIR, route->file->template);
345
346         if (!route->user) { /* Static file */
347
348                 fd = open(path, O_RDONLY);
349                 if (fd < 0)
350                         goto out500;
351
352                 len = lseek(fd, 0, SEEK_END);
353                 lseek(fd, 0, SEEK_SET);
354                 if (len < 0) {
355                         ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
356                         close(fd);
357                         goto out500;
358                 }
359
360                 ast_strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S %Z", ast_localtime(&tv, &tm, "GMT"));
361             fprintf(ser->f, "HTTP/1.1 200 OK\r\n"
362                         "Server: Asterisk/%s\r\n"
363                         "Date: %s\r\n"
364                         "Connection: close\r\n"
365                         "Cache-Control: no-cache, no-store\r\n"
366                         "Content-Length: %d\r\n"
367                         "Content-Type: %s\r\n\r\n",
368                         ast_get_version(), buf, len, route->file->mime_type);
369                 
370                 while ((len = read(fd, buf, sizeof(buf))) > 0)
371                         fwrite(buf, 1, len, ser->f);
372
373                 close(fd);
374                 route = unref_route(route);
375                 return NULL;
376         } else { /* Dynamic file */
377                 int bufsize;
378                 char *tmp;
379
380                 len = load_file(path, &file);
381                 if (len < 0) {
382                         ast_log(LOG_WARNING, "Could not load file: %s (%d)\n", path, len);
383                         if (file)
384                                 ast_free(file);
385                         goto out500;
386                 }
387
388                 if (!file)
389                         goto out500;
390
391                 /* XXX This is a hack -- maybe sum length of all variables in route->user->headp and add that? */
392                 bufsize = len + VAR_BUF_SIZE;
393                 
394                 /* malloc() instead of alloca() here, just in case the file is bigger than
395                  * we have enough stack space for. */
396                 if (!(tmp = ast_calloc(1, bufsize))) {
397                         if (file)
398                                 ast_free(file);
399                         goto out500;
400                 }
401
402                 /* Unless we are overridden by serveriface or serveraddr, we set the SERVER variable to
403                  * the IP address we are listening on that the phone contacted for this config file */
404                 if (ast_strlen_zero(global_server)) {
405                         struct sockaddr name;
406                         socklen_t namelen = sizeof(name);
407                         int res;
408
409                         if ((res = getsockname(ser->fd, &name, &namelen)))
410                                 ast_log(LOG_WARNING, "Could not get server IP, breakage likely.\n");
411                         else {
412                                 struct ast_var_t *var;
413
414                                 if ((var = ast_var_assign("SERVER", ast_inet_ntoa(((struct sockaddr_in *)&name)->sin_addr))))
415                                         AST_LIST_INSERT_TAIL(route->user->headp, var, entries);
416                         }
417                 }
418
419                 pbx_substitute_variables_varshead(route->user->headp, file, tmp, bufsize);
420         
421                 if (file)
422                         ast_free(file);
423
424                 ast_str_append(&result, 0,
425                         "Content-Type: %s\r\n"
426                         "Content-length: %d\r\n"
427                         "\r\n"
428                         "%s", route->file->mime_type, (int) strlen(tmp), tmp);
429
430                 if (tmp)
431                         ast_free(tmp);
432
433                 route = unref_route(route);
434
435                 return result;
436         }
437
438 out404:
439         *status = 404;
440         *title = strdup("Not Found");
441         *contentlength = 0;
442         return ast_http_error(404, "Not Found", NULL, "Nothing to see here.  Move along.");
443
444 out500:
445         route = unref_route(route);
446         *status = 500;
447         *title = strdup("Internal Server Error");
448         *contentlength = 0;
449         return ast_http_error(500, "Internal Error", NULL, "An internal error has occured.");
450 }
451
452 /*! \brief Build a route structure and add it to the list of available http routes
453         \param pp_file File to link to the route
454         \param user User to link to the route (NULL means static route)
455         \param uri URI of the route
456 */
457 static void build_route(struct phoneprov_file *pp_file, struct user *user, char *uri)
458 {
459         struct http_route *route;
460         
461         if (!(route = ao2_alloc(sizeof(*route), route_destructor)))
462                 return;
463
464         if (ast_string_field_init(route, 32)) {
465                 ast_log(LOG_ERROR, "Couldn't create string fields for %s\n", pp_file->format);
466                 route = unref_route(route);
467                 return;
468         }
469
470         ast_string_field_set(route, uri, S_OR(uri, pp_file->format));
471         route->user = user;
472         route->file = pp_file;
473
474         ao2_link(http_routes, route);
475
476         route = unref_route(route);
477 }
478
479 /*! \brief Build a phone profile and add it to the list of phone profiles
480         \param name the name of the profile
481         \param v ast_variable from parsing phoneprov.conf
482 */
483 static void build_profile(const char *name, struct ast_variable *v)
484 {
485         struct phone_profile *profile;
486         struct ast_var_t *var;
487
488         if (!(profile = ao2_alloc(sizeof(*profile), profile_destructor)))
489                 return;
490
491         if (ast_string_field_init(profile, 32)) {
492                 profile = unref_profile(profile);
493                 return;
494         }
495         
496         if (!(profile->headp = ast_calloc(1, sizeof(*profile->headp)))) {
497                 profile = unref_profile(profile);
498                 return;
499         }
500
501         AST_LIST_HEAD_INIT_NOLOCK(&profile->static_files);
502         AST_LIST_HEAD_INIT_NOLOCK(&profile->dynamic_files);
503
504         ast_string_field_set(profile, name, name);
505         for (; v; v = v->next) {
506                 if (!strcasecmp(v->name, "mime_type")) {
507                         ast_string_field_set(profile, default_mime_type, v->value);
508                 } else if (!strcasecmp(v->name, "setvar")) {
509                         struct ast_var_t *var;
510                         char *value_copy = ast_strdupa(v->value);
511
512                         AST_DECLARE_APP_ARGS(args,
513                                 AST_APP_ARG(varname);
514                                 AST_APP_ARG(varval);
515                         );
516                         
517                         AST_NONSTANDARD_APP_ARGS(args, value_copy, '=');
518                         do {
519                                 if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
520                                         break;
521                                 args.varname = ast_strip(args.varname);
522                                 args.varval = ast_strip(args.varval);
523                                 if (ast_strlen_zero(args.varname) || ast_strlen_zero(args.varval))
524                                         break;
525                                 if ((var = ast_var_assign(args.varname, args.varval)))
526                                         AST_LIST_INSERT_TAIL(profile->headp, var, entries);
527                         } while (0);
528                 } else if (!strcasecmp(v->name, "staticdir")) {
529                         ast_string_field_set(profile, staticdir, v->value);
530                 } else {
531                         struct phoneprov_file *pp_file;
532                         char *file_extension;
533                         char *value_copy = ast_strdupa(v->value); 
534
535                         AST_DECLARE_APP_ARGS(args,
536                                 AST_APP_ARG(filename);
537                                 AST_APP_ARG(mimetype);
538                         );
539
540                         if (!(pp_file = ast_calloc(1, sizeof(*pp_file)))) {
541                                 profile = unref_profile(profile);
542                                 return;
543                         }
544                         if (ast_string_field_init(pp_file, 32)) {
545                                 ast_free(pp_file);
546                                 profile = unref_profile(profile);
547                                 return;
548                         }
549
550                         if ((file_extension = strrchr(pp_file->format, '.')))
551                                 file_extension++;
552
553                         AST_STANDARD_APP_ARGS(args, value_copy);
554
555                         /* Mime type order of preference
556                          * 1) Specific mime-type defined for file in profile
557                          * 2) Mime determined by extension
558                          * 3) Default mime type specified in profile
559                          * 4) text/plain
560                          */
561                         ast_string_field_set(pp_file, mime_type, S_OR(args.mimetype, (S_OR(S_OR(ftype2mtype(file_extension), profile->default_mime_type), "text/plain"))));
562
563                         if (!strcasecmp(v->name, "static_file")) {
564                                 ast_string_field_set(pp_file, format, args.filename);
565                                 ast_string_field_build(pp_file, template, "%s%s", profile->staticdir, args.filename);
566                                 AST_LIST_INSERT_TAIL(&profile->static_files, pp_file, entry);
567                                 /* Add a route for the static files, as their filenames won't change per-user */
568                                 build_route(pp_file, NULL, NULL);
569                         } else {
570                                 ast_string_field_set(pp_file, format, v->name);
571                                 ast_string_field_set(pp_file, template, args.filename);
572                                 AST_LIST_INSERT_TAIL(&profile->dynamic_files, pp_file, entry);
573                         }
574                 }
575         }
576
577         /* Append the global variables to the variables list for this profile.
578          * This is for convenience later, when we need to provide a single
579          * variable list for use in substitution. */
580         AST_LIST_TRAVERSE(&global_variables, var, entries) {
581                 struct ast_var_t *new_var;
582                 if ((new_var = ast_var_assign(var->name, var->value)))
583                         AST_LIST_INSERT_TAIL(profile->headp, new_var, entries);
584         }
585
586         ao2_link(profiles, profile);
587
588         profile = unref_profile(profile);
589 }
590
591 /*! \brief Free all memory associated with a user */
592 static void delete_user(struct user *user)
593 {
594         struct ast_var_t *var;
595
596         while ((var = AST_LIST_REMOVE_HEAD(user->headp, entries)))
597                 ast_var_delete(var);
598
599         ast_free(user->headp);
600         ast_string_field_free_memory(user);
601         user->profile = unref_profile(user->profile);
602         free(user);
603 }
604
605 /*! \brief Destroy entire user list */
606 static void delete_users(void)
607 {
608         struct user *user;
609
610         AST_RWLIST_WRLOCK(&users);
611         while ((user = AST_LIST_REMOVE_HEAD(&users, entry)))
612                 delete_user(user);
613         AST_RWLIST_UNLOCK(&users);
614 }
615
616 /*! \brief Set all timezone-related variables based on a zone (i.e. America/New_York)
617         \param headp pointer to list of user variables
618         \param zone A time zone. NULL sets variables based on timezone of the machine
619 */
620 static void set_timezone_variables(struct varshead *headp, const char *zone)
621 {
622         time_t utc_time;
623         int dstenable;
624         time_t dststart;
625         time_t dstend;
626         struct ast_tm tm_info;
627         int tzoffset;
628         char buffer[21];
629         struct ast_var_t *var;
630         struct timeval tv;
631
632         time(&utc_time);
633         ast_get_dst_info(&utc_time, &dstenable, &dststart, &dstend, &tzoffset, zone);
634         snprintf(buffer, sizeof(buffer), "%d", tzoffset);
635         var = ast_var_assign("TZOFFSET", buffer);
636         if (var)
637                 AST_LIST_INSERT_TAIL(headp, var, entries); 
638
639         if (!dstenable)
640                 return;
641
642         if ((var = ast_var_assign("DST_ENABLE", "1")))
643                 AST_LIST_INSERT_TAIL(headp, var, entries);
644
645         tv.tv_sec = dststart; 
646         ast_localtime(&tv, &tm_info, zone);
647
648         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon+1);
649         if ((var = ast_var_assign("DST_START_MONTH", buffer)))
650                 AST_LIST_INSERT_TAIL(headp, var, entries);
651
652         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
653         if ((var = ast_var_assign("DST_START_MDAY", buffer)))
654                 AST_LIST_INSERT_TAIL(headp, var, entries);
655
656         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
657         if ((var = ast_var_assign("DST_START_HOUR", buffer)))
658                 AST_LIST_INSERT_TAIL(headp, var, entries);
659
660         tv.tv_sec = dstend;
661         ast_localtime(&tv, &tm_info, zone);
662
663         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mon + 1);
664         if ((var = ast_var_assign("DST_END_MONTH", buffer)))
665                 AST_LIST_INSERT_TAIL(headp, var, entries);
666
667         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_mday);
668         if ((var = ast_var_assign("DST_END_MDAY", buffer)))
669                 AST_LIST_INSERT_TAIL(headp, var, entries);
670
671         snprintf(buffer, sizeof(buffer), "%d", tm_info.tm_hour);
672         if ((var = ast_var_assign("DST_END_HOUR", buffer)))
673                 AST_LIST_INSERT_TAIL(headp, var, entries);
674 }
675
676 /*! \brief Build and return a user structure based on gathered config data */
677 static struct user *build_user(struct ast_config *cfg, const char *name, const char *mac, struct phone_profile *profile)
678 {
679         struct user *user;
680         struct ast_var_t *var;
681         const char *tmp;
682         int i;
683         
684         if (!(user = ast_calloc(1, sizeof(*user)))) {
685                 profile = unref_profile(profile);
686                 return NULL;
687         }
688         
689         if (!(user->headp = ast_calloc(1, sizeof(*user->headp)))) {
690                 profile = unref_profile(profile);
691                 ast_free(user);
692                 return NULL;
693         }
694
695         if (ast_string_field_init(user, 32)) {
696                 profile = unref_profile(profile);
697                 delete_user(user);
698                 return NULL;
699         }
700
701         ast_string_field_set(user, name, name);
702         ast_string_field_set(user, macaddress, mac);
703         user->profile = profile; /* already ref counted by find_profile */
704
705         for (i = 0; i < PP_VAR_LIST_LENGTH; i++) {
706                 tmp = ast_variable_retrieve(cfg, name, pp_variable_list[i].user_var);
707
708                 if (i == PP_TIMEZONE) {
709                         /* perfectly ok if tmp is NULL, will set variables based on server's time zone */
710                         set_timezone_variables(user->headp, tmp);
711                 }
712
713                 if (tmp && (var = ast_var_assign(pp_variable_list[i].template_var, tmp)))
714                         AST_LIST_INSERT_TAIL(user->headp, var, entries);
715         }
716
717         if (!ast_strlen_zero(global_server)) {
718                 if ((var = ast_var_assign("SERVER", global_server)))
719                         AST_LIST_INSERT_TAIL(user->headp, var, entries);
720         }
721
722         if (!ast_strlen_zero(global_serverport)) {
723                 if ((var = ast_var_assign("SERVER_PORT", global_serverport)))
724                         AST_LIST_INSERT_TAIL(user->headp, var, entries);
725         }
726
727         /* Append profile variables here, and substitute variables on profile
728          * setvars, so that we can use user specific variables in them */
729         AST_LIST_TRAVERSE(user->profile->headp, var, entries) {
730                 char expand_buf[VAR_BUF_SIZE] = {0,};
731                 struct ast_var_t *var2;
732
733                 pbx_substitute_variables_varshead(user->headp, var->value, expand_buf, sizeof(expand_buf));
734                 if ((var2 = ast_var_assign(var->name, expand_buf)))
735                         AST_LIST_INSERT_TAIL(user->headp, var2, entries);
736         }
737
738         return user;
739 }
740
741 /*! \brief Add an http route for dynamic files attached to the profile of the user */
742 static int build_user_routes(struct user *user)
743 {
744         struct phoneprov_file *pp_file;
745
746         AST_LIST_TRAVERSE(&user->profile->dynamic_files, pp_file, entry) {
747                 char expand_buf[VAR_BUF_SIZE] = { 0, };
748
749                 pbx_substitute_variables_varshead(user->headp, pp_file->format, expand_buf, sizeof(expand_buf));
750                 build_route(pp_file, user, expand_buf);
751         }
752
753         return 0;
754 }
755
756 /* \brief Parse config files and create appropriate structures */
757 static int set_config(void)
758 {
759         struct ast_config *cfg;
760         char *cat;
761         struct ast_variable *v;
762         struct ast_flags config_flags = { 0 };
763
764         /* Try to grab the port from sip.conf.  If we don't get it here, we'll set it
765          * to whatever is set in phoneprov.conf or default to 5060 */
766         if ((cfg = ast_config_load("sip.conf", config_flags))) {
767                 ast_copy_string(global_serverport, S_OR(ast_variable_retrieve(cfg, "general", "bindport"), "5060"), sizeof(global_serverport));
768                 ast_config_destroy(cfg);
769         }
770
771         if (!(cfg = ast_config_load("phoneprov.conf", config_flags))) {
772                 ast_log(LOG_ERROR, "Unable to load config phoneprov.conf\n");
773                 return -1;
774         }
775
776         cat = NULL;
777         while ((cat = ast_category_browse(cfg, cat))) {
778                 if (!strcasecmp(cat, "general")) {
779                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
780                                 if (!strcasecmp(v->name, "serveraddr"))
781                                         ast_copy_string(global_server, v->value, sizeof(global_server));
782                                 else if (!strcasecmp(v->name, "serveriface")) {
783                                         struct in_addr addr;
784                                         lookup_iface(v->value, &addr);
785                                         ast_copy_string(global_server, ast_inet_ntoa(addr), sizeof(global_server));
786                                 } else if (!strcasecmp(v->name, "serverport"))
787                                         ast_copy_string(global_serverport, v->value, sizeof(global_serverport));
788                                 else if (!strcasecmp(v->name, "default_profile"))
789                                         ast_copy_string(global_default_profile, v->value, sizeof(global_default_profile));
790                         }
791                 } else 
792                         build_profile(cat, ast_variable_browse(cfg, cat));
793         }
794
795         ast_config_destroy(cfg);
796
797         if (!(cfg = ast_config_load("users.conf", config_flags))) {
798                 ast_log(LOG_WARNING, "Unable to load users.cfg\n");
799                 return 0;
800         }
801
802         cat = NULL;
803         while ((cat = ast_category_browse(cfg, cat))) {
804                 const char *tmp, *mac;
805                 struct user *user;
806                 struct phone_profile *profile;
807                 struct ast_var_t *var;
808
809                 if (!strcasecmp(cat, "general")) {
810                         for (v = ast_variable_browse(cfg, cat); v; v = v->next) {
811                                 if (!strcasecmp(v->name, "vmexten")) {
812                                         if ((var = ast_var_assign("VOICEMAIL_EXTEN", v->value)))
813                                                 AST_LIST_INSERT_TAIL(&global_variables, var, entries);
814                                 }
815                                 if (!strcasecmp(v->name, "localextenlength")) {
816                                         if ((var = ast_var_assign("EXTENSION_LENGTH", v->value)))
817                                                 AST_LIST_INSERT_TAIL(&global_variables, var, entries);
818                                 }
819                         }
820                 }
821                           
822                 if (!strcasecmp(cat, "authentication"))
823                         continue;
824
825                 if (!((tmp = ast_variable_retrieve(cfg, cat, "autoprov")) && ast_true(tmp)))    
826                         continue;
827
828                 if (!(mac = ast_variable_retrieve(cfg, cat, "macaddress"))) {
829                         ast_log(LOG_WARNING, "autoprov set for %s, but no mac address - skipping.\n", cat);
830                         continue;
831                 }
832
833                 tmp = S_OR(ast_variable_retrieve(cfg, cat, "profile"), global_default_profile);
834                 if (ast_strlen_zero(tmp)) {
835                         ast_log(LOG_WARNING, "No profile for user [%s] with mac '%s' - skipping\n", cat, mac);
836                         continue;
837                 }
838
839                 if (!(profile = find_profile(tmp))) {
840                         ast_log(LOG_WARNING, "Could not look up profile '%s' - skipping.\n", tmp);
841                         continue;
842                 }
843
844                 if (!(user = build_user(cfg, cat, mac, profile))) {
845                         ast_log(LOG_WARNING, "Could not create user %s - skipping.\n", cat);
846                         continue;
847                 }
848
849                 if (build_user_routes(user)) {
850                         ast_log(LOG_WARNING, "Could not create http routes for %s - skipping\n", user->name);
851                         delete_user(user);
852                         continue;
853                 }
854
855                 AST_RWLIST_WRLOCK(&users);
856                 AST_RWLIST_INSERT_TAIL(&users, user, entry);
857                 AST_RWLIST_UNLOCK(&users);
858         }
859
860         ast_config_destroy(cfg);
861
862         return 0;
863 }
864
865 /*! \brief Delete all http routes, freeing their memory */
866 static void delete_routes(void)
867 {
868         struct ao2_iterator i;
869         struct http_route *route;
870         
871         i = ao2_iterator_init(http_routes, 0);
872         while ((route = ao2_iterator_next(&i))) {
873                 ao2_unlink(http_routes, route);
874                 route = unref_route(route);
875         }
876 }
877
878 /*! \brief Delete all phone profiles, freeing their memory */
879 static void delete_profiles(void)
880 {
881         struct ao2_iterator i;
882         struct phone_profile *profile;
883
884         i = ao2_iterator_init(profiles, 0);
885         while ((profile = ao2_iterator_next(&i))) {
886                 ao2_unlink(profiles, profile);
887                 profile = unref_profile(profile);
888         }
889 }
890
891 /*! \brief A dialplan function that can be used to print a string for each phoneprov user */
892 static int pp_each_user_exec(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
893 {
894         char *tmp, expand_buf[VAR_BUF_SIZE] = {0,};
895         struct user *user;
896         AST_DECLARE_APP_ARGS(args,
897                 AST_APP_ARG(string);
898                 AST_APP_ARG(exclude_mac);
899         );
900         AST_STANDARD_APP_ARGS(args, data);
901
902         /* Fix data by turning %{ into ${ */
903         while ((tmp = strstr(args.string, "%{")))
904                 *tmp = '$';
905
906         AST_RWLIST_RDLOCK(&users);
907         AST_RWLIST_TRAVERSE(&users, user, entry) {
908                 if (!ast_strlen_zero(args.exclude_mac) && !strcasecmp(user->macaddress, args.exclude_mac))
909                         continue;
910                 pbx_substitute_variables_varshead(user->headp, args.string, expand_buf, sizeof(expand_buf));
911                 ast_build_string(&buf, &len, expand_buf);
912         }
913         AST_RWLIST_UNLOCK(&users);
914
915         return 0;
916 }
917
918 static struct ast_custom_function pp_each_user_function = {
919         .name = "PP_EACH_USER",
920         .synopsis = "Generate a string for each phoneprov user",
921         .syntax = "PP_EACH_USER(<string>|<exclude_mac>)",
922         .desc =
923                 "Pass in a string, with phoneprov variables you want substituted in the format of\n"
924                 "%{VARNAME}, and you will get the string rendered for each user in phoneprov\n"
925                 "excluding ones with MAC address <exclude_mac>. Probably not useful outside of\n"
926                 "res_phoneprov.\n"
927                 "\nExample: ${PP_EACH_USER(<item><fn>%{DISPLAY_NAME}</fn></item>|${MAC})",
928         .read = pp_each_user_exec,
929 };
930
931 /*! \brief CLI command to list static and dynamic routes */
932 static char *handle_show_routes(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
933 {
934 #define FORMAT "%-40.40s  %-30.30s\n"
935         struct ao2_iterator i;
936         struct http_route *route;
937         
938         switch(cmd) {
939         case CLI_INIT:
940                 e->command = "phoneprov show routes";
941                 e->usage =
942                         "Usage: phoneprov show routes\n"
943                         "       Lists all registered phoneprov http routes.\n";
944                 return NULL;
945         case CLI_GENERATE:
946                 return NULL;
947         }
948
949         /* This currently iterates over routes twice, but it is the only place I've needed
950          * to really separate static an dynamic routes, so I've just left it this way. */
951         ast_cli(a->fd, "Static routes\n\n");
952         ast_cli(a->fd, FORMAT, "Relative URI", "Physical location");
953         i = ao2_iterator_init(http_routes, 0);
954         while ((route = ao2_iterator_next(&i))) {
955                 if (!route->user)
956                         ast_cli(a->fd, FORMAT, route->uri, route->file->template);
957                 route = unref_route(route);
958         }
959
960         ast_cli(a->fd, "\nDynamic routes\n\n");
961         ast_cli(a->fd, FORMAT, "Relative URI", "Template");
962
963         i = ao2_iterator_init(http_routes, 0);
964         while ((route = ao2_iterator_next(&i))) {
965                 if (route->user)
966                         ast_cli(a->fd, FORMAT, route->uri, route->file->template);
967                 route = unref_route(route);
968         }
969
970         return CLI_SUCCESS;
971 }
972
973 static struct ast_cli_entry pp_cli[] = {
974         AST_CLI_DEFINE(handle_show_routes, "Show registered phoneprov http routes"),
975 };
976
977 static struct ast_http_uri phoneprovuri = {
978         .callback = phoneprov_callback,
979         .description = "Asterisk HTTP Phone Provisioning Tool",
980         .uri = "phoneprov",
981         .has_subtree = 1,
982 };
983
984 static int load_module(void)
985 {
986         profiles = ao2_container_alloc(MAX_PROFILE_BUCKETS, profile_hash_fn, profile_cmp_fn);
987
988         http_routes = ao2_container_alloc(MAX_ROUTE_BUCKETS, routes_hash_fn, routes_cmp_fn);
989
990         AST_LIST_HEAD_INIT_NOLOCK(&global_variables);
991         
992         ast_custom_function_register(&pp_each_user_function);
993         ast_cli_register_multiple(pp_cli, ARRAY_LEN(pp_cli));
994
995         set_config();
996         ast_http_uri_link(&phoneprovuri); 
997
998         return 0;
999 }
1000
1001 static int unload_module(void)
1002 {
1003         struct ast_var_t *var;
1004
1005         ast_http_uri_unlink(&phoneprovuri);
1006         ast_custom_function_unregister(&pp_each_user_function);
1007         ast_cli_unregister_multiple(pp_cli, ARRAY_LEN(pp_cli));
1008
1009         delete_routes();
1010         delete_users();
1011         delete_profiles();
1012         ao2_ref(profiles, -1);
1013         ao2_ref(http_routes, -1);
1014
1015         while ((var = AST_LIST_REMOVE_HEAD(&global_variables, entries)))
1016                 ast_var_delete(var);
1017
1018         return 0;
1019 }
1020
1021 static int reload(void) 
1022 {
1023         delete_routes();
1024         delete_users();
1025         delete_profiles();
1026         set_config();
1027
1028         return 0;
1029 }
1030
1031 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "HTTP Phone Provisioning",
1032                 .load = load_module,
1033                 .unload = unload_module,
1034                 .reload = reload,
1035         );