Merged revisions 284610 via svnmerge from
[asterisk/asterisk.git] / apps / app_voicemail.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  * \author Mark Spencer <markster@digium.com>
22  * \brief Comedian Mail - Voicemail System
23  *
24  * \extref unixODBC (http://www.unixodbc.org/)
25  * \extref A source distribution of University of Washington's IMAP c-client
26  *         (http://www.washington.edu/imap/)
27  *
28  * \par See also
29  * \arg \ref Config_vm
30  * \note For information about voicemail IMAP storage, read doc/imapstorage.txt
31  * \ingroup applications
32  * \note This module requires res_adsi to load. This needs to be optional
33  * during compilation.
34  *
35  * \note This file is now almost impossible to work with, due to all \#ifdefs.
36  *       Feels like the database code before realtime. Someone - please come up
37  *       with a plan to clean this up.
38  */
39
40 /*** MODULEINFO
41         <use>res_adsi</use>
42         <use>res_smdi</use>
43  ***/
44
45 /*** MAKEOPTS
46 <category name="MENUSELECT_OPTS_app_voicemail" displayname="Voicemail Build Options" positive_output="yes" touch_on_change="apps/app_voicemail.c apps/app_directory.c">
47         <member name="FILE_STORAGE" displayname="Storage of Voicemail using filesystem">
48                 <conflict>ODBC_STORAGE</conflict>
49                 <conflict>IMAP_STORAGE</conflict>
50                 <defaultenabled>yes</defaultenabled>
51         </member>
52         <member name="ODBC_STORAGE" displayname="Storage of Voicemail using ODBC">
53                 <depend>generic_odbc</depend>
54                 <depend>ltdl</depend>
55                 <conflict>IMAP_STORAGE</conflict>
56                 <conflict>FILE_STORAGE</conflict>
57                 <defaultenabled>no</defaultenabled>
58         </member>
59         <member name="IMAP_STORAGE" displayname="Storage of Voicemail using IMAP4">
60                 <depend>imap_tk</depend>
61                 <conflict>ODBC_STORAGE</conflict>
62                 <conflict>FILE_STORAGE</conflict>
63                 <use>openssl</use>
64                 <defaultenabled>no</defaultenabled>
65         </member>
66 </category>
67 ***/
68
69 #include "asterisk.h"
70
71 #ifdef IMAP_STORAGE
72 #include <ctype.h>
73 #include <signal.h>
74 #include <pwd.h>
75 #ifdef USE_SYSTEM_IMAP
76 #include <imap/c-client.h>
77 #include <imap/imap4r1.h>
78 #include <imap/linkage.h>
79 #elif defined (USE_SYSTEM_CCLIENT)
80 #include <c-client/c-client.h>
81 #include <c-client/imap4r1.h>
82 #include <c-client/linkage.h>
83 #else
84 #include "c-client.h"
85 #include "imap4r1.h"
86 #include "linkage.h"
87 #endif
88 #endif
89
90 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
91
92 #include "asterisk/paths.h"     /* use ast_config_AST_SPOOL_DIR */
93 #include <sys/time.h>
94 #include <sys/stat.h>
95 #include <sys/mman.h>
96 #include <time.h>
97 #include <dirent.h>
98 #if defined(__FreeBSD__) || defined(__OpenBSD__)
99 #include <sys/wait.h>
100 #endif
101
102 #include "asterisk/logger.h"
103 #include "asterisk/lock.h"
104 #include "asterisk/file.h"
105 #include "asterisk/channel.h"
106 #include "asterisk/pbx.h"
107 #include "asterisk/config.h"
108 #include "asterisk/say.h"
109 #include "asterisk/module.h"
110 #include "asterisk/adsi.h"
111 #include "asterisk/app.h"
112 #include "asterisk/manager.h"
113 #include "asterisk/dsp.h"
114 #include "asterisk/localtime.h"
115 #include "asterisk/cli.h"
116 #include "asterisk/utils.h"
117 #include "asterisk/stringfields.h"
118 #include "asterisk/smdi.h"
119 #include "asterisk/astobj2.h"
120 #include "asterisk/event.h"
121 #include "asterisk/taskprocessor.h"
122 #include "asterisk/test.h"
123
124 #ifdef ODBC_STORAGE
125 #include "asterisk/res_odbc.h"
126 #endif
127
128 #ifdef IMAP_STORAGE
129 #include "asterisk/threadstorage.h"
130 #endif
131
132 /*** DOCUMENTATION
133         <application name="VoiceMail" language="en_US">
134                 <synopsis>
135                         Leave a Voicemail message.
136                 </synopsis>
137                 <syntax>
138                         <parameter name="mailboxs" argsep="&amp;" required="true">
139                                 <argument name="mailbox1" argsep="@" required="true">
140                                         <argument name="mailbox" required="true" />
141                                         <argument name="context" />
142                                 </argument>
143                                 <argument name="mailbox2" argsep="@" multiple="true">
144                                         <argument name="mailbox" required="true" />
145                                         <argument name="context" />
146                                 </argument>
147                         </parameter>
148                         <parameter name="options">
149                                 <optionlist>
150                                         <option name="b">
151                                                 <para>Play the <literal>busy</literal> greeting to the calling party.</para>
152                                         </option>
153                                         <option name="d">
154                                                 <argument name="c" />
155                                                 <para>Accept digits for a new extension in context <replaceable>c</replaceable>,
156                                                 if played during the greeting. Context defaults to the current context.</para>
157                                         </option>
158                                         <option name="g">
159                                                 <argument name="#" required="true" />
160                                                 <para>Use the specified amount of gain when recording the voicemail
161                                                 message. The units are whole-number decibels (dB). Only works on supported
162                                                 technologies, which is DAHDI only.</para>
163                                         </option>
164                                         <option name="s">
165                                                 <para>Skip the playback of instructions for leaving a message to the
166                                                 calling party.</para>
167                                         </option>
168                                         <option name="u">
169                                                 <para>Play the <literal>unavailable</literal> greeting.</para>
170                                         </option>
171                                         <option name="U">
172                                                 <para>Mark message as <literal>URGENT</literal>.</para>
173                                         </option>
174                                         <option name="P">
175                                                 <para>Mark message as <literal>PRIORITY</literal>.</para>
176                                         </option>
177                                 </optionlist>
178                         </parameter>
179                 </syntax>
180                 <description>
181                         <para>This application allows the calling party to leave a message for the specified
182                         list of mailboxes. When multiple mailboxes are specified, the greeting will be taken from
183                         the first mailbox specified. Dialplan execution will stop if the specified mailbox does not
184                         exist.</para>
185                         <para>The Voicemail application will exit if any of the following DTMF digits are received:</para>
186                         <enumlist>
187                                 <enum name="0">
188                                         <para>Jump to the <literal>o</literal> extension in the current dialplan context.</para>
189                                 </enum>
190                                 <enum name="*">
191                                         <para>Jump to the <literal>a</literal> extension in the current dialplan context.</para>
192                                 </enum>
193                         </enumlist>
194                         <para>This application will set the following channel variable upon completion:</para>
195                         <variablelist>
196                                 <variable name="VMSTATUS">
197                                         <para>This indicates the status of the execution of the VoiceMail application.</para>
198                                         <value name="SUCCESS" />
199                                         <value name="USEREXIT" />
200                                         <value name="FAILED" />
201                                 </variable>
202                         </variablelist>
203                 </description>
204         </application>
205         <application name="VoiceMailMain" language="en_US">
206                 <synopsis>
207                         Check Voicemail messages.
208                 </synopsis>
209                 <syntax>
210                         <parameter name="mailbox" required="true" argsep="@">
211                                 <argument name="mailbox" />
212                                 <argument name="context" />
213                         </parameter>
214                         <parameter name="options">
215                                 <optionlist>
216                                         <option name="p">
217                                                 <para>Consider the <replaceable>mailbox</replaceable> parameter as a prefix to
218                                                 the mailbox that is entered by the caller.</para>
219                                         </option>
220                                         <option name="g">
221                                                 <argument name="#" required="true" />
222                                                 <para>Use the specified amount of gain when recording a voicemail message.
223                                                 The units are whole-number decibels (dB).</para>
224                                         </option>
225                                         <option name="s">
226                                                 <para>Skip checking the passcode for the mailbox.</para>
227                                         </option>
228                                         <option name="a">
229                                                 <argument name="folder" required="true" />
230                                                 <para>Skip folder prompt and go directly to <replaceable>folder</replaceable> specified.
231                                                 Defaults to <literal>INBOX</literal> (or <literal>0</literal>).</para>
232                                                 <enumlist>
233                                                         <enum name="0"><para>INBOX</para></enum>
234                                                         <enum name="1"><para>Old</para></enum>
235                                                         <enum name="2"><para>Work</para></enum>
236                                                         <enum name="3"><para>Family</para></enum>
237                                                         <enum name="4"><para>Friends</para></enum>
238                                                         <enum name="5"><para>Cust1</para></enum>
239                                                         <enum name="6"><para>Cust2</para></enum>
240                                                         <enum name="7"><para>Cust3</para></enum>
241                                                         <enum name="8"><para>Cust4</para></enum>
242                                                         <enum name="9"><para>Cust5</para></enum>
243                                                 </enumlist>
244                                         </option>
245                                 </optionlist>
246                         </parameter>
247                 </syntax>
248                 <description>
249                         <para>This application allows the calling party to check voicemail messages. A specific
250                         <replaceable>mailbox</replaceable>, and optional corresponding <replaceable>context</replaceable>,
251                         may be specified. If a <replaceable>mailbox</replaceable> is not provided, the calling party will
252                         be prompted to enter one. If a <replaceable>context</replaceable> is not specified, the
253                         <literal>default</literal> context will be used.</para>
254                         <para>The VoiceMailMain application will exit if the following DTMF digit is entered as Mailbox
255                         or Password, and the extension exists:</para>
256                         <enumlist>
257                                 <enum name="*">
258                                         <para>Jump to the <literal>a</literal> extension in the current dialplan context.</para>
259                                 </enum>
260                         </enumlist>
261                 </description>
262         </application>
263         <application name="MailboxExists" language="en_US">
264                 <synopsis>
265                         Check to see if Voicemail mailbox exists.
266                 </synopsis>
267                 <syntax>
268                         <parameter name="mailbox" required="true" argsep="@">
269                                 <argument name="mailbox" required="true" />
270                                 <argument name="context" />
271                         </parameter>
272                         <parameter name="options">
273                                 <para>None options.</para>
274                         </parameter>
275                 </syntax>
276                 <description>
277                         <para>Check to see if the specified <replaceable>mailbox</replaceable> exists. If no voicemail
278                         <replaceable>context</replaceable> is specified, the <literal>default</literal> context
279                         will be used.</para>
280                         <para>This application will set the following channel variable upon completion:</para>
281                         <variablelist>
282                                 <variable name="VMBOXEXISTSSTATUS">
283                                         <para>This will contain the status of the execution of the MailboxExists application.
284                                         Possible values include:</para>
285                                         <value name="SUCCESS" />
286                                         <value name="FAILED" />
287                                 </variable>
288                         </variablelist>
289                 </description>
290         </application>
291         <application name="VMAuthenticate" language="en_US">
292                 <synopsis>
293                         Authenticate with Voicemail passwords.
294                 </synopsis>
295                 <syntax>
296                         <parameter name="mailbox" required="true" argsep="@">
297                                 <argument name="mailbox" />
298                                 <argument name="context" />
299                         </parameter>
300                         <parameter name="options">
301                                 <optionlist>
302                                         <option name="s">
303                                                 <para>Skip playing the initial prompts.</para>
304                                         </option>
305                                 </optionlist>
306                         </parameter>
307                 </syntax>
308                 <description>
309                         <para>This application behaves the same way as the Authenticate application, but the passwords
310                         are taken from <filename>voicemail.conf</filename>. If the <replaceable>mailbox</replaceable> is
311                         specified, only that mailbox's password will be considered valid. If the <replaceable>mailbox</replaceable>
312                         is not specified, the channel variable <variable>AUTH_MAILBOX</variable> will be set with the authenticated
313                         mailbox.</para>
314                         <para>The VMAuthenticate application will exit if the following DTMF digit is entered as Mailbox
315                         or Password, and the extension exists:</para>
316                         <enumlist>
317                                 <enum name="*">
318                                         <para>Jump to the <literal>a</literal> extension in the current dialplan context.</para>
319                                 </enum>
320                         </enumlist>
321                 </description>
322         </application>
323         <application name="VMSayName" language="en_US">
324                 <synopsis>
325                         Play the name of a voicemail user
326                 </synopsis>
327                 <syntax>
328                         <parameter name="mailbox" required="true" argsep="@">
329                                 <argument name="mailbox" />
330                                 <argument name="context" />
331                         </parameter>
332                 </syntax>
333                 <description>
334                         <para>This application will say the recorded name of the voicemail user specified as the
335                         argument to this application. If no context is provided, <literal>default</literal> is assumed.</para>
336                 </description>
337         </application>
338         <function name="MAILBOX_EXISTS" language="en_US">
339                 <synopsis>
340                         Tell if a mailbox is configured.
341                 </synopsis>
342                 <syntax argsep="@">
343                         <parameter name="mailbox" required="true" />
344                         <parameter name="context" />
345                 </syntax>
346                 <description>
347                         <para>Returns a boolean of whether the corresponding <replaceable>mailbox</replaceable> exists.
348                         If <replaceable>context</replaceable> is not specified, defaults to the <literal>default</literal>
349                         context.</para>
350                 </description>
351         </function>
352         <manager name="VoicemailUsersList" language="en_US">
353                 <synopsis>
354                         List All Voicemail User Information.
355                 </synopsis>
356                 <syntax>
357                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
358                 </syntax>
359                 <description>
360                 </description>
361         </manager>
362  ***/
363
364 #ifdef IMAP_STORAGE
365 static char imapserver[48];
366 static char imapport[8];
367 static char imapflags[128];
368 static char imapfolder[64];
369 static char imapparentfolder[64] = "\0";
370 static char greetingfolder[64];
371 static char authuser[32];
372 static char authpassword[42];
373 static int imapversion = 1;
374
375 static int expungeonhangup = 1;
376 static int imapgreetings = 0;
377 static char delimiter = '\0';
378
379 struct vm_state;
380 struct ast_vm_user;
381
382 AST_THREADSTORAGE(ts_vmstate);
383
384 /* Forward declarations for IMAP */
385 static int init_mailstream(struct vm_state *vms, int box);
386 static void write_file(char *filename, char *buffer, unsigned long len);
387 static char *get_header_by_tag(char *header, char *tag, char *buf, size_t len);
388 static void vm_imap_delete(char *file, int msgnum, struct ast_vm_user *vmu);
389 static char *get_user_by_mailbox(char *mailbox, char *buf, size_t len);
390 static struct vm_state *get_vm_state_by_imapuser(const char *user, int interactive);
391 static struct vm_state *get_vm_state_by_mailbox(const char *mailbox, const char *context, int interactive);
392 static struct vm_state *create_vm_state_from_user(struct ast_vm_user *vmu);
393 static void vmstate_insert(struct vm_state *vms);
394 static void vmstate_delete(struct vm_state *vms);
395 static void set_update(MAILSTREAM * stream);
396 static void init_vm_state(struct vm_state *vms);
397 static int save_body(BODY *body, struct vm_state *vms, char *section, char *format, int is_intro);
398 static void get_mailbox_delimiter(MAILSTREAM *stream);
399 static void mm_parsequota (MAILSTREAM *stream, unsigned char *msg, QUOTALIST *pquota);
400 static void imap_mailbox_name(char *spec, size_t len, struct vm_state *vms, int box, int target);
401 static int imap_store_file(const char *dir, const char *mailboxuser, const char *mailboxcontext, int msgnum, struct ast_channel *chan, struct ast_vm_user *vmu, char *fmt, int duration, struct vm_state *vms, const char *flag);
402 static void update_messages_by_imapuser(const char *user, unsigned long number);
403 static int vm_delete(char *file);
404
405 static int imap_remove_file (char *dir, int msgnum);
406 static int imap_retrieve_file (const char *dir, const int msgnum, const char *mailbox, const char *context);
407 static int imap_delete_old_greeting (char *dir, struct vm_state *vms);
408 static void check_quota(struct vm_state *vms, char *mailbox);
409 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box);
410 struct vmstate {
411         struct vm_state *vms;
412         AST_LIST_ENTRY(vmstate) list;
413 };
414
415 static AST_LIST_HEAD_STATIC(vmstates, vmstate);
416
417 #endif
418
419 #define SMDI_MWI_WAIT_TIMEOUT 1000 /* 1 second */
420
421 #define COMMAND_TIMEOUT 5000
422 /* Don't modify these here; set your umask at runtime instead */
423 #define VOICEMAIL_DIR_MODE      0777
424 #define VOICEMAIL_FILE_MODE     0666
425 #define CHUNKSIZE       65536
426
427 #define VOICEMAIL_CONFIG "voicemail.conf"
428 #define ASTERISK_USERNAME "asterisk"
429
430 /* Define fast-forward, pause, restart, and reverse keys
431    while listening to a voicemail message - these are
432    strings, not characters */
433 #define DEFAULT_LISTEN_CONTROL_FORWARD_KEY "#"
434 #define DEFAULT_LISTEN_CONTROL_REVERSE_KEY "*"
435 #define DEFAULT_LISTEN_CONTROL_PAUSE_KEY "0"
436 #define DEFAULT_LISTEN_CONTROL_RESTART_KEY "2"
437 #define DEFAULT_LISTEN_CONTROL_STOP_KEY "13456789"
438 #define VALID_DTMF "1234567890*#" /* Yes ABCD are valid dtmf but what phones have those? */
439
440 /* Default mail command to mail voicemail. Change it with the
441     mailcmd= command in voicemail.conf */
442 #define SENDMAIL "/usr/sbin/sendmail -t"
443
444 #define INTRO "vm-intro"
445
446 #define MAXMSG 100
447 #define MAXMSGLIMIT 9999
448
449 #define MINPASSWORD 0 /*!< Default minimum mailbox password length */
450
451 #define BASELINELEN 72
452 #define BASEMAXINLINE 256
453 #ifdef IMAP_STORAGE
454 #define ENDL "\r\n"
455 #else
456 #define ENDL "\n"
457 #endif
458
459 #define MAX_DATETIME_FORMAT     512
460 #define MAX_NUM_CID_CONTEXTS 10
461
462 #define VM_REVIEW        (1 << 0)   /*!< After recording, permit the caller to review the recording before saving */
463 #define VM_OPERATOR      (1 << 1)   /*!< Allow 0 to be pressed to go to 'o' extension */
464 #define VM_SAYCID        (1 << 2)   /*!< Repeat the CallerID info during envelope playback */
465 #define VM_SVMAIL        (1 << 3)   /*!< Allow the user to compose a new VM from within VoicemailMain */
466 #define VM_ENVELOPE      (1 << 4)   /*!< Play the envelope information (who-from, time received, etc.) */
467 #define VM_SAYDURATION   (1 << 5)   /*!< Play the length of the message during envelope playback */
468 #define VM_SKIPAFTERCMD  (1 << 6)   /*!< After deletion, assume caller wants to go to the next message */
469 #define VM_FORCENAME     (1 << 7)   /*!< Have new users record their name */
470 #define VM_FORCEGREET    (1 << 8)   /*!< Have new users record their greetings */
471 #define VM_PBXSKIP       (1 << 9)   /*!< Skip the [PBX] preamble in the Subject line of emails */
472 #define VM_DIRECFORWARD  (1 << 10)  /*!< Permit caller to use the Directory app for selecting to which mailbox to forward a VM */
473 #define VM_ATTACH        (1 << 11)  /*!< Attach message to voicemail notifications? */
474 #define VM_DELETE        (1 << 12)  /*!< Delete message after sending notification */
475 #define VM_ALLOCED       (1 << 13)  /*!< Structure was malloc'ed, instead of placed in a return (usually static) buffer */
476 #define VM_SEARCH        (1 << 14)  /*!< Search all contexts for a matching mailbox */
477 #define VM_TEMPGREETWARN (1 << 15)  /*!< Remind user tempgreeting is set */
478 #define VM_MOVEHEARD     (1 << 16)  /*!< Move a "heard" message to Old after listening to it */
479 #define VM_MESSAGEWRAP   (1 << 17)  /*!< Wrap around from the last message to the first, and vice-versa */
480 #define VM_FWDURGAUTO    (1 << 18)  /*!< Autoset of Urgent flag on forwarded Urgent messages set globally */
481 #define ERROR_LOCK_PATH  -100
482 #define OPERATOR_EXIT     300
483
484
485 enum vm_box {
486         NEW_FOLDER,
487         OLD_FOLDER,
488         WORK_FOLDER,
489         FAMILY_FOLDER,
490         FRIENDS_FOLDER,
491         GREETINGS_FOLDER
492 };
493
494 enum vm_option_flags {
495         OPT_SILENT =           (1 << 0),
496         OPT_BUSY_GREETING =    (1 << 1),
497         OPT_UNAVAIL_GREETING = (1 << 2),
498         OPT_RECORDGAIN =       (1 << 3),
499         OPT_PREPEND_MAILBOX =  (1 << 4),
500         OPT_AUTOPLAY =         (1 << 6),
501         OPT_DTMFEXIT =         (1 << 7),
502         OPT_MESSAGE_Urgent =   (1 << 8),
503         OPT_MESSAGE_PRIORITY = (1 << 9)
504 };
505
506 enum vm_option_args {
507         OPT_ARG_RECORDGAIN = 0,
508         OPT_ARG_PLAYFOLDER = 1,
509         OPT_ARG_DTMFEXIT   = 2,
510         /* This *must* be the last value in this enum! */
511         OPT_ARG_ARRAY_SIZE = 3,
512 };
513
514 enum vm_passwordlocation {
515         OPT_PWLOC_VOICEMAILCONF = 0,
516         OPT_PWLOC_SPOOLDIR      = 1,
517         OPT_PWLOC_USERSCONF     = 2,
518 };
519
520 AST_APP_OPTIONS(vm_app_options, {
521         AST_APP_OPTION('s', OPT_SILENT),
522         AST_APP_OPTION('b', OPT_BUSY_GREETING),
523         AST_APP_OPTION('u', OPT_UNAVAIL_GREETING),
524         AST_APP_OPTION_ARG('g', OPT_RECORDGAIN, OPT_ARG_RECORDGAIN),
525         AST_APP_OPTION_ARG('d', OPT_DTMFEXIT, OPT_ARG_DTMFEXIT),
526         AST_APP_OPTION('p', OPT_PREPEND_MAILBOX),
527         AST_APP_OPTION_ARG('a', OPT_AUTOPLAY, OPT_ARG_PLAYFOLDER),
528         AST_APP_OPTION('U', OPT_MESSAGE_Urgent),
529         AST_APP_OPTION('P', OPT_MESSAGE_PRIORITY)
530 });
531
532 static int load_config(int reload);
533
534 /*! \page vmlang Voicemail Language Syntaxes Supported
535
536         \par Syntaxes supported, not really language codes.
537         \arg \b en    - English
538         \arg \b de    - German
539         \arg \b es    - Spanish
540         \arg \b fr    - French
541         \arg \b it    - Italian
542         \arg \b nl    - Dutch
543         \arg \b pt    - Portuguese
544         \arg \b pt_BR - Portuguese (Brazil)
545         \arg \b gr    - Greek
546         \arg \b no    - Norwegian
547         \arg \b se    - Swedish
548         \arg \b tw    - Chinese (Taiwan)
549         \arg \b ua - Ukrainian
550
551 German requires the following additional soundfile:
552 \arg \b 1F      einE (feminine)
553
554 Spanish requires the following additional soundfile:
555 \arg \b 1M      un (masculine)
556
557 Dutch, Portuguese & Spanish require the following additional soundfiles:
558 \arg \b vm-INBOXs       singular of 'new'
559 \arg \b vm-Olds         singular of 'old/heard/read'
560
561 NB these are plural:
562 \arg \b vm-INBOX        nieuwe (nl)
563 \arg \b vm-Old          oude (nl)
564
565 Polish uses:
566 \arg \b vm-new-a        'new', feminine singular accusative
567 \arg \b vm-new-e        'new', feminine plural accusative
568 \arg \b vm-new-ych      'new', feminine plural genitive
569 \arg \b vm-old-a        'old', feminine singular accusative
570 \arg \b vm-old-e        'old', feminine plural accusative
571 \arg \b vm-old-ych      'old', feminine plural genitive
572 \arg \b digits/1-a      'one', not always same as 'digits/1'
573 \arg \b digits/2-ie     'two', not always same as 'digits/2'
574
575 Swedish uses:
576 \arg \b vm-nytt         singular of 'new'
577 \arg \b vm-nya          plural of 'new'
578 \arg \b vm-gammalt      singular of 'old'
579 \arg \b vm-gamla        plural of 'old'
580 \arg \b digits/ett      'one', not always same as 'digits/1'
581
582 Norwegian uses:
583 \arg \b vm-ny           singular of 'new'
584 \arg \b vm-nye          plural of 'new'
585 \arg \b vm-gammel       singular of 'old'
586 \arg \b vm-gamle        plural of 'old'
587
588 Dutch also uses:
589 \arg \b nl-om           'at'?
590
591 Spanish also uses:
592 \arg \b vm-youhaveno
593
594 Italian requires the following additional soundfile:
595
596 For vm_intro_it:
597 \arg \b vm-nuovo        new
598 \arg \b vm-nuovi        new plural
599 \arg \b vm-vecchio      old
600 \arg \b vm-vecchi       old plural
601
602 Chinese (Taiwan) requires the following additional soundfile:
603 \arg \b vm-tong         A class-word for call (tong1)
604 \arg \b vm-ri           A class-word for day (ri4)
605 \arg \b vm-you          You (ni3)
606 \arg \b vm-haveno   Have no (mei2 you3)
607 \arg \b vm-have     Have (you3)
608 \arg \b vm-listen   To listen (yao4 ting1)
609
610
611 \note Don't use vm-INBOX or vm-Old, because they are the name of the INBOX and Old folders,
612 spelled among others when you have to change folder. For the above reasons, vm-INBOX
613 and vm-Old are spelled plural, to make them sound more as folder name than an adjective.
614
615 */
616
617 struct baseio {
618         int iocp;
619         int iolen;
620         int linelength;
621         int ateof;
622         unsigned char iobuf[BASEMAXINLINE];
623 };
624
625 /*! Structure for linked list of users 
626  * Use ast_vm_user_destroy() to free one of these structures. */
627 struct ast_vm_user {
628         char context[AST_MAX_CONTEXT];   /*!< Voicemail context */
629         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox id, unique within vm context */
630         char password[80];               /*!< Secret pin code, numbers only */
631         char fullname[80];               /*!< Full name, for directory app */
632         char email[80];                  /*!< E-mail address */
633         char *emailsubject;              /*!< E-mail subject */
634         char *emailbody;                 /*!< E-mail body */
635         char pager[80];                  /*!< E-mail address to pager (no attachment) */
636         char serveremail[80];            /*!< From: Mail address */
637         char mailcmd[160];               /*!< Configurable mail command */
638         char language[MAX_LANGUAGE];     /*!< Config: Language setting */
639         char zonetag[80];                /*!< Time zone */
640         char locale[20];                 /*!< The locale (for presentation of date/time) */
641         char callback[80];
642         char dialout[80];
643         char uniqueid[80];               /*!< Unique integer identifier */
644         char exit[80];
645         char attachfmt[20];              /*!< Attachment format */
646         unsigned int flags;              /*!< VM_ flags */      
647         int saydurationm;
648         int minsecs;                     /*!< Minimum number of seconds per message for this mailbox */
649         int maxmsg;                      /*!< Maximum number of msgs per folder for this mailbox */
650         int maxdeletedmsg;               /*!< Maximum number of deleted msgs saved for this mailbox */
651         int maxsecs;                     /*!< Maximum number of seconds per message for this mailbox */
652         int passwordlocation;            /*!< Storage location of the password */
653 #ifdef IMAP_STORAGE
654         char imapuser[80];               /*!< IMAP server login */
655         char imappassword[80];           /*!< IMAP server password if authpassword not defined */
656         char imapfolder[64];             /*!< IMAP voicemail folder */
657         char imapvmshareid[80];          /*!< Shared mailbox ID to use rather than the dialed one */
658         int imapversion;                 /*!< If configuration changes, use the new values */
659 #endif
660         double volgain;                  /*!< Volume gain for voicemails sent via email */
661         AST_LIST_ENTRY(ast_vm_user) list;
662 };
663
664 /*! Voicemail time zones */
665 struct vm_zone {
666         AST_LIST_ENTRY(vm_zone) list;
667         char name[80];
668         char timezone[80];
669         char msg_format[512];
670 };
671
672 #define VMSTATE_MAX_MSG_ARRAY 256
673
674 /*! Voicemail mailbox state */
675 struct vm_state {
676         char curbox[80];
677         char username[80];
678         char context[80];
679         char curdir[PATH_MAX];
680         char vmbox[PATH_MAX];
681         char fn[PATH_MAX];
682         char intro[PATH_MAX];
683         int *deleted;
684         int *heard;
685         int curmsg;
686         int lastmsg;
687         int newmessages;
688         int oldmessages;
689         int urgentmessages;
690         int starting;
691         int repeats;
692 #ifdef IMAP_STORAGE
693         ast_mutex_t lock;
694         int updated;                         /*!< decremented on each mail check until 1 -allows delay */
695         long msgArray[VMSTATE_MAX_MSG_ARRAY];
696         MAILSTREAM *mailstream;
697         int vmArrayIndex;
698         char imapuser[80];                   /*!< IMAP server login */
699         char imapfolder[64];                 /*!< IMAP voicemail folder */
700         int imapversion;
701         int interactive;
702         char introfn[PATH_MAX];              /*!< Name of prepended file */
703         unsigned int quota_limit;
704         unsigned int quota_usage;
705         struct vm_state *persist_vms;
706 #endif
707 };
708
709 #ifdef ODBC_STORAGE
710 static char odbc_database[80];
711 static char odbc_table[80];
712 #define RETRIEVE(a,b,c,d) retrieve_file(a,b)
713 #define DISPOSE(a,b) remove_file(a,b)
714 #define STORE(a,b,c,d,e,f,g,h,i,j) store_file(a,b,c,d)
715 #define EXISTS(a,b,c,d) (message_exists(a,b))
716 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(a,b,c,d,e,f))
717 #define COPY(a,b,c,d,e,f,g,h) (copy_file(a,b,c,d,e,f))
718 #define DELETE(a,b,c,d) (delete_file(a,b))
719 #else
720 #ifdef IMAP_STORAGE
721 #define DISPOSE(a,b) (imap_remove_file(a,b))
722 #define STORE(a,b,c,d,e,f,g,h,i,j) (imap_store_file(a,b,c,d,e,f,g,h,i,j))
723 #define RETRIEVE(a,b,c,d) imap_retrieve_file(a,b,c,d)
724 #define EXISTS(a,b,c,d) (ast_fileexists(c,NULL,d) > 0)
725 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(g,h));
726 #define COPY(a,b,c,d,e,f,g,h) (copy_file(g,h));
727 #define DELETE(a,b,c,d) (vm_imap_delete(a,b,d))
728 #else
729 #define RETRIEVE(a,b,c,d)
730 #define DISPOSE(a,b)
731 #define STORE(a,b,c,d,e,f,g,h,i,j)
732 #define EXISTS(a,b,c,d) (ast_fileexists(c,NULL,d) > 0)
733 #define RENAME(a,b,c,d,e,f,g,h) (rename_file(g,h));
734 #define COPY(a,b,c,d,e,f,g,h) (copy_plain_file(g,h)); 
735 #define DELETE(a,b,c,d) (vm_delete(c))
736 #endif
737 #endif
738
739 static char VM_SPOOL_DIR[PATH_MAX];
740
741 static char ext_pass_cmd[128];
742 static char ext_pass_check_cmd[128];
743
744 static int my_umask;
745
746 #define PWDCHANGE_INTERNAL (1 << 1)
747 #define PWDCHANGE_EXTERNAL (1 << 2)
748 static int pwdchange = PWDCHANGE_INTERNAL;
749
750 #ifdef ODBC_STORAGE
751 #define tdesc "Comedian Mail (Voicemail System) with ODBC Storage"
752 #else
753 # ifdef IMAP_STORAGE
754 # define tdesc "Comedian Mail (Voicemail System) with IMAP Storage"
755 # else
756 # define tdesc "Comedian Mail (Voicemail System)"
757 # endif
758 #endif
759
760 static char userscontext[AST_MAX_EXTENSION] = "default";
761
762 static char *addesc = "Comedian Mail";
763
764 /* Leave a message */
765 static char *app = "VoiceMail";
766
767 /* Check mail, control, etc */
768 static char *app2 = "VoiceMailMain";
769
770 static char *app3 = "MailboxExists";
771 static char *app4 = "VMAuthenticate";
772
773 static char *sayname_app = "VMSayName";
774
775 static AST_LIST_HEAD_STATIC(users, ast_vm_user);
776 static AST_LIST_HEAD_STATIC(zones, vm_zone);
777 static char zonetag[80];
778 static char locale[20];
779 static int maxsilence;
780 static int maxmsg;
781 static int maxdeletedmsg;
782 static int silencethreshold = 128;
783 static char serveremail[80];
784 static char mailcmd[160];       /* Configurable mail cmd */
785 static char externnotify[160]; 
786 static struct ast_smdi_interface *smdi_iface = NULL;
787 static char vmfmts[80];
788 static double volgain;
789 static int vmminsecs;
790 static int vmmaxsecs;
791 static int maxgreet;
792 static int skipms;
793 static int maxlogins;
794 static int minpassword;
795 static int passwordlocation;
796
797 /*! Poll mailboxes for changes since there is something external to
798  *  app_voicemail that may change them. */
799 static unsigned int poll_mailboxes;
800
801 /*! Polling frequency */
802 static unsigned int poll_freq;
803 /*! By default, poll every 30 seconds */
804 #define DEFAULT_POLL_FREQ 30
805
806 AST_MUTEX_DEFINE_STATIC(poll_lock);
807 static ast_cond_t poll_cond = PTHREAD_COND_INITIALIZER;
808 static pthread_t poll_thread = AST_PTHREADT_NULL;
809 static unsigned char poll_thread_run;
810
811 /*! Subscription to ... MWI event subscriptions */
812 static struct ast_event_sub *mwi_sub_sub;
813 /*! Subscription to ... MWI event un-subscriptions */
814 static struct ast_event_sub *mwi_unsub_sub;
815
816 /*!
817  * \brief An MWI subscription
818  *
819  * This is so we can keep track of which mailboxes are subscribed to.
820  * This way, we know which mailboxes to poll when the pollmailboxes
821  * option is being used.
822  */
823 struct mwi_sub {
824         AST_RWLIST_ENTRY(mwi_sub) entry;
825         int old_urgent;
826         int old_new;
827         int old_old;
828         uint32_t uniqueid;
829         char mailbox[1];
830 };
831
832 struct mwi_sub_task {
833         const char *mailbox;
834         const char *context;
835         uint32_t uniqueid;
836 };
837
838 static struct ast_taskprocessor *mwi_subscription_tps;
839
840 static AST_RWLIST_HEAD_STATIC(mwi_subs, mwi_sub);
841
842 /* custom audio control prompts for voicemail playback */
843 static char listen_control_forward_key[12];
844 static char listen_control_reverse_key[12];
845 static char listen_control_pause_key[12];
846 static char listen_control_restart_key[12];
847 static char listen_control_stop_key[12];
848
849 /* custom password sounds */
850 static char vm_password[80] = "vm-password";
851 static char vm_newpassword[80] = "vm-newpassword";
852 static char vm_passchanged[80] = "vm-passchanged";
853 static char vm_reenterpassword[80] = "vm-reenterpassword";
854 static char vm_mismatch[80] = "vm-mismatch";
855 static char vm_invalid_password[80] = "vm-invalid-password";
856 static char vm_pls_try_again[80] = "vm-pls-try-again";
857
858 static struct ast_flags globalflags = {0};
859
860 static int saydurationminfo;
861
862 static char dialcontext[AST_MAX_CONTEXT] = "";
863 static char callcontext[AST_MAX_CONTEXT] = "";
864 static char exitcontext[AST_MAX_CONTEXT] = "";
865
866 static char cidinternalcontexts[MAX_NUM_CID_CONTEXTS][64];
867
868
869 static char *emailbody = NULL;
870 static char *emailsubject = NULL;
871 static char *pagerbody = NULL;
872 static char *pagersubject = NULL;
873 static char fromstring[100];
874 static char pagerfromstring[100];
875 static char charset[32] = "ISO-8859-1";
876
877 static unsigned char adsifdn[4] = "\x00\x00\x00\x0F";
878 static unsigned char adsisec[4] = "\x9B\xDB\xF7\xAC";
879 static int adsiver = 1;
880 static char emaildateformat[32] = "%A, %B %d, %Y at %r";
881 static char pagerdateformat[32] = "%A, %B %d, %Y at %r";
882
883 /* Forward declarations - generic */
884 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box);
885 static int advanced_options(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, int msg, int option, signed char record_gain);
886 static int dialout(struct ast_channel *chan, struct ast_vm_user *vmu, char *num, char *outgoing_context);
887 static int play_record_review(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime,
888                         char *fmt, int outsidecaller, struct ast_vm_user *vmu, int *duration, const char *unlockdir,
889                         signed char record_gain, struct vm_state *vms, char *flag);
890 static int vm_tempgreeting(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, char *fmtc, signed char record_gain);
891 static int vm_play_folder_name(struct ast_channel *chan, char *mbox);
892 static int notify_new_message(struct ast_channel *chan, struct ast_vm_user *vmu, struct vm_state *vms, int msgnum, long duration, char *fmt, char *cidnum, char *cidname, const char *flag);
893 static void make_email_file(FILE *p, char *srcemail, struct ast_vm_user *vmu, int msgnum, char *context, char *mailbox, const char *fromfolder, char *cidnum, char *cidname, char *attach, char *attach2, char *format, int duration, int attach_user_voicemail, struct ast_channel *chan, const char *category, int imap, const char *flag);
894 static void apply_options(struct ast_vm_user *vmu, const char *options);
895 static int add_email_attachment(FILE *p, struct ast_vm_user *vmu, char *format, char *attach, char *greeting_attachment, char *mailbox, char *bound, char *filename, int last, int msgnum);
896 static int is_valid_dtmf(const char *key);
897 static void read_password_from_file(const char *secretfn, char *password, int passwordlen);
898 static int write_password_to_file(const char *secretfn, const char *password);
899
900 struct ao2_container *inprocess_container;
901
902 struct inprocess {
903         int count;
904         char *context;
905         char mailbox[0];
906 };
907
908 static int inprocess_hash_fn(const void *obj, const int flags)
909 {
910         const struct inprocess *i = obj;
911         return atoi(i->mailbox);
912 }
913
914 static int inprocess_cmp_fn(void *obj, void *arg, int flags)
915 {
916         struct inprocess *i = obj, *j = arg;
917         if (!strcmp(i->mailbox, j->mailbox)) {
918                 return 0;
919         }
920         return !strcmp(i->context, j->context) ? CMP_MATCH : 0;
921 }
922
923 static int inprocess_count(const char *context, const char *mailbox, int delta)
924 {
925         struct inprocess *i, *arg = alloca(sizeof(*arg) + strlen(context) + strlen(mailbox) + 2);
926         arg->context = arg->mailbox + strlen(mailbox) + 1;
927         strcpy(arg->mailbox, mailbox); /* SAFE */
928         strcpy(arg->context, context); /* SAFE */
929         ao2_lock(inprocess_container);
930         if ((i = ao2_find(inprocess_container, arg, 0))) {
931                 int ret = ast_atomic_fetchadd_int(&i->count, delta);
932                 ao2_unlock(inprocess_container);
933                 ao2_ref(i, -1);
934                 return ret;
935         }
936         if (!(i = ao2_alloc(sizeof(*i) + strlen(context) + strlen(mailbox) + 2, NULL))) {
937                 ao2_unlock(inprocess_container);
938                 return 0;
939         }
940         i->context = i->mailbox + strlen(mailbox) + 1;
941         strcpy(i->mailbox, mailbox); /* SAFE */
942         strcpy(i->context, context); /* SAFE */
943         i->count = delta;
944         ao2_link(inprocess_container, i);
945         ao2_unlock(inprocess_container);
946         ao2_ref(i, -1);
947         return 0;
948 }
949
950 #if !(defined(ODBC_STORAGE) || defined(IMAP_STORAGE))
951 static int __has_voicemail(const char *context, const char *mailbox, const char *folder, int shortcircuit);
952 #endif
953
954 /*!
955  * \brief Strips control and non 7-bit clean characters from input string.
956  *
957  * \note To map control and none 7-bit characters to a 7-bit clean characters
958  *  please use ast_str_encode_mine().
959  */
960 static char *strip_control_and_high(const char *input, char *buf, size_t buflen)
961 {
962         char *bufptr = buf;
963         for (; *input; input++) {
964                 if (*input < 32) {
965                         continue;
966                 }
967                 *bufptr++ = *input;
968                 if (bufptr == buf + buflen - 1) {
969                         break;
970                 }
971         }
972         *bufptr = '\0';
973         return buf;
974 }
975
976
977 /*!
978  * \brief Sets default voicemail system options to a voicemail user.
979  *
980  * This applies select global settings to a newly created (dynamic) instance of a voicemail user.
981  * - all the globalflags
982  * - the saydurationminfo
983  * - the callcontext
984  * - the dialcontext
985  * - the exitcontext
986  * - vmmaxsecs, vmmaxmsg, maxdeletedmsg
987  * - volume gain.
988  */
989 static void populate_defaults(struct ast_vm_user *vmu)
990 {
991         ast_copy_flags(vmu, (&globalflags), AST_FLAGS_ALL);     
992         vmu->passwordlocation = passwordlocation;
993         if (saydurationminfo) {
994                 vmu->saydurationm = saydurationminfo;
995         }
996         ast_copy_string(vmu->callback, callcontext, sizeof(vmu->callback));
997         ast_copy_string(vmu->dialout, dialcontext, sizeof(vmu->dialout));
998         ast_copy_string(vmu->exit, exitcontext, sizeof(vmu->exit));
999         ast_copy_string(vmu->zonetag, zonetag, sizeof(vmu->zonetag));
1000         ast_copy_string(vmu->locale, locale, sizeof(vmu->locale));
1001         if (vmminsecs) {
1002                 vmu->minsecs = vmminsecs;
1003         }
1004         if (vmmaxsecs) {
1005                 vmu->maxsecs = vmmaxsecs;
1006         }
1007         if (maxmsg) {
1008                 vmu->maxmsg = maxmsg;
1009         }
1010         if (maxdeletedmsg) {
1011                 vmu->maxdeletedmsg = maxdeletedmsg;
1012         }
1013         vmu->volgain = volgain;
1014         vmu->emailsubject = NULL;
1015         vmu->emailbody = NULL;
1016 #ifdef IMAP_STORAGE
1017         ast_copy_string(vmu->imapfolder, imapfolder, sizeof(vmu->imapfolder));
1018 #endif
1019 }
1020
1021 /*!
1022  * \brief Sets a a specific property value.
1023  * \param vmu The voicemail user object to work with.
1024  * \param var The name of the property to be set.
1025  * \param value The value to be set to the property.
1026  * 
1027  * The property name must be one of the understood properties. See the source for details.
1028  */
1029 static void apply_option(struct ast_vm_user *vmu, const char *var, const char *value)
1030 {
1031         int x;
1032         if (!strcasecmp(var, "attach")) {
1033                 ast_set2_flag(vmu, ast_true(value), VM_ATTACH);
1034         } else if (!strcasecmp(var, "attachfmt")) {
1035                 ast_copy_string(vmu->attachfmt, value, sizeof(vmu->attachfmt));
1036         } else if (!strcasecmp(var, "serveremail")) {
1037                 ast_copy_string(vmu->serveremail, value, sizeof(vmu->serveremail));
1038         } else if (!strcasecmp(var, "language")) {
1039                 ast_copy_string(vmu->language, value, sizeof(vmu->language));
1040         } else if (!strcasecmp(var, "tz")) {
1041                 ast_copy_string(vmu->zonetag, value, sizeof(vmu->zonetag));
1042         } else if (!strcasecmp(var, "locale")) {
1043                 ast_copy_string(vmu->locale, value, sizeof(vmu->locale));
1044 #ifdef IMAP_STORAGE
1045         } else if (!strcasecmp(var, "imapuser")) {
1046                 ast_copy_string(vmu->imapuser, value, sizeof(vmu->imapuser));
1047                 vmu->imapversion = imapversion;
1048         } else if (!strcasecmp(var, "imappassword") || !strcasecmp(var, "imapsecret")) {
1049                 ast_copy_string(vmu->imappassword, value, sizeof(vmu->imappassword));
1050                 vmu->imapversion = imapversion;
1051         } else if (!strcasecmp(var, "imapfolder")) {
1052                 ast_copy_string(vmu->imapfolder, value, sizeof(vmu->imapfolder));
1053         } else if (!strcasecmp(var, "imapvmshareid")) {
1054                 ast_copy_string(vmu->imapvmshareid, value, sizeof(vmu->imapvmshareid));
1055                 vmu->imapversion = imapversion;
1056 #endif
1057         } else if (!strcasecmp(var, "delete") || !strcasecmp(var, "deletevoicemail")) {
1058                 ast_set2_flag(vmu, ast_true(value), VM_DELETE); 
1059         } else if (!strcasecmp(var, "saycid")){
1060                 ast_set2_flag(vmu, ast_true(value), VM_SAYCID); 
1061         } else if (!strcasecmp(var, "sendvoicemail")){
1062                 ast_set2_flag(vmu, ast_true(value), VM_SVMAIL); 
1063         } else if (!strcasecmp(var, "review")){
1064                 ast_set2_flag(vmu, ast_true(value), VM_REVIEW);
1065         } else if (!strcasecmp(var, "tempgreetwarn")){
1066                 ast_set2_flag(vmu, ast_true(value), VM_TEMPGREETWARN);  
1067         } else if (!strcasecmp(var, "messagewrap")){
1068                 ast_set2_flag(vmu, ast_true(value), VM_MESSAGEWRAP);    
1069         } else if (!strcasecmp(var, "operator")) {
1070                 ast_set2_flag(vmu, ast_true(value), VM_OPERATOR);       
1071         } else if (!strcasecmp(var, "envelope")){
1072                 ast_set2_flag(vmu, ast_true(value), VM_ENVELOPE);       
1073         } else if (!strcasecmp(var, "moveheard")){
1074                 ast_set2_flag(vmu, ast_true(value), VM_MOVEHEARD);
1075         } else if (!strcasecmp(var, "sayduration")){
1076                 ast_set2_flag(vmu, ast_true(value), VM_SAYDURATION);    
1077         } else if (!strcasecmp(var, "saydurationm")){
1078                 if (sscanf(value, "%30d", &x) == 1) {
1079                         vmu->saydurationm = x;
1080                 } else {
1081                         ast_log(AST_LOG_WARNING, "Invalid min duration for say duration\n");
1082                 }
1083         } else if (!strcasecmp(var, "forcename")){
1084                 ast_set2_flag(vmu, ast_true(value), VM_FORCENAME);      
1085         } else if (!strcasecmp(var, "forcegreetings")){
1086                 ast_set2_flag(vmu, ast_true(value), VM_FORCEGREET);     
1087         } else if (!strcasecmp(var, "callback")) {
1088                 ast_copy_string(vmu->callback, value, sizeof(vmu->callback));
1089         } else if (!strcasecmp(var, "dialout")) {
1090                 ast_copy_string(vmu->dialout, value, sizeof(vmu->dialout));
1091         } else if (!strcasecmp(var, "exitcontext")) {
1092                 ast_copy_string(vmu->exit, value, sizeof(vmu->exit));
1093         } else if (!strcasecmp(var, "minsecs")) {
1094                 if (sscanf(value, "%30d", &x) == 1 && x >= 0) {
1095                         vmu->minsecs = x;
1096                 } else {
1097                         ast_log(LOG_WARNING, "Invalid min message length of %s. Using global value %d\n", value, vmminsecs);
1098                         vmu->minsecs = vmminsecs;
1099                 }
1100         } else if (!strcasecmp(var, "maxmessage") || !strcasecmp(var, "maxsecs")) {
1101                 vmu->maxsecs = atoi(value);
1102                 if (vmu->maxsecs <= 0) {
1103                         ast_log(AST_LOG_WARNING, "Invalid max message length of %s. Using global value %d\n", value, vmmaxsecs);
1104                         vmu->maxsecs = vmmaxsecs;
1105                 } else {
1106                         vmu->maxsecs = atoi(value);
1107                 }
1108                 if (!strcasecmp(var, "maxmessage"))
1109                         ast_log(AST_LOG_WARNING, "Option 'maxmessage' has been deprecated in favor of 'maxsecs'.  Please make that change in your voicemail config.\n");
1110         } else if (!strcasecmp(var, "maxmsg")) {
1111                 vmu->maxmsg = atoi(value);
1112                 /* Accept maxmsg=0 (Greetings only voicemail) */
1113                 if (vmu->maxmsg < 0) {
1114                         ast_log(AST_LOG_WARNING, "Invalid number of messages per folder maxmsg=%s. Using default value %d\n", value, MAXMSG);
1115                         vmu->maxmsg = MAXMSG;
1116                 } else if (vmu->maxmsg > MAXMSGLIMIT) {
1117                         ast_log(AST_LOG_WARNING, "Maximum number of messages per folder is %d. Cannot accept value maxmsg=%s\n", MAXMSGLIMIT, value);
1118                         vmu->maxmsg = MAXMSGLIMIT;
1119                 }
1120         } else if (!strcasecmp(var, "nextaftercmd")) {
1121                 ast_set2_flag(vmu, ast_true(value), VM_SKIPAFTERCMD);
1122         } else if (!strcasecmp(var, "backupdeleted")) {
1123                 if (sscanf(value, "%30d", &x) == 1)
1124                         vmu->maxdeletedmsg = x;
1125                 else if (ast_true(value))
1126                         vmu->maxdeletedmsg = MAXMSG;
1127                 else
1128                         vmu->maxdeletedmsg = 0;
1129
1130                 if (vmu->maxdeletedmsg < 0) {
1131                         ast_log(AST_LOG_WARNING, "Invalid number of deleted messages saved per mailbox backupdeleted=%s. Using default value %d\n", value, MAXMSG);
1132                         vmu->maxdeletedmsg = MAXMSG;
1133                 } else if (vmu->maxdeletedmsg > MAXMSGLIMIT) {
1134                         ast_log(AST_LOG_WARNING, "Maximum number of deleted messages saved per mailbox is %d. Cannot accept value backupdeleted=%s\n", MAXMSGLIMIT, value);
1135                         vmu->maxdeletedmsg = MAXMSGLIMIT;
1136                 }
1137         } else if (!strcasecmp(var, "volgain")) {
1138                 sscanf(value, "%30lf", &vmu->volgain);
1139         } else if (!strcasecmp(var, "passwordlocation")) {
1140                 if (!strcasecmp(value, "spooldir")) {
1141                         vmu->passwordlocation = OPT_PWLOC_SPOOLDIR;
1142                 } else {
1143                         vmu->passwordlocation = OPT_PWLOC_VOICEMAILCONF;
1144                 }
1145         } else if (!strcasecmp(var, "options")) {
1146                 apply_options(vmu, value);
1147         }
1148 }
1149
1150 static char *vm_check_password_shell(char *command, char *buf, size_t len) 
1151 {
1152         int fds[2], pid = 0;
1153
1154         memset(buf, 0, len);
1155
1156         if (pipe(fds)) {
1157                 snprintf(buf, len, "FAILURE: Pipe failed: %s", strerror(errno));
1158         } else {
1159                 /* good to go*/
1160                 pid = ast_safe_fork(0);
1161
1162                 if (pid < 0) {
1163                         /* ok maybe not */
1164                         close(fds[0]);
1165                         close(fds[1]);
1166                         snprintf(buf, len, "FAILURE: Fork failed");
1167                 } else if (pid) {
1168                         /* parent */
1169                         close(fds[1]);
1170                         if (read(fds[0], buf, len) < 0) {
1171                                 ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
1172                         }
1173                         close(fds[0]);
1174                 } else {
1175                         /*  child */
1176                         AST_DECLARE_APP_ARGS(arg,
1177                                 AST_APP_ARG(v)[20];
1178                         );
1179                         char *mycmd = ast_strdupa(command);
1180
1181                         close(fds[0]);
1182                         dup2(fds[1], STDOUT_FILENO);
1183                         close(fds[1]);
1184                         ast_close_fds_above_n(STDOUT_FILENO);
1185
1186                         AST_NONSTANDARD_APP_ARGS(arg, mycmd, ' ');
1187
1188                         execv(arg.v[0], arg.v); 
1189                         printf("FAILURE: %s", strerror(errno));
1190                         _exit(0);
1191                 }
1192         }
1193         return buf;
1194 }
1195
1196 /*!
1197  * \brief Check that password meets minimum required length
1198  * \param vmu The voicemail user to change the password for.
1199  * \param password The password string to check
1200  *
1201  * \return zero on ok, 1 on not ok.
1202  */
1203 static int check_password(struct ast_vm_user *vmu, char *password)
1204 {
1205         /* check minimum length */
1206         if (strlen(password) < minpassword)
1207                 return 1;
1208         if (!ast_strlen_zero(ext_pass_check_cmd)) {
1209                 char cmd[255], buf[255];
1210
1211                 ast_log(AST_LOG_DEBUG, "Verify password policies for %s\n", password);
1212
1213                 snprintf(cmd, sizeof(cmd), "%s %s %s %s %s", ext_pass_check_cmd, vmu->mailbox, vmu->context, vmu->password, password);
1214                 if (vm_check_password_shell(cmd, buf, sizeof(buf))) {
1215                         ast_debug(5, "Result: %s\n", buf);
1216                         if (!strncasecmp(buf, "VALID", 5)) {
1217                                 ast_debug(3, "Passed password check: '%s'\n", buf);
1218                                 return 0;
1219                         } else if (!strncasecmp(buf, "FAILURE", 7)) {
1220                                 ast_log(AST_LOG_WARNING, "Unable to execute password validation script: '%s'.\n", buf);
1221                                 return 0;
1222                         } else {
1223                                 ast_log(AST_LOG_NOTICE, "Password doesn't match policies for user %s %s\n", vmu->mailbox, password);
1224                                 return 1;
1225                         }
1226                 }
1227         }
1228         return 0;
1229 }
1230
1231 /*! 
1232  * \brief Performs a change of the voicemail passowrd in the realtime engine.
1233  * \param vmu The voicemail user to change the password for.
1234  * \param password The new value to be set to the password for this user.
1235  * 
1236  * This only works if there is a realtime engine configured.
1237  * This is called from the (top level) vm_change_password.
1238  *
1239  * \return zero on success, -1 on error.
1240  */
1241 static int change_password_realtime(struct ast_vm_user *vmu, const char *password)
1242 {
1243         int res = -1;
1244         if (!strcmp(vmu->password, password)) {
1245                 /* No change (but an update would return 0 rows updated, so we opt out here) */
1246                 return 0;
1247         }
1248
1249         if (strlen(password) > 10) {
1250                 ast_realtime_require_field("voicemail", "password", RQ_CHAR, strlen(password), SENTINEL);
1251         }
1252         if (ast_update2_realtime("voicemail", "context", vmu->context, "mailbox", vmu->mailbox, SENTINEL, "password", password, SENTINEL) > 0) {
1253                 ast_copy_string(vmu->password, password, sizeof(vmu->password));
1254                 res = 0;
1255         }
1256         return res;
1257 }
1258
1259 /*!
1260  * \brief Destructively Parse options and apply.
1261  */
1262 static void apply_options(struct ast_vm_user *vmu, const char *options)
1263 {       
1264         char *stringp;
1265         char *s;
1266         char *var, *value;
1267         stringp = ast_strdupa(options);
1268         while ((s = strsep(&stringp, "|"))) {
1269                 value = s;
1270                 if ((var = strsep(&value, "=")) && value) {
1271                         apply_option(vmu, var, value);
1272                 }
1273         }       
1274 }
1275
1276 /*!
1277  * \brief Loads the options specific to a voicemail user.
1278  * 
1279  * This is called when a vm_user structure is being set up, such as from load_options.
1280  */
1281 static void apply_options_full(struct ast_vm_user *retval, struct ast_variable *var)
1282 {
1283         for (; var; var = var->next) {
1284                 if (!strcasecmp(var->name, "vmsecret")) {
1285                         ast_copy_string(retval->password, var->value, sizeof(retval->password));
1286                 } else if (!strcasecmp(var->name, "secret") || !strcasecmp(var->name, "password")) { /* don't overwrite vmsecret if it exists */
1287                         if (ast_strlen_zero(retval->password))
1288                                 ast_copy_string(retval->password, var->value, sizeof(retval->password));
1289                 } else if (!strcasecmp(var->name, "uniqueid")) {
1290                         ast_copy_string(retval->uniqueid, var->value, sizeof(retval->uniqueid));
1291                 } else if (!strcasecmp(var->name, "pager")) {
1292                         ast_copy_string(retval->pager, var->value, sizeof(retval->pager));
1293                 } else if (!strcasecmp(var->name, "email")) {
1294                         ast_copy_string(retval->email, var->value, sizeof(retval->email));
1295                 } else if (!strcasecmp(var->name, "fullname")) {
1296                         ast_copy_string(retval->fullname, var->value, sizeof(retval->fullname));
1297                 } else if (!strcasecmp(var->name, "context")) {
1298                         ast_copy_string(retval->context, var->value, sizeof(retval->context));
1299                 } else if (!strcasecmp(var->name, "emailsubject")) {
1300                         retval->emailsubject = ast_strdup(var->value);
1301                 } else if (!strcasecmp(var->name, "emailbody")) {
1302                         retval->emailbody = ast_strdup(var->value);
1303 #ifdef IMAP_STORAGE
1304                 } else if (!strcasecmp(var->name, "imapuser")) {
1305                         ast_copy_string(retval->imapuser, var->value, sizeof(retval->imapuser));
1306                         retval->imapversion = imapversion;
1307                 } else if (!strcasecmp(var->name, "imappassword") || !strcasecmp(var->name, "imapsecret")) {
1308                         ast_copy_string(retval->imappassword, var->value, sizeof(retval->imappassword));
1309                         retval->imapversion = imapversion;
1310                 } else if (!strcasecmp(var->name, "imapfolder")) {
1311                         ast_copy_string(retval->imapfolder, var->value, sizeof(retval->imapfolder));
1312                 } else if (!strcasecmp(var->name, "imapvmshareid")) {
1313                         ast_copy_string(retval->imapvmshareid, var->value, sizeof(retval->imapvmshareid));
1314                         retval->imapversion = imapversion;
1315 #endif
1316                 } else
1317                         apply_option(retval, var->name, var->value);
1318         }
1319 }
1320
1321 /*!
1322  * \brief Determines if a DTMF key entered is valid.
1323  * \param key The character to be compared. expects a single character. Though is capable of handling a string, this is internally copies using ast_strdupa.
1324  *
1325  * Tests the character entered against the set of valid DTMF characters. 
1326  * \return 1 if the character entered is a valid DTMF digit, 0 if the character is invalid.
1327  */
1328 static int is_valid_dtmf(const char *key)
1329 {
1330         int i;
1331         char *local_key = ast_strdupa(key);
1332
1333         for (i = 0; i < strlen(key); ++i) {
1334                 if (!strchr(VALID_DTMF, *local_key)) {
1335                         ast_log(AST_LOG_WARNING, "Invalid DTMF key \"%c\" used in voicemail configuration file\n", *local_key);
1336                         return 0;
1337                 }
1338                 local_key++;
1339         }
1340         return 1;
1341 }
1342
1343 /*!
1344  * \brief Finds a voicemail user from the realtime engine.
1345  * \param ivm
1346  * \param context
1347  * \param mailbox
1348  *
1349  * This is called as a fall through case when the normal find_user() was not able to find a user. That is, the default it so look in the usual voicemail users file first.
1350  *
1351  * \return The ast_vm_user structure for the user that was found.
1352  */
1353 static struct ast_vm_user *find_user_realtime(struct ast_vm_user *ivm, const char *context, const char *mailbox)
1354 {
1355         struct ast_variable *var;
1356         struct ast_vm_user *retval;
1357
1358         if ((retval = (ivm ? ivm : ast_calloc(1, sizeof(*retval))))) {
1359                 if (!ivm)
1360                         ast_set_flag(retval, VM_ALLOCED);       
1361                 else
1362                         memset(retval, 0, sizeof(*retval));
1363                 if (mailbox) 
1364                         ast_copy_string(retval->mailbox, mailbox, sizeof(retval->mailbox));
1365                 populate_defaults(retval);
1366                 if (!context && ast_test_flag((&globalflags), VM_SEARCH))
1367                         var = ast_load_realtime("voicemail", "mailbox", mailbox, SENTINEL);
1368                 else
1369                         var = ast_load_realtime("voicemail", "mailbox", mailbox, "context", context, SENTINEL);
1370                 if (var) {
1371                         apply_options_full(retval, var);
1372                         ast_variables_destroy(var);
1373                 } else { 
1374                         if (!ivm) 
1375                                 ast_free(retval);
1376                         retval = NULL;
1377                 }       
1378         } 
1379         return retval;
1380 }
1381
1382 /*!
1383  * \brief Finds a voicemail user from the users file or the realtime engine.
1384  * \param ivm
1385  * \param context
1386  * \param mailbox
1387  * 
1388  * \return The ast_vm_user structure for the user that was found.
1389  */
1390 static struct ast_vm_user *find_user(struct ast_vm_user *ivm, const char *context, const char *mailbox)
1391 {
1392         /* This function could be made to generate one from a database, too */
1393         struct ast_vm_user *vmu = NULL, *cur;
1394         AST_LIST_LOCK(&users);
1395
1396         if (!context && !ast_test_flag((&globalflags), VM_SEARCH))
1397                 context = "default";
1398
1399         AST_LIST_TRAVERSE(&users, cur, list) {
1400 #ifdef IMAP_STORAGE
1401                 if (cur->imapversion != imapversion) {
1402                         continue;
1403                 }
1404 #endif
1405                 if (ast_test_flag((&globalflags), VM_SEARCH) && !strcasecmp(mailbox, cur->mailbox))
1406                         break;
1407                 if (context && (!strcasecmp(context, cur->context)) && (!strcasecmp(mailbox, cur->mailbox)))
1408                         break;
1409         }
1410         if (cur) {
1411                 /* Make a copy, so that on a reload, we have no race */
1412                 if ((vmu = (ivm ? ivm : ast_malloc(sizeof(*vmu))))) {
1413                         memcpy(vmu, cur, sizeof(*vmu));
1414                         ast_set2_flag(vmu, !ivm, VM_ALLOCED);
1415                         AST_LIST_NEXT(vmu, list) = NULL;
1416                 }
1417         } else
1418                 vmu = find_user_realtime(ivm, context, mailbox);
1419         AST_LIST_UNLOCK(&users);
1420         return vmu;
1421 }
1422
1423 /*!
1424  * \brief Resets a user password to a specified password.
1425  * \param context
1426  * \param mailbox
1427  * \param newpass
1428  *
1429  * This does the actual change password work, called by the vm_change_password() function.
1430  *
1431  * \return zero on success, -1 on error.
1432  */
1433 static int reset_user_pw(const char *context, const char *mailbox, const char *newpass)
1434 {
1435         /* This function could be made to generate one from a database, too */
1436         struct ast_vm_user *cur;
1437         int res = -1;
1438         AST_LIST_LOCK(&users);
1439         AST_LIST_TRAVERSE(&users, cur, list) {
1440                 if ((!context || !strcasecmp(context, cur->context)) &&
1441                         (!strcasecmp(mailbox, cur->mailbox)))
1442                                 break;
1443         }
1444         if (cur) {
1445                 ast_copy_string(cur->password, newpass, sizeof(cur->password));
1446                 res = 0;
1447         }
1448         AST_LIST_UNLOCK(&users);
1449         return res;
1450 }
1451
1452 /*! 
1453  * \brief The handler for the change password option.
1454  * \param vmu The voicemail user to work with.
1455  * \param newpassword The new password (that has been gathered from the appropriate prompting).
1456  * This is called when a new user logs in for the first time and the option to force them to change their password is set.
1457  * It is also called when the user wants to change their password from menu option '5' on the mailbox options menu.
1458  */
1459 static void vm_change_password(struct ast_vm_user *vmu, const char *newpassword)
1460 {
1461         struct ast_config   *cfg = NULL;
1462         struct ast_variable *var = NULL;
1463         struct ast_category *cat = NULL;
1464         char *category = NULL, *value = NULL, *new = NULL;
1465         const char *tmp = NULL;
1466         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS };
1467         char secretfn[PATH_MAX] = "";
1468         int found = 0;
1469
1470         if (!change_password_realtime(vmu, newpassword))
1471                 return;
1472
1473         /* check if we should store the secret in the spool directory next to the messages */
1474         switch (vmu->passwordlocation) {
1475         case OPT_PWLOC_SPOOLDIR:
1476                 snprintf(secretfn, sizeof(secretfn), "%s%s/%s/secret.conf", VM_SPOOL_DIR, vmu->context, vmu->mailbox);
1477                 if (write_password_to_file(secretfn, newpassword) == 0) {
1478                         ast_verb(4, "Writing voicemail password to file %s succeeded\n", secretfn);
1479                         reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1480                         ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1481                         break;
1482                 } else {
1483                         ast_verb(4, "Writing voicemail password to file %s failed, falling back to config file\n", secretfn);
1484                 }
1485                 /* Fall-through */
1486         case OPT_PWLOC_VOICEMAILCONF:
1487                 if ((cfg = ast_config_load(VOICEMAIL_CONFIG, config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
1488                         while ((category = ast_category_browse(cfg, category))) {
1489                                 if (!strcasecmp(category, vmu->context)) {
1490                                         if (!(tmp = ast_variable_retrieve(cfg, category, vmu->mailbox))) {
1491                                                 ast_log(AST_LOG_WARNING, "We could not find the mailbox.\n");
1492                                                 break;
1493                                         }
1494                                         value = strstr(tmp, ",");
1495                                         if (!value) {
1496                                                 ast_log(AST_LOG_WARNING, "variable has bad format.\n");
1497                                                 break;
1498                                         }
1499                                         new = alloca((strlen(value) + strlen(newpassword) + 1));
1500                                         sprintf(new, "%s%s", newpassword, value);
1501                                         if (!(cat = ast_category_get(cfg, category))) {
1502                                                 ast_log(AST_LOG_WARNING, "Failed to get category structure.\n");
1503                                                 break;
1504                                         }
1505                                         ast_variable_update(cat, vmu->mailbox, new, NULL, 0);
1506                                         found = 1;
1507                                 }
1508                         }
1509                         /* save the results */
1510                         if (found) {
1511                                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1512                                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1513                                 ast_config_text_file_save(VOICEMAIL_CONFIG, cfg, "AppVoicemail");
1514                                 break;
1515                         }
1516                 }
1517                 /* Fall-through */
1518         case OPT_PWLOC_USERSCONF:
1519                 /* check users.conf and update the password stored for the mailbox */
1520                 /* if no vmsecret entry exists create one. */
1521                 if ((cfg = ast_config_load("users.conf", config_flags)) && cfg != CONFIG_STATUS_FILEINVALID) {
1522                         ast_debug(4, "we are looking for %s\n", vmu->mailbox);
1523                         for (category = ast_category_browse(cfg, NULL); category; category = ast_category_browse(cfg, category)) {
1524                                 ast_debug(4, "users.conf: %s\n", category);
1525                                 if (!strcasecmp(category, vmu->mailbox)) {
1526                                         if (!(tmp = ast_variable_retrieve(cfg, category, "vmsecret"))) {
1527                                                 ast_debug(3, "looks like we need to make vmsecret!\n");
1528                                                 var = ast_variable_new("vmsecret", newpassword, "");
1529                                         } else {
1530                                                 var = NULL;
1531                                         }
1532                                         new = alloca(strlen(newpassword) + 1);
1533                                         sprintf(new, "%s", newpassword);
1534                                         if (!(cat = ast_category_get(cfg, category))) {
1535                                                 ast_debug(4, "failed to get category!\n");
1536                                                 ast_free(var);
1537                                                 break;
1538                                         }
1539                                         if (!var) {
1540                                                 ast_variable_update(cat, "vmsecret", new, NULL, 0);
1541                                         } else {
1542                                                 ast_variable_append(cat, var);
1543                                         }
1544                                         found = 1;
1545                                         break;
1546                                 }
1547                         }
1548                         /* save the results and clean things up */
1549                         if (found) {
1550                                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1551                                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1552                                 ast_config_text_file_save("users.conf", cfg, "AppVoicemail");
1553                         }
1554                 }
1555         }
1556 }
1557
1558 static void vm_change_password_shell(struct ast_vm_user *vmu, char *newpassword)
1559 {
1560         char buf[255];
1561         snprintf(buf, sizeof(buf), "%s %s %s %s", ext_pass_cmd, vmu->context, vmu->mailbox, newpassword);
1562         if (!ast_safe_system(buf)) {
1563                 ast_copy_string(vmu->password, newpassword, sizeof(vmu->password));
1564                 /* Reset the password in memory, too */
1565                 reset_user_pw(vmu->context, vmu->mailbox, newpassword);
1566         }
1567 }
1568
1569 /*! 
1570  * \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
1571  * \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
1572  * \param len The length of the path string that was written out.
1573  * \param context
1574  * \param ext 
1575  * \param folder 
1576  * 
1577  * The path is constructed as 
1578  *      VM_SPOOL_DIRcontext/ext/folder
1579  *
1580  * \return zero on success, -1 on error.
1581  */
1582 static int make_dir(char *dest, int len, const char *context, const char *ext, const char *folder)
1583 {
1584         return snprintf(dest, len, "%s%s/%s/%s", VM_SPOOL_DIR, context, ext, folder);
1585 }
1586
1587 /*! 
1588  * \brief Creates a file system path expression for a folder within the voicemail data folder and the appropriate context.
1589  * \param dest The variable to hold the output generated path expression. This buffer should be of size PATH_MAX.
1590  * \param len The length of the path string that was written out.
1591  * \param dir 
1592  * \param num 
1593  * 
1594  * The path is constructed as 
1595  *      VM_SPOOL_DIRcontext/ext/folder
1596  *
1597  * \return zero on success, -1 on error.
1598  */
1599 static int make_file(char *dest, const int len, const char *dir, const int num)
1600 {
1601         return snprintf(dest, len, "%s/msg%04d", dir, num);
1602 }
1603
1604 /* same as mkstemp, but return a FILE * */
1605 static FILE *vm_mkftemp(char *template)
1606 {
1607         FILE *p = NULL;
1608         int pfd = mkstemp(template);
1609         chmod(template, VOICEMAIL_FILE_MODE & ~my_umask);
1610         if (pfd > -1) {
1611                 p = fdopen(pfd, "w+");
1612                 if (!p) {
1613                         close(pfd);
1614                         pfd = -1;
1615                 }
1616         }
1617         return p;
1618 }
1619
1620 /*! \brief basically mkdir -p $dest/$context/$ext/$folder
1621  * \param dest    String. base directory.
1622  * \param len     Length of dest.
1623  * \param context String. Ignored if is null or empty string.
1624  * \param ext     String. Ignored if is null or empty string.
1625  * \param folder  String. Ignored if is null or empty string. 
1626  * \return -1 on failure, 0 on success.
1627  */
1628 static int create_dirpath(char *dest, int len, const char *context, const char *ext, const char *folder)
1629 {
1630         mode_t  mode = VOICEMAIL_DIR_MODE;
1631         int res;
1632
1633         make_dir(dest, len, context, ext, folder);
1634         if ((res = ast_mkdir(dest, mode))) {
1635                 ast_log(AST_LOG_WARNING, "ast_mkdir '%s' failed: %s\n", dest, strerror(res));
1636                 return -1;
1637         }
1638         return 0;
1639 }
1640
1641 static const char * const mailbox_folders[] = {
1642 #ifdef IMAP_STORAGE
1643         imapfolder,
1644 #else
1645         "INBOX",
1646 #endif
1647         "Old",
1648         "Work",
1649         "Family",
1650         "Friends",
1651         "Cust1",
1652         "Cust2",
1653         "Cust3",
1654         "Cust4",
1655         "Cust5",
1656         "Deleted",
1657         "Urgent",
1658 };
1659
1660 static const char *mbox(struct ast_vm_user *vmu, int id)
1661 {
1662 #ifdef IMAP_STORAGE
1663         if (vmu && id == 0) {
1664                 return vmu->imapfolder;
1665         }
1666 #endif
1667         return (id >= 0 && id < ARRAY_LEN(mailbox_folders)) ? mailbox_folders[id] : "Unknown";
1668 }
1669
1670 static int get_folder_by_name(const char *name)
1671 {
1672         size_t i;
1673
1674         for (i = 0; i < ARRAY_LEN(mailbox_folders); i++) {
1675                 if (strcasecmp(name, mailbox_folders[i]) == 0) {
1676                         return i;
1677                 }
1678         }
1679
1680         return -1;
1681 }
1682
1683 static void free_user(struct ast_vm_user *vmu)
1684 {
1685         if (ast_test_flag(vmu, VM_ALLOCED)) {
1686                 if (vmu->emailbody != NULL) {
1687                         ast_free(vmu->emailbody);
1688                         vmu->emailbody = NULL;
1689                 }
1690                 if (vmu->emailsubject != NULL) {
1691                         ast_free(vmu->emailsubject);
1692                         vmu->emailsubject = NULL;
1693                 }
1694                 ast_free(vmu);
1695         }
1696 }
1697
1698 /* All IMAP-specific functions should go in this block. This
1699  * keeps them from being spread out all over the code */
1700 #ifdef IMAP_STORAGE
1701 static void vm_imap_delete(char *file, int msgnum, struct ast_vm_user *vmu)
1702 {
1703         char arg[10];
1704         struct vm_state *vms;
1705         unsigned long messageNum;
1706
1707         /* If greetings aren't stored in IMAP, just delete the file */
1708         if (msgnum < 0 && !imapgreetings) {
1709                 ast_filedelete(file, NULL);
1710                 return;
1711         }
1712
1713         if (!(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && !(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1714                 ast_log(LOG_WARNING, "Couldn't find a vm_state for mailbox %s. Unable to set \\DELETED flag for message %d\n", vmu->mailbox, msgnum);
1715                 return;
1716         }
1717
1718         /* find real message number based on msgnum */
1719         /* this may be an index into vms->msgArray based on the msgnum. */
1720         messageNum = vms->msgArray[msgnum];
1721         if (messageNum == 0) {
1722                 ast_log(LOG_WARNING, "msgnum %d, mailbox message %lu is zero.\n", msgnum, messageNum);
1723                 return;
1724         }
1725         if (option_debug > 2)
1726                 ast_log(LOG_DEBUG, "deleting msgnum %d, which is mailbox message %lu\n", msgnum, messageNum);
1727         /* delete message */
1728         snprintf (arg, sizeof(arg), "%lu", messageNum);
1729         ast_mutex_lock(&vms->lock);
1730         mail_setflag (vms->mailstream, arg, "\\DELETED");
1731         mail_expunge(vms->mailstream);
1732         ast_mutex_unlock(&vms->lock);
1733 }
1734
1735 static int imap_retrieve_greeting(const char *dir, const int msgnum, struct ast_vm_user *vmu)
1736 {
1737         struct vm_state *vms_p;
1738         char *file, *filename;
1739         char *attachment;
1740         int ret = 0, i;
1741         BODY *body;
1742
1743         /* This function is only used for retrieval of IMAP greetings
1744          * regular messages are not retrieved this way, nor are greetings
1745          * if they are stored locally*/
1746         if (msgnum > -1 || !imapgreetings) {
1747                 return 0;
1748         } else {
1749                 file = strrchr(ast_strdupa(dir), '/');
1750                 if (file)
1751                         *file++ = '\0';
1752                 else {
1753                         ast_debug (1, "Failed to procure file name from directory passed.\n");
1754                         return -1;
1755                 }
1756         }
1757
1758         /* check if someone is accessing this box right now... */
1759         if (!(vms_p = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && 
1760                 !(vms_p = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1761                 /* Unlike when retrieving a message, it is reasonable not to be able to find a 
1762                 * vm_state for a mailbox when trying to retrieve a greeting. Just create one,
1763                 * that's all we need to do.
1764                 */
1765                 if (!(vms_p = create_vm_state_from_user(vmu))) {
1766                         ast_log(LOG_NOTICE, "Unable to create vm_state object!\n");
1767                         return -1;
1768                 }
1769         }
1770         
1771         /* Greetings will never have a prepended message */
1772         *vms_p->introfn = '\0';
1773
1774         ast_mutex_lock(&vms_p->lock);
1775         ret = init_mailstream(vms_p, GREETINGS_FOLDER);
1776         if (!vms_p->mailstream) {
1777                 ast_log(AST_LOG_ERROR, "IMAP mailstream is NULL\n");
1778                 ast_mutex_unlock(&vms_p->lock);
1779                 return -1;
1780         }
1781
1782         /*XXX Yuck, this could probably be done a lot better */
1783         for (i = 0; i < vms_p->mailstream->nmsgs; i++) {
1784                 mail_fetchstructure(vms_p->mailstream, i + 1, &body);
1785                 /* We have the body, now we extract the file name of the first attachment. */
1786                 if (body->nested.part && body->nested.part->next && body->nested.part->next->body.parameter->value) {
1787                         attachment = ast_strdupa(body->nested.part->next->body.parameter->value);
1788                 } else {
1789                         ast_log(AST_LOG_ERROR, "There is no file attached to this IMAP message.\n");
1790                         ast_mutex_unlock(&vms_p->lock);
1791                         return -1;
1792                 }
1793                 filename = strsep(&attachment, ".");
1794                 if (!strcmp(filename, file)) {
1795                         ast_copy_string(vms_p->fn, dir, sizeof(vms_p->fn));
1796                         vms_p->msgArray[vms_p->curmsg] = i + 1;
1797                         save_body(body, vms_p, "2", attachment, 0);
1798                         ast_mutex_unlock(&vms_p->lock);
1799                         return 0;
1800                 }
1801         }
1802         ast_mutex_unlock(&vms_p->lock);
1803
1804         return -1;
1805 }
1806
1807 static int imap_retrieve_file(const char *dir, const int msgnum, const char *mailbox, const char *context)
1808 {
1809         BODY *body;
1810         char *header_content;
1811         char *attachedfilefmt;
1812         char buf[80];
1813         struct vm_state *vms;
1814         char text_file[PATH_MAX];
1815         FILE *text_file_ptr;
1816         int res = 0;
1817         struct ast_vm_user *vmu;
1818
1819         if (!(vmu = find_user(NULL, context, mailbox))) {
1820                 ast_log(LOG_WARNING, "Couldn't find user with mailbox %s@%s\n", mailbox, context);
1821                 return -1;
1822         }
1823         
1824         if (msgnum < 0) {
1825                 if (imapgreetings) {
1826                         res = imap_retrieve_greeting(dir, msgnum, vmu);
1827                         goto exit;
1828                 } else {
1829                         res = 0;
1830                         goto exit;
1831                 }
1832         }
1833
1834         /* Before anything can happen, we need a vm_state so that we can
1835          * actually access the imap server through the vms->mailstream
1836          */
1837         if (!(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 1)) && !(vms = get_vm_state_by_mailbox(vmu->mailbox, vmu->context, 0))) {
1838                 /* This should not happen. If it does, then I guess we'd
1839                  * need to create the vm_state, extract which mailbox to
1840                  * open, and then set up the msgArray so that the correct
1841                  * IMAP message could be accessed. If I have seen correctly
1842                  * though, the vms should be obtainable from the vmstates list
1843                  * and should have its msgArray properly set up.
1844                  */
1845                 ast_log(LOG_ERROR, "Couldn't find a vm_state for mailbox %s!!! Oh no!\n", vmu->mailbox);
1846                 res = -1;
1847                 goto exit;
1848         }
1849         
1850         make_file(vms->fn, sizeof(vms->fn), dir, msgnum);
1851         snprintf(vms->introfn, sizeof(vms->introfn), "%sintro", vms->fn);
1852
1853         /* Don't try to retrieve a message from IMAP if it already is on the file system */
1854         if (ast_fileexists(vms->fn, NULL, NULL) > 0) {
1855                 res = 0;
1856                 goto exit;
1857         }
1858
1859         if (option_debug > 2)
1860                 ast_log(LOG_DEBUG, "Before mail_fetchheaders, curmsg is: %d, imap messages is %lu\n", msgnum, vms->msgArray[msgnum]);
1861         if (vms->msgArray[msgnum] == 0) {
1862                 ast_log(LOG_WARNING, "Trying to access unknown message\n");
1863                 res = -1;
1864                 goto exit;
1865         }
1866
1867         /* This will only work for new messages... */
1868         ast_mutex_lock(&vms->lock);
1869         header_content = mail_fetchheader (vms->mailstream, vms->msgArray[msgnum]);
1870         ast_mutex_unlock(&vms->lock);
1871         /* empty string means no valid header */
1872         if (ast_strlen_zero(header_content)) {
1873                 ast_log(LOG_ERROR, "Could not fetch header for message number %ld\n", vms->msgArray[msgnum]);
1874                 res = -1;
1875                 goto exit;
1876         }
1877
1878         ast_mutex_lock(&vms->lock);
1879         mail_fetchstructure(vms->mailstream, vms->msgArray[msgnum], &body);
1880         ast_mutex_unlock(&vms->lock);
1881
1882         /* We have the body, now we extract the file name of the first attachment. */
1883         if (body->nested.part && body->nested.part->next && body->nested.part->next->body.parameter->value) {
1884                 attachedfilefmt = ast_strdupa(body->nested.part->next->body.parameter->value);
1885         } else {
1886                 ast_log(LOG_ERROR, "There is no file attached to this IMAP message.\n");
1887                 res = -1;
1888                 goto exit;
1889         }
1890         
1891         /* Find the format of the attached file */
1892
1893         strsep(&attachedfilefmt, ".");
1894         if (!attachedfilefmt) {
1895                 ast_log(LOG_ERROR, "File format could not be obtained from IMAP message attachment\n");
1896                 res = -1;
1897                 goto exit;
1898         }
1899         
1900         save_body(body, vms, "2", attachedfilefmt, 0);
1901         if (save_body(body, vms, "3", attachedfilefmt, 1)) {
1902                 *vms->introfn = '\0';
1903         }
1904
1905         /* Get info from headers!! */
1906         snprintf(text_file, sizeof(text_file), "%s.%s", vms->fn, "txt");
1907
1908         if (!(text_file_ptr = fopen(text_file, "w"))) {
1909                 ast_log(LOG_WARNING, "Unable to open/create file %s: %s\n", text_file, strerror(errno));
1910         }
1911
1912         fprintf(text_file_ptr, "%s\n", "[message]");
1913
1914         get_header_by_tag(header_content, "X-Asterisk-VM-Caller-ID-Name:", buf, sizeof(buf));
1915         fprintf(text_file_ptr, "callerid=\"%s\" ", S_OR(buf, ""));
1916         get_header_by_tag(header_content, "X-Asterisk-VM-Caller-ID-Num:", buf, sizeof(buf));
1917         fprintf(text_file_ptr, "<%s>\n", S_OR(buf, ""));
1918         get_header_by_tag(header_content, "X-Asterisk-VM-Context:", buf, sizeof(buf));
1919         fprintf(text_file_ptr, "context=%s\n", S_OR(buf, ""));
1920         get_header_by_tag(header_content, "X-Asterisk-VM-Orig-time:", buf, sizeof(buf));
1921         fprintf(text_file_ptr, "origtime=%s\n", S_OR(buf, ""));
1922         get_header_by_tag(header_content, "X-Asterisk-VM-Duration:", buf, sizeof(buf));
1923         fprintf(text_file_ptr, "duration=%s\n", S_OR(buf, ""));
1924         get_header_by_tag(header_content, "X-Asterisk-VM-Category:", buf, sizeof(buf));
1925         fprintf(text_file_ptr, "category=%s\n", S_OR(buf, ""));
1926         get_header_by_tag(header_content, "X-Asterisk-VM-Flag:", buf, sizeof(buf));
1927         fprintf(text_file_ptr, "flag=%s\n", S_OR(buf, ""));
1928         fclose(text_file_ptr);
1929
1930 exit:
1931         free_user(vmu);
1932         return res;
1933 }
1934
1935 static int folder_int(const char *folder)
1936 {
1937         /*assume a NULL folder means INBOX*/
1938         if (!folder) {
1939                 return 0;
1940         }
1941         if (!strcasecmp(folder, imapfolder)) {
1942                 return 0;
1943         } else if (!strcasecmp(folder, "Old")) {
1944                 return 1;
1945         } else if (!strcasecmp(folder, "Work")) {
1946                 return 2;
1947         } else if (!strcasecmp(folder, "Family")) {
1948                 return 3;
1949         } else if (!strcasecmp(folder, "Friends")) {
1950                 return 4;
1951         } else if (!strcasecmp(folder, "Cust1")) {
1952                 return 5;
1953         } else if (!strcasecmp(folder, "Cust2")) {
1954                 return 6;
1955         } else if (!strcasecmp(folder, "Cust3")) {
1956                 return 7;
1957         } else if (!strcasecmp(folder, "Cust4")) {
1958                 return 8;
1959         } else if (!strcasecmp(folder, "Cust5")) {
1960                 return 9;
1961         } else if (!strcasecmp(folder, "Urgent")) {
1962                 return 11;
1963         } else { /*assume they meant INBOX if folder is not found otherwise*/
1964                 return 0;
1965         }
1966 }
1967
1968 static int __messagecount(const char *context, const char *mailbox, const char *folder)
1969 {
1970         SEARCHPGM *pgm;
1971         SEARCHHEADER *hdr;
1972
1973         struct ast_vm_user *vmu, vmus;
1974         struct vm_state *vms_p;
1975         int ret = 0;
1976         int fold = folder_int(folder);
1977         int urgent = 0;
1978         
1979         /* If URGENT, then look at INBOX */
1980         if (fold == 11) {
1981                 fold = NEW_FOLDER;
1982                 urgent = 1;
1983         }
1984
1985         if (ast_strlen_zero(mailbox))
1986                 return 0;
1987
1988         /* We have to get the user before we can open the stream! */
1989         vmu = find_user(&vmus, context, mailbox);
1990         if (!vmu) {
1991                 ast_log(AST_LOG_ERROR, "Couldn't find mailbox %s in context %s\n", mailbox, context);
1992                 return -1;
1993         } else {
1994                 /* No IMAP account available */
1995                 if (vmu->imapuser[0] == '\0') {
1996                         ast_log(AST_LOG_WARNING, "IMAP user not set for mailbox %s\n", vmu->mailbox);
1997                         return -1;
1998                 }
1999         }
2000         
2001         /* No IMAP account available */
2002         if (vmu->imapuser[0] == '\0') {
2003                 ast_log(AST_LOG_WARNING, "IMAP user not set for mailbox %s\n", vmu->mailbox);
2004                 free_user(vmu);
2005                 return -1;
2006         }
2007
2008         /* check if someone is accessing this box right now... */
2009         vms_p = get_vm_state_by_imapuser(vmu->imapuser, 1);
2010         if (!vms_p) {
2011                 vms_p = get_vm_state_by_mailbox(mailbox, context, 1);
2012         }
2013         if (vms_p) {
2014                 ast_debug(3, "Returning before search - user is logged in\n");
2015                 if (fold == 0) { /* INBOX */
2016                         return urgent ? vms_p->urgentmessages : vms_p->newmessages;
2017                 }
2018                 if (fold == 1) { /* Old messages */
2019                         return vms_p->oldmessages;
2020                 }
2021         }
2022
2023         /* add one if not there... */
2024         vms_p = get_vm_state_by_imapuser(vmu->imapuser, 0);
2025         if (!vms_p) {
2026                 vms_p = get_vm_state_by_mailbox(mailbox, context, 0);
2027         }
2028
2029         if (!vms_p) {
2030                 vms_p = create_vm_state_from_user(vmu);
2031         }
2032         ret = init_mailstream(vms_p, fold);
2033         if (!vms_p->mailstream) {
2034                 ast_log(AST_LOG_ERROR, "Houston we have a problem - IMAP mailstream is NULL\n");
2035                 return -1;
2036         }
2037         if (ret == 0) {
2038                 ast_mutex_lock(&vms_p->lock);
2039                 pgm = mail_newsearchpgm ();
2040                 hdr = mail_newsearchheader ("X-Asterisk-VM-Extension", (char *)(!ast_strlen_zero(vmu->imapvmshareid) ? vmu->imapvmshareid : mailbox));
2041                 hdr->next = mail_newsearchheader("X-Asterisk-VM-Context", (char *) S_OR(context, "default"));
2042                 pgm->header = hdr;
2043                 if (fold != OLD_FOLDER) {
2044                         pgm->unseen = 1;
2045                         pgm->seen = 0;
2046                 }
2047                 /* In the special case where fold is 1 (old messages) we have to do things a bit
2048                  * differently. Old messages are stored in the INBOX but are marked as "seen"
2049                  */
2050                 else {
2051                         pgm->unseen = 0;
2052                         pgm->seen = 1;
2053                 }
2054                 /* look for urgent messages */
2055                 if (fold == NEW_FOLDER) {
2056                         if (urgent) {
2057                                 pgm->flagged = 1;
2058                                 pgm->unflagged = 0;
2059                         } else {
2060                                 pgm->flagged = 0;
2061                                 pgm->unflagged = 1;
2062                         }
2063                 }
2064                 pgm->undeleted = 1;
2065                 pgm->deleted = 0;
2066
2067                 vms_p->vmArrayIndex = 0;
2068                 mail_search_full (vms_p->mailstream, NULL, pgm, NIL);
2069                 if (fold == 0 && urgent == 0)
2070                         vms_p->newmessages = vms_p->vmArrayIndex;
2071                 if (fold == 1)
2072                         vms_p->oldmessages = vms_p->vmArrayIndex;
2073                 if (fold == 0 && urgent == 1)
2074                         vms_p->urgentmessages = vms_p->vmArrayIndex;
2075                 /*Freeing the searchpgm also frees the searchhdr*/
2076                 mail_free_searchpgm(&pgm);
2077                 ast_mutex_unlock(&vms_p->lock);
2078                 vms_p->updated = 0;
2079                 return vms_p->vmArrayIndex;
2080         } else {
2081                 ast_mutex_lock(&vms_p->lock);
2082                 mail_ping(vms_p->mailstream);
2083                 ast_mutex_unlock(&vms_p->lock);
2084         }
2085         return 0;
2086 }
2087
2088 static int imap_check_limits(struct ast_channel *chan, struct vm_state *vms, struct ast_vm_user *vmu, int msgnum)
2089 {
2090         /* Check if mailbox is full */
2091         check_quota(vms, vmu->imapfolder);
2092         if (vms->quota_limit && vms->quota_usage >= vms->quota_limit) {
2093                 ast_debug(1, "*** QUOTA EXCEEDED!! %u >= %u\n", vms->quota_usage, vms->quota_limit);
2094                 ast_play_and_wait(chan, "vm-mailboxfull");
2095                 return -1;
2096         }
2097         
2098         /* Check if we have exceeded maxmsg */
2099         if (msgnum >= vmu->maxmsg  - inprocess_count(vmu->mailbox, vmu->context, 0)) {
2100                 ast_log(AST_LOG_WARNING, "Unable to leave message since we will exceed the maximum number of messages allowed (%u > %u)\n", msgnum, vmu->maxmsg);
2101                 ast_play_and_wait(chan, "vm-mailboxfull");
2102                 return -1;
2103         }
2104
2105         return 0;
2106 }
2107
2108 /*!
2109  * \brief Gets the number of messages that exist in a mailbox folder.
2110  * \param context
2111  * \param mailbox
2112  * \param folder
2113  * 
2114  * This method is used when IMAP backend is used.
2115  * \return The number of messages in this mailbox folder (zero or more).
2116  */
2117 static int messagecount(const char *context, const char *mailbox, const char *folder)
2118 {
2119         if (ast_strlen_zero(folder) || !strcmp(folder, "INBOX")) {
2120                 return __messagecount(context, mailbox, "INBOX") + __messagecount(context, mailbox, "Urgent");
2121         } else {
2122                 return __messagecount(context, mailbox, folder);
2123         }
2124 }
2125
2126 static int imap_store_file(const char *dir, const char *mailboxuser, const char *mailboxcontext, int msgnum, struct ast_channel *chan, struct ast_vm_user *vmu, char *fmt, int duration, struct vm_state *vms, const char *flag)
2127 {
2128         char *myserveremail = serveremail;
2129         char fn[PATH_MAX];
2130         char introfn[PATH_MAX];
2131         char mailbox[256];
2132         char *stringp;
2133         FILE *p = NULL;
2134         char tmp[80] = "/tmp/astmail-XXXXXX";
2135         long len;
2136         void *buf;
2137         int tempcopy = 0;
2138         STRING str;
2139         int ret; /* for better error checking */
2140         char *imap_flags = NIL;
2141         int msgcount = (messagecount(vmu->context, vmu->mailbox, "INBOX") + messagecount(vmu->context, vmu->mailbox, "Old"));
2142
2143     /* Back out early if this is a greeting and we don't want to store greetings in IMAP */
2144     if (msgnum < 0 && !imapgreetings) {
2145         return 0;
2146     }
2147         
2148         if (imap_check_limits(chan, vms, vmu, msgcount)) {
2149                 return -1;
2150         }
2151
2152         /* Set urgent flag for IMAP message */
2153         if (!ast_strlen_zero(flag) && !strcmp(flag, "Urgent")) {
2154                 ast_debug(3, "Setting message flag \\\\FLAGGED.\n");
2155                 imap_flags = "\\FLAGGED";
2156         }
2157         
2158         /* Attach only the first format */
2159         fmt = ast_strdupa(fmt);
2160         stringp = fmt;
2161         strsep(&stringp, "|");
2162
2163         if (!ast_strlen_zero(vmu->serveremail))
2164                 myserveremail = vmu->serveremail;
2165
2166         if (msgnum > -1)
2167                 make_file(fn, sizeof(fn), dir, msgnum);
2168         else
2169                 ast_copy_string (fn, dir, sizeof(fn));
2170
2171         snprintf(introfn, sizeof(introfn), "%sintro", fn);
2172         if (ast_fileexists(introfn, NULL, NULL) <= 0) {
2173                 *introfn = '\0';
2174         }
2175         
2176         if (ast_strlen_zero(vmu->email)) {
2177                 /* We need the vmu->email to be set when we call make_email_file, but
2178                  * if we keep it set, a duplicate e-mail will be created. So at the end
2179                  * of this function, we will revert back to an empty string if tempcopy
2180                  * is 1.
2181                  */
2182                 ast_copy_string(vmu->email, vmu->imapuser, sizeof(vmu->email));
2183                 tempcopy = 1;
2184         }
2185
2186         if (!strcmp(fmt, "wav49"))
2187                 fmt = "WAV";
2188         ast_debug(3, "Storing file '%s', format '%s'\n", fn, fmt);
2189
2190         /* Make a temporary file instead of piping directly to sendmail, in case the mail
2191            command hangs. */
2192         if (!(p = vm_mkftemp(tmp))) {
2193                 ast_log(AST_LOG_WARNING, "Unable to store '%s' (can't create temporary file)\n", fn);
2194                 if (tempcopy)
2195                         *(vmu->email) = '\0';
2196                 return -1;
2197         }
2198
2199         if (msgnum < 0 && imapgreetings) {
2200                 if ((ret = init_mailstream(vms, GREETINGS_FOLDER))) {
2201                         ast_log(AST_LOG_WARNING, "Unable to open mailstream.\n");
2202                         return -1;
2203                 }
2204                 imap_delete_old_greeting(fn, vms);
2205         }
2206
2207         make_email_file(p, myserveremail, vmu, msgnum, vmu->context, vmu->mailbox, "INBOX",
2208                 S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL),
2209                 S_COR(chan->caller.id.name.valid, chan->caller.id.name.str, NULL),
2210                 fn, introfn, fmt, duration, 1, chan, NULL, 1, flag);
2211         /* read mail file to memory */
2212         len = ftell(p);
2213         rewind(p);
2214         if (!(buf = ast_malloc(len + 1))) {
2215                 ast_log(AST_LOG_ERROR, "Can't allocate %ld bytes to read message\n", len + 1);
2216                 fclose(p);
2217                 if (tempcopy)
2218                         *(vmu->email) = '\0';
2219                 return -1;
2220         }
2221         if (fread(buf, len, 1, p) < len) {
2222                 if (ferror(p)) {
2223                         ast_log(LOG_ERROR, "Short read while reading in mail file.\n");
2224                         return -1;
2225                 }
2226         }
2227         ((char *) buf)[len] = '\0';
2228         INIT(&str, mail_string, buf, len);
2229         ret = init_mailstream(vms, NEW_FOLDER);
2230         if (ret == 0) {
2231                 imap_mailbox_name(mailbox, sizeof(mailbox), vms, NEW_FOLDER, 1);
2232                 ast_mutex_lock(&vms->lock);
2233                 if(!mail_append_full(vms->mailstream, mailbox, imap_flags, NIL, &str))
2234                         ast_log(LOG_ERROR, "Error while sending the message to %s\n", mailbox);
2235                 ast_mutex_unlock(&vms->lock);
2236                 fclose(p);
2237                 unlink(tmp);
2238                 ast_free(buf);
2239         } else {
2240                 ast_log(LOG_ERROR, "Could not initialize mailstream for %s\n", mailbox);
2241                 fclose(p);
2242                 unlink(tmp);
2243                 ast_free(buf);
2244                 return -1;
2245         }
2246         ast_debug(3, "%s stored\n", fn);
2247         
2248         if (tempcopy)
2249                 *(vmu->email) = '\0';
2250         
2251         return 0;
2252
2253 }
2254
2255 /*!
2256  * \brief Gets the number of messages that exist in the inbox folder.
2257  * \param mailbox_context
2258  * \param newmsgs The variable that is updated with the count of new messages within this inbox.
2259  * \param oldmsgs The variable that is updated with the count of old messages within this inbox.
2260  * \param urgentmsgs The variable that is updated with the count of urgent messages within this inbox.
2261  * 
2262  * This method is used when IMAP backend is used.
2263  * Simultaneously determines the count of new,old, and urgent messages. The total messages would then be the sum of these three.
2264  *
2265  * \return zero on success, -1 on error.
2266  */
2267
2268 static int inboxcount2(const char *mailbox_context, int *urgentmsgs, int *newmsgs, int *oldmsgs)
2269 {
2270         char tmp[PATH_MAX] = "";
2271         char *mailboxnc;
2272         char *context;
2273         char *mb;
2274         char *cur;
2275         if (newmsgs)
2276                 *newmsgs = 0;
2277         if (oldmsgs)
2278                 *oldmsgs = 0;
2279         if (urgentmsgs)
2280                 *urgentmsgs = 0;
2281
2282         ast_debug(3, "Mailbox is set to %s\n", mailbox_context);
2283         /* If no mailbox, return immediately */
2284         if (ast_strlen_zero(mailbox_context))
2285                 return 0;
2286         
2287         ast_copy_string(tmp, mailbox_context, sizeof(tmp));
2288         context = strchr(tmp, '@');
2289         if (strchr(mailbox_context, ',')) {
2290                 int tmpnew, tmpold, tmpurgent;
2291                 ast_copy_string(tmp, mailbox_context, sizeof(tmp));
2292                 mb = tmp;
2293                 while ((cur = strsep(&mb, ", "))) {
2294                         if (!ast_strlen_zero(cur)) {
2295                                 if (inboxcount2(cur, urgentmsgs ? &tmpurgent : NULL, newmsgs ? &tmpnew : NULL, oldmsgs ? &tmpold : NULL))
2296                                         return -1;
2297                                 else {
2298                                         if (newmsgs)
2299                                                 *newmsgs += tmpnew; 
2300                                         if (oldmsgs)
2301                                                 *oldmsgs += tmpold;
2302                                         if (urgentmsgs)
2303                                                 *urgentmsgs += tmpurgent;
2304                                 }
2305                         }
2306                 }
2307                 return 0;
2308         }
2309         if (context) {
2310                 *context = '\0';
2311                 mailboxnc = tmp;
2312                 context++;
2313         } else {
2314                 context = "default";
2315                 mailboxnc = (char *) mailbox_context;
2316         }
2317
2318         if (newmsgs) {
2319                 struct ast_vm_user *vmu = find_user(NULL, context, mailboxnc);
2320                 if (!vmu) {
2321                         ast_log(AST_LOG_ERROR, "Couldn't find mailbox %s in context %s\n", mailboxnc, context);
2322                         return -1;
2323                 }
2324                 if ((*newmsgs = __messagecount(context, mailboxnc, vmu->imapfolder)) < 0) {
2325                         return -1;
2326                 }
2327         }
2328         if (oldmsgs) {
2329                 if ((*oldmsgs = __messagecount(context, mailboxnc, "Old")) < 0) {
2330                         return -1;
2331                 }
2332         }
2333         if (urgentmsgs) {
2334                 if ((*urgentmsgs = __messagecount(context, mailboxnc, "Urgent")) < 0) {
2335                         return -1;
2336                 }
2337         }
2338         return 0;
2339 }
2340
2341 /** 
2342  * \brief Determines if the given folder has messages.
2343  * \param mailbox The @ delimited string for user@context. If no context is found, uses 'default' for the context.
2344  * \param folder the folder to look in
2345  *
2346  * This function is used when the mailbox is stored in an IMAP back end.
2347  * This invokes the messagecount(). Here we are interested in the presence of messages (> 0) only, not the actual count.
2348  * \return 1 if the folder has one or more messages. zero otherwise.
2349  */
2350
2351 static int has_voicemail(const char *mailbox, const char *folder)
2352 {
2353         char tmp[256], *tmp2, *box, *context;
2354         ast_copy_string(tmp, mailbox, sizeof(tmp));
2355         tmp2 = tmp;
2356         if (strchr(tmp2, ',') || strchr(tmp2, '&')) {
2357                 while ((box = strsep(&tmp2, ",&"))) {
2358                         if (!ast_strlen_zero(box)) {
2359                                 if (has_voicemail(box, folder)) {
2360                                         return 1;
2361                                 }
2362                         }
2363                 }
2364         }
2365         if ((context = strchr(tmp, '@'))) {
2366                 *context++ = '\0';
2367         } else {
2368                 context = "default";
2369         }
2370         return __messagecount(context, tmp, folder) ? 1 : 0;
2371 }
2372
2373 /*!
2374  * \brief Copies a message from one mailbox to another.
2375  * \param chan
2376  * \param vmu
2377  * \param imbox
2378  * \param msgnum
2379  * \param duration
2380  * \param recip
2381  * \param fmt
2382  * \param dir
2383  *
2384  * This works with IMAP storage based mailboxes.
2385  *
2386  * \return zero on success, -1 on error.
2387  */
2388 static int copy_message(struct ast_channel *chan, struct ast_vm_user *vmu, int imbox, int msgnum, long duration, struct ast_vm_user *recip, char *fmt, char *dir, char *flag)
2389 {
2390         struct vm_state *sendvms = NULL, *destvms = NULL;
2391         char messagestring[10]; /*I guess this could be a problem if someone has more than 999999999 messages...*/
2392         if (msgnum >= recip->maxmsg) {
2393                 ast_log(LOG_WARNING, "Unable to copy mail, mailbox %s is full\n", recip->mailbox);
2394                 return -1;
2395         }
2396         if (!(sendvms = get_vm_state_by_imapuser(vmu->imapuser, 0))) {
2397                 ast_log(LOG_ERROR, "Couldn't get vm_state for originator's mailbox!!\n");
2398                 return -1;
2399         }
2400         if (!(destvms = get_vm_state_by_imapuser(recip->imapuser, 0))) {
2401                 ast_log(LOG_ERROR, "Couldn't get vm_state for destination mailbox!\n");
2402                 return -1;
2403         }
2404         snprintf(messagestring, sizeof(messagestring), "%ld", sendvms->msgArray[msgnum]);
2405         ast_mutex_lock(&sendvms->lock);
2406         if ((mail_copy(sendvms->mailstream, messagestring, (char *) mbox(vmu, imbox)) == T)) {
2407                 ast_mutex_unlock(&sendvms->lock);
2408                 return 0;
2409         }
2410         ast_mutex_unlock(&sendvms->lock);
2411         ast_log(LOG_WARNING, "Unable to copy message from mailbox %s to mailbox %s\n", vmu->mailbox, recip->mailbox);
2412         return -1;
2413 }
2414
2415 static void imap_mailbox_name(char *spec, size_t len, struct vm_state *vms, int box, int use_folder)
2416 {
2417         char tmp[256], *t = tmp;
2418         size_t left = sizeof(tmp);
2419         
2420         if (box == OLD_FOLDER) {
2421                 ast_copy_string(vms->curbox, mbox(NULL, NEW_FOLDER), sizeof(vms->curbox));
2422         } else {
2423                 ast_copy_string(vms->curbox, mbox(NULL, box), sizeof(vms->curbox));
2424         }
2425
2426         if (box == NEW_FOLDER) {
2427                 ast_copy_string(vms->vmbox, "vm-INBOX", sizeof(vms->vmbox));
2428         } else {
2429                 snprintf(vms->vmbox, sizeof(vms->vmbox), "vm-%s", mbox(NULL, box));
2430         }
2431
2432         /* Build up server information */
2433         ast_build_string(&t, &left, "{%s:%s/imap", imapserver, imapport);
2434
2435         /* Add authentication user if present */
2436         if (!ast_strlen_zero(authuser))
2437                 ast_build_string(&t, &left, "/authuser=%s", authuser);
2438
2439         /* Add flags if present */
2440         if (!ast_strlen_zero(imapflags))
2441                 ast_build_string(&t, &left, "/%s", imapflags);
2442
2443         /* End with username */
2444 #if 1
2445         ast_build_string(&t, &left, "/user=%s}", vms->imapuser);
2446 #else
2447         ast_build_string(&t, &left, "/user=%s/novalidate-cert}", vms->imapuser);
2448 #endif
2449         if (box == NEW_FOLDER || box == OLD_FOLDER)
2450                 snprintf(spec, len, "%s%s", tmp, use_folder? vms->imapfolder: "INBOX");
2451         else if (box == GREETINGS_FOLDER)
2452                 snprintf(spec, len, "%s%s", tmp, greetingfolder);
2453         else {  /* Other folders such as Friends, Family, etc... */
2454                 if (!ast_strlen_zero(imapparentfolder)) {
2455                         /* imapparentfolder would typically be set to INBOX */
2456                         snprintf(spec, len, "%s%s%c%s", tmp, imapparentfolder, delimiter, mbox(NULL, box));
2457                 } else {
2458                         snprintf(spec, len, "%s%s", tmp, mbox(NULL, box));
2459                 }
2460         }
2461 }
2462
2463 static int init_mailstream(struct vm_state *vms, int box)
2464 {
2465         MAILSTREAM *stream = NIL;
2466         long debug;
2467         char tmp[256];
2468         
2469         if (!vms) {
2470                 ast_log(LOG_ERROR, "vm_state is NULL!\n");
2471                 return -1;
2472         }
2473         if (option_debug > 2)
2474                 ast_log(LOG_DEBUG, "vm_state user is:%s\n", vms->imapuser);
2475         if (vms->mailstream == NIL || !vms->mailstream) {
2476                 if (option_debug)
2477                         ast_log(LOG_DEBUG, "mailstream not set.\n");
2478         } else {
2479                 stream = vms->mailstream;
2480         }
2481         /* debug = T;  user wants protocol telemetry? */
2482         debug = NIL;  /* NO protocol telemetry? */
2483
2484         if (delimiter == '\0') {                /* did not probe the server yet */
2485                 char *cp;
2486 #ifdef USE_SYSTEM_IMAP
2487 #include <imap/linkage.c>
2488 #elif defined(USE_SYSTEM_CCLIENT)
2489 #include <c-client/linkage.c>
2490 #else
2491 #include "linkage.c"
2492 #endif
2493                 /* Connect to INBOX first to get folders delimiter */
2494                 imap_mailbox_name(tmp, sizeof(tmp), vms, 0, 1);
2495                 ast_mutex_lock(&vms->lock);
2496                 stream = mail_open (stream, tmp, debug ? OP_DEBUG : NIL);
2497                 ast_mutex_unlock(&vms->lock);
2498                 if (stream == NIL) {
2499                         ast_log(LOG_ERROR, "Can't connect to imap server %s\n", tmp);
2500                         return -1;
2501                 }
2502                 get_mailbox_delimiter(stream);
2503                 /* update delimiter in imapfolder */
2504                 for (cp = vms->imapfolder; *cp; cp++)
2505                         if (*cp == '/')
2506                                 *cp = delimiter;
2507         }
2508         /* Now connect to the target folder */
2509         imap_mailbox_name(tmp, sizeof(tmp), vms, box, 1);
2510         if (option_debug > 2)
2511                 ast_log(LOG_DEBUG, "Before mail_open, server: %s, box:%d\n", tmp, box);
2512         ast_mutex_lock(&vms->lock);
2513         vms->mailstream = mail_open (stream, tmp, debug ? OP_DEBUG : NIL);
2514         ast_mutex_unlock(&vms->lock);
2515         if (vms->mailstream == NIL) {
2516                 return -1;
2517         } else {
2518                 return 0;
2519         }
2520 }
2521
2522 static int open_mailbox(struct vm_state *vms, struct ast_vm_user *vmu, int box)
2523 {
2524         SEARCHPGM *pgm;
2525         SEARCHHEADER *hdr;
2526         int ret, urgent = 0;
2527
2528         /* If Urgent, then look at INBOX */
2529         if (box == 11) {
2530                 box = NEW_FOLDER;
2531                 urgent = 1;
2532         }
2533
2534         ast_copy_string(vms->imapuser, vmu->imapuser, sizeof(vms->imapuser));
2535         ast_copy_string(vms->imapfolder, vmu->imapfolder, sizeof(vms->imapfolder));
2536         vms->imapversion = vmu->imapversion;
2537         ast_debug(3, "Before init_mailstream, user is %s\n", vmu->imapuser);
2538
2539         if ((ret = init_mailstream(vms, box)) || !vms->mailstream) {
2540                 ast_log(AST_LOG_ERROR, "Could not initialize mailstream\n");
2541                 return -1;
2542         }
2543         
2544         create_dirpath(vms->curdir, sizeof(vms->curdir), vmu->context, vms->username, vms->curbox);
2545         
2546         /* Check Quota */
2547         if  (box == 0)  {
2548                 ast_debug(3, "Mailbox name set to: %s, about to check quotas\n", mbox(vmu, box));
2549                 check_quota(vms, (char *) mbox(vmu, box));
2550         }
2551
2552         ast_mutex_lock(&vms->lock);
2553         pgm = mail_newsearchpgm();
2554
2555         /* Check IMAP folder for Asterisk messages only... */
2556         hdr = mail_newsearchheader("X-Asterisk-VM-Extension", (!ast_strlen_zero(vmu->imapvmshareid) ? vmu->imapvmshareid : vmu->mailbox));
2557         hdr->next = mail_newsearchheader("X-Asterisk-VM-Context", vmu->context);
2558         pgm->header = hdr;
2559         pgm->deleted = 0;
2560         pgm->undeleted = 1;
2561
2562         /* if box = NEW_FOLDER, check for new, if box = OLD_FOLDER, check for read */
2563         if (box == NEW_FOLDER && urgent == 1) {
2564                 pgm->unseen = 1;
2565                 pgm->seen = 0;
2566                 pgm->flagged = 1;
2567                 pgm->unflagged = 0;
2568         } else if (box == NEW_FOLDER && urgent == 0) {
2569                 pgm->unseen = 1;
2570                 pgm->seen = 0;
2571                 pgm->flagged = 0;
2572                 pgm->unflagged = 1;
2573         } else if (box == OLD_FOLDER) {
2574                 pgm->seen = 1;
2575                 pgm->unseen = 0;
2576         }
2577
2578         ast_debug(3, "Before mail_search_full, user is %s\n", vmu->imapuser);
2579
2580         vms->vmArrayIndex = 0;
2581         mail_search_full (vms->mailstream, NULL, pgm, NIL);
2582         vms->lastmsg = vms->vmArrayIndex - 1;
2583         mail_free_searchpgm(&pgm);
2584
2585         ast_mutex_unlock(&vms->lock);
2586         return 0;
2587 }
2588
2589 static void write_file(char *filename, char *buffer, unsigned long len)
2590 {
2591         FILE *output;
2592
2593         output = fopen (filename, "w");
2594         if (fwrite(buffer, len, 1, output) != 1) {
2595                 if (ferror(output)) {
2596                         ast_log(LOG_ERROR, "Short write while writing e-mail body: %s.\n", strerror(errno));
2597                 }
2598         }
2599         fclose (output);
2600 }
2601
2602 static void update_messages_by_imapuser(const char *user, unsigned long number)
2603 {
2604         struct vm_state *vms = get_vm_state_by_imapuser(user, 1);
2605
2606         if (!vms && !(vms = get_vm_state_by_imapuser(user, 0))) {
2607                 return;
2608         }
2609
2610         ast_debug(3, "saving mailbox message number %lu as message %d. Interactive set to %d\n", number, vms->vmArrayIndex, vms->interactive);
2611         vms->msgArray[vms->vmArrayIndex++] = number;
2612 }
2613
2614 void mm_searched(MAILSTREAM *stream, unsigned long number)
2615 {
2616         char *mailbox = stream->mailbox, buf[1024] = "", *user;
2617
2618         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))))
2619                 return;
2620
2621         update_messages_by_imapuser(user, number);
2622 }
2623
2624 static struct ast_vm_user *find_user_realtime_imapuser(const char *imapuser)
2625 {
2626         struct ast_variable *var;
2627         struct ast_vm_user *vmu;
2628
2629         vmu = ast_calloc(1, sizeof *vmu);
2630         if (!vmu)
2631                 return NULL;
2632         ast_set_flag(vmu, VM_ALLOCED);
2633         populate_defaults(vmu);
2634
2635         var = ast_load_realtime("voicemail", "imapuser", imapuser, NULL);
2636         if (var) {
2637                 apply_options_full(vmu, var);
2638                 ast_variables_destroy(var);
2639                 return vmu;
2640         } else {
2641                 ast_free(vmu);
2642                 return NULL;
2643         }
2644 }
2645
2646 /* Interfaces to C-client */
2647
2648 void mm_exists(MAILSTREAM * stream, unsigned long number)
2649 {
2650         /* mail_ping will callback here if new mail! */
2651         ast_debug(4, "Entering EXISTS callback for message %ld\n", number);
2652         if (number == 0) return;
2653         set_update(stream);
2654 }
2655
2656
2657 void mm_expunged(MAILSTREAM * stream, unsigned long number)
2658 {
2659         /* mail_ping will callback here if expunged mail! */
2660         ast_debug(4, "Entering EXPUNGE callback for message %ld\n", number);
2661         if (number == 0) return;
2662         set_update(stream);
2663 }
2664
2665
2666 void mm_flags(MAILSTREAM * stream, unsigned long number)
2667 {
2668         /* mail_ping will callback here if read mail! */
2669         ast_debug(4, "Entering FLAGS callback for message %ld\n", number);
2670         if (number == 0) return;
2671         set_update(stream);
2672 }
2673
2674
2675 void mm_notify(MAILSTREAM * stream, char *string, long errflg)
2676 {
2677         ast_debug(5, "Entering NOTIFY callback, errflag is %ld, string is %s\n", errflg, string);
2678         mm_log (string, errflg);
2679 }
2680
2681
2682 void mm_list(MAILSTREAM * stream, int delim, char *mailbox, long attributes)
2683 {
2684         if (delimiter == '\0') {
2685                 delimiter = delim;
2686         }
2687
2688         ast_debug(5, "Delimiter set to %c and mailbox %s\n", delim, mailbox);
2689         if (attributes & LATT_NOINFERIORS)
2690                 ast_debug(5, "no inferiors\n");
2691         if (attributes & LATT_NOSELECT)
2692                 ast_debug(5, "no select\n");
2693         if (attributes & LATT_MARKED)
2694                 ast_debug(5, "marked\n");
2695         if (attributes & LATT_UNMARKED)
2696                 ast_debug(5, "unmarked\n");
2697 }
2698
2699
2700 void mm_lsub(MAILSTREAM * stream, int delim, char *mailbox, long attributes)
2701 {
2702         ast_debug(5, "Delimiter set to %c and mailbox %s\n", delim, mailbox);
2703         if (attributes & LATT_NOINFERIORS)
2704                 ast_debug(5, "no inferiors\n");
2705         if (attributes & LATT_NOSELECT)
2706                 ast_debug(5, "no select\n");
2707         if (attributes & LATT_MARKED)
2708                 ast_debug(5, "marked\n");
2709         if (attributes & LATT_UNMARKED)
2710                 ast_debug(5, "unmarked\n");
2711 }
2712
2713
2714 void mm_status(MAILSTREAM * stream, char *mailbox, MAILSTATUS * status)
2715 {
2716         ast_log(AST_LOG_NOTICE, " Mailbox %s", mailbox);
2717         if (status->flags & SA_MESSAGES)
2718                 ast_log(AST_LOG_NOTICE, ", %lu messages", status->messages);
2719         if (status->flags & SA_RECENT)
2720                 ast_log(AST_LOG_NOTICE, ", %lu recent", status->recent);
2721         if (status->flags & SA_UNSEEN)
2722                 ast_log(AST_LOG_NOTICE, ", %lu unseen", status->unseen);
2723         if (status->flags & SA_UIDVALIDITY)
2724                 ast_log(AST_LOG_NOTICE, ", %lu UID validity", status->uidvalidity);
2725         if (status->flags & SA_UIDNEXT)
2726                 ast_log(AST_LOG_NOTICE, ", %lu next UID", status->uidnext);
2727         ast_log(AST_LOG_NOTICE, "\n");
2728 }
2729
2730
2731 void mm_log(char *string, long errflg)
2732 {
2733         switch ((short) errflg) {
2734                 case NIL:
2735                         ast_debug(1, "IMAP Info: %s\n", string);
2736                         break;
2737                 case PARSE:
2738                 case WARN:
2739                         ast_log(AST_LOG_WARNING, "IMAP Warning: %s\n", string);
2740                         break;
2741                 case ERROR:
2742                         ast_log(AST_LOG_ERROR, "IMAP Error: %s\n", string);
2743                         break;
2744         }
2745 }
2746
2747
2748 void mm_dlog(char *string)
2749 {
2750         ast_log(AST_LOG_NOTICE, "%s\n", string);
2751 }
2752
2753
2754 void mm_login(NETMBX * mb, char *user, char *pwd, long trial)
2755 {
2756         struct ast_vm_user *vmu;
2757
2758         ast_debug(4, "Entering callback mm_login\n");
2759
2760         ast_copy_string(user, mb->user, MAILTMPLEN);
2761
2762         /* We should only do this when necessary */
2763         if (!ast_strlen_zero(authpassword)) {
2764                 ast_copy_string(pwd, authpassword, MAILTMPLEN);
2765         } else {
2766                 AST_LIST_TRAVERSE(&users, vmu, list) {
2767                         if (!strcasecmp(mb->user, vmu->imapuser)) {
2768                                 ast_copy_string(pwd, vmu->imappassword, MAILTMPLEN);
2769                                 break;
2770                         }
2771                 }
2772                 if (!vmu) {
2773                         if ((vmu = find_user_realtime_imapuser(mb->user))) {
2774                                 ast_copy_string(pwd, vmu->imappassword, MAILTMPLEN);
2775                                 free_user(vmu);
2776                         }
2777                 }
2778         }
2779 }
2780
2781
2782 void mm_critical(MAILSTREAM * stream)
2783 {
2784 }
2785
2786
2787 void mm_nocritical(MAILSTREAM * stream)
2788 {
2789 }
2790
2791
2792 long mm_diskerror(MAILSTREAM * stream, long errcode, long serious)
2793 {
2794         kill (getpid (), SIGSTOP);
2795         return NIL;
2796 }
2797
2798
2799 void mm_fatal(char *string)
2800 {
2801         ast_log(AST_LOG_ERROR, "IMAP access FATAL error: %s\n", string);
2802 }
2803
2804 /* C-client callback to handle quota */
2805 static void mm_parsequota(MAILSTREAM *stream, unsigned char *msg, QUOTALIST *pquota)
2806 {
2807         struct vm_state *vms;
2808         char *mailbox = stream->mailbox, *user;
2809         char buf[1024] = "";
2810         unsigned long usage = 0, limit = 0;
2811         
2812         while (pquota) {
2813                 usage = pquota->usage;
2814                 limit = pquota->limit;
2815                 pquota = pquota->next;
2816         }
2817         
2818         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))) || (!(vms = get_vm_state_by_imapuser(user, 2)) && !(vms = get_vm_state_by_imapuser(user, 0)))) {
2819                 ast_log(AST_LOG_ERROR, "No state found.\n");
2820                 return;
2821         }
2822
2823         ast_debug(3, "User %s usage is %lu, limit is %lu\n", user, usage, limit);
2824
2825         vms->quota_usage = usage;
2826         vms->quota_limit = limit;
2827 }
2828
2829 static char *get_header_by_tag(char *header, char *tag, char *buf, size_t len)
2830 {
2831         char *start, *eol_pnt;
2832         int taglen;
2833
2834         if (ast_strlen_zero(header) || ast_strlen_zero(tag))
2835                 return NULL;
2836
2837         taglen = strlen(tag) + 1;
2838         if (taglen < 1)
2839                 return NULL;
2840
2841         if (!(start = strstr(header, tag)))
2842                 return NULL;
2843
2844         /* Since we can be called multiple times we should clear our buffer */
2845         memset(buf, 0, len);
2846
2847         ast_copy_string(buf, start+taglen, len);
2848         if ((eol_pnt = strchr(buf,'\r')) || (eol_pnt = strchr(buf,'\n')))
2849                 *eol_pnt = '\0';
2850         return buf;
2851 }
2852
2853 static char *get_user_by_mailbox(char *mailbox, char *buf, size_t len)
2854 {
2855         char *start, *quote, *eol_pnt;
2856
2857         if (ast_strlen_zero(mailbox))
2858                 return NULL;
2859
2860         if (!(start = strstr(mailbox, "/user=")))
2861                 return NULL;
2862
2863         ast_copy_string(buf, start+6, len);
2864
2865         if (!(quote = strchr(buf, '\"'))) {
2866                 if (!(eol_pnt = strchr(buf, '/')))
2867                         eol_pnt = strchr(buf,'}');
2868                 *eol_pnt = '\0';
2869                 return buf;
2870         } else {
2871                 eol_pnt = strchr(buf+1,'\"');
2872                 *eol_pnt = '\0';
2873                 return buf+1;
2874         }
2875 }
2876
2877 static struct vm_state *create_vm_state_from_user(struct ast_vm_user *vmu)
2878 {
2879         struct vm_state *vms_p;
2880
2881         pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2882         if ((vms_p = pthread_getspecific(ts_vmstate.key)) && !strcmp(vms_p->imapuser, vmu->imapuser) && !strcmp(vms_p->username, vmu->mailbox)) {
2883                 return vms_p;
2884         }
2885         if (option_debug > 4)
2886                 ast_log(AST_LOG_DEBUG, "Adding new vmstate for %s\n", vmu->imapuser);
2887         if (!(vms_p = ast_calloc(1, sizeof(*vms_p))))
2888                 return NULL;
2889         ast_copy_string(vms_p->imapuser, vmu->imapuser, sizeof(vms_p->imapuser));
2890         ast_copy_string(vms_p->imapfolder, vmu->imapfolder, sizeof(vms_p->imapfolder));
2891         ast_copy_string(vms_p->username, vmu->mailbox, sizeof(vms_p->username)); /* save for access from interactive entry point */
2892         ast_copy_string(vms_p->context, vmu->context, sizeof(vms_p->context));
2893         vms_p->mailstream = NIL; /* save for access from interactive entry point */
2894         vms_p->imapversion = vmu->imapversion;
2895         if (option_debug > 4)
2896                 ast_log(AST_LOG_DEBUG, "Copied %s to %s\n", vmu->imapuser, vms_p->imapuser);
2897         vms_p->updated = 1;
2898         /* set mailbox to INBOX! */
2899         ast_copy_string(vms_p->curbox, mbox(vmu, 0), sizeof(vms_p->curbox));
2900         init_vm_state(vms_p);
2901         vmstate_insert(vms_p);
2902         return vms_p;
2903 }
2904
2905 static struct vm_state *get_vm_state_by_imapuser(const char *user, int interactive)
2906 {
2907         struct vmstate *vlist = NULL;
2908
2909         if (interactive) {
2910                 struct vm_state *vms;
2911                 pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2912                 vms = pthread_getspecific(ts_vmstate.key);
2913                 return vms;
2914         }
2915
2916         AST_LIST_LOCK(&vmstates);
2917         AST_LIST_TRAVERSE(&vmstates, vlist, list) {
2918                 if (!vlist->vms) {
2919                         ast_debug(3, "error: vms is NULL for %s\n", user);
2920                         continue;
2921                 }
2922                 if (vlist->vms->imapversion != imapversion) {
2923                         continue;
2924                 }
2925                 if (!vlist->vms->imapuser) {
2926                         ast_debug(3, "error: imapuser is NULL for %s\n", user);
2927                         continue;
2928                 }
2929
2930                 if (!strcmp(vlist->vms->imapuser, user) && (interactive == 2 || vlist->vms->interactive == interactive)) {
2931                         AST_LIST_UNLOCK(&vmstates);
2932                         return vlist->vms;
2933                 }
2934         }
2935         AST_LIST_UNLOCK(&vmstates);
2936
2937         ast_debug(3, "%s not found in vmstates\n", user);
2938
2939         return NULL;
2940 }
2941
2942 static struct vm_state *get_vm_state_by_mailbox(const char *mailbox, const char *context, int interactive)
2943 {
2944
2945         struct vmstate *vlist = NULL;
2946         const char *local_context = S_OR(context, "default");
2947
2948         if (interactive) {
2949                 struct vm_state *vms;
2950                 pthread_once(&ts_vmstate.once, ts_vmstate.key_init);
2951                 vms = pthread_getspecific(ts_vmstate.key);
2952                 return vms;
2953         }
2954
2955         AST_LIST_LOCK(&vmstates);
2956         AST_LIST_TRAVERSE(&vmstates, vlist, list) {
2957                 if (!vlist->vms) {
2958                         ast_debug(3, "error: vms is NULL for %s\n", mailbox);
2959                         continue;
2960                 }
2961                 if (vlist->vms->imapversion != imapversion) {
2962                         continue;
2963                 }
2964                 if (!vlist->vms->username || !vlist->vms->context) {
2965                         ast_debug(3, "error: username is NULL for %s\n", mailbox);
2966                         continue;
2967                 }
2968
2969                 ast_debug(3, "comparing mailbox %s@%s (i=%d) to vmstate mailbox %s@%s (i=%d)\n", mailbox, local_context, interactive, vlist->vms->username, vlist->vms->context, vlist->vms->interactive);
2970                 
2971                 if (!strcmp(vlist->vms->username, mailbox) && !strcmp(vlist->vms->context, local_context) && vlist->vms->interactive == interactive) {
2972                         ast_debug(3, "Found it!\n");
2973                         AST_LIST_UNLOCK(&vmstates);
2974                         return vlist->vms;
2975                 }
2976         }
2977         AST_LIST_UNLOCK(&vmstates);
2978
2979         ast_debug(3, "%s not found in vmstates\n", mailbox);
2980
2981         return NULL;
2982 }
2983
2984 static void vmstate_insert(struct vm_state *vms) 
2985 {
2986         struct vmstate *v;
2987         struct vm_state *altvms;
2988
2989         /* If interactive, it probably already exists, and we should
2990            use the one we already have since it is more up to date.
2991            We can compare the username to find the duplicate */
2992         if (vms->interactive == 1) {
2993                 altvms = get_vm_state_by_mailbox(vms->username, vms->context, 0);
2994                 if (altvms) {   
2995                         ast_debug(3, "Duplicate mailbox %s, copying message info...\n", vms->username);
2996                         vms->newmessages = altvms->newmessages;
2997                         vms->oldmessages = altvms->oldmessages;
2998                         vms->vmArrayIndex = altvms->vmArrayIndex;
2999                         vms->lastmsg = altvms->lastmsg;
3000                         vms->curmsg = altvms->curmsg;
3001                         /* get a pointer to the persistent store */
3002                         vms->persist_vms = altvms;
3003                         /* Reuse the mailstream? */
3004 #ifdef REALLY_FAST_EVEN_IF_IT_MEANS_RESOURCE_LEAKS
3005                         vms->mailstream = altvms->mailstream;
3006 #else
3007                         vms->mailstream = NIL;
3008 #endif
3009                 }
3010                 return;
3011         }
3012
3013         if (!(v = ast_calloc(1, sizeof(*v))))
3014                 return;
3015         
3016         v->vms = vms;
3017
3018         ast_debug(3, "Inserting vm_state for user:%s, mailbox %s\n", vms->imapuser, vms->username);
3019
3020         AST_LIST_LOCK(&vmstates);
3021         AST_LIST_INSERT_TAIL(&vmstates, v, list);
3022         AST_LIST_UNLOCK(&vmstates);
3023 }
3024
3025 static void vmstate_delete(struct vm_state *vms) 
3026 {
3027         struct vmstate *vc = NULL;
3028         struct vm_state *altvms = NULL;
3029
3030         /* If interactive, we should copy pertinent info
3031            back to the persistent state (to make update immediate) */
3032         if (vms->interactive == 1 && (altvms = vms->persist_vms)) {
3033                 ast_debug(3, "Duplicate mailbox %s, copying message info...\n", vms->username);
3034                 altvms->newmessages = vms->newmessages;
3035                 altvms->oldmessages = vms->oldmessages;
3036                 altvms->updated = 1;
3037                 vms->mailstream = mail_close(vms->mailstream);
3038
3039                 /* Interactive states are not stored within the persistent list */
3040                 return;
3041         }
3042         
3043         ast_debug(3, "Removing vm_state for user:%s, mailbox %s\n", vms->imapuser, vms->username);
3044         
3045         AST_LIST_LOCK(&vmstates);
3046         AST_LIST_TRAVERSE_SAFE_BEGIN(&vmstates, vc, list) {
3047                 if (vc->vms == vms) {
3048                         AST_LIST_REMOVE_CURRENT(list);
3049                         break;
3050                 }
3051         }
3052         AST_LIST_TRAVERSE_SAFE_END
3053         AST_LIST_UNLOCK(&vmstates);
3054         
3055         if (vc) {
3056                 ast_mutex_destroy(&vc->vms->lock);
3057                 ast_free(vc);
3058         }
3059         else
3060                 ast_log(AST_LOG_ERROR, "No vmstate found for user:%s, mailbox %s\n", vms->imapuser, vms->username);
3061 }
3062
3063 static void set_update(MAILSTREAM * stream) 
3064 {
3065         struct vm_state *vms;
3066         char *mailbox = stream->mailbox, *user;
3067         char buf[1024] = "";
3068
3069         if (!(user = get_user_by_mailbox(mailbox, buf, sizeof(buf))) || !(vms = get_vm_state_by_imapuser(user, 0))) {
3070                 if (user && option_debug > 2)
3071                         ast_log(AST_LOG_WARNING, "User %s mailbox not found for update.\n", user);
3072                 return;
3073         }
3074
3075         ast_debug(3, "User %s mailbox set for update.\n", user);
3076
3077         vms->updated = 1; /* Set updated flag since mailbox changed */
3078 }
3079
3080 static void init_vm_state(struct vm_state *vms) 
3081 {
3082         int x;
3083         vms->vmArrayIndex = 0;
3084         for (x = 0; x < VMSTATE_MAX_MSG_ARRAY; x++) {
3085                 vms->msgArray[x] = 0;
3086         }
3087         ast_mutex_init(&vms->lock);
3088 }
3089
3090 static int save_body(BODY *body, struct vm_state *vms, char *section, char *format, int is_intro) 
3091 {
3092         char *body_content;
3093         char *body_decoded;
3094         char *fn = is_intro ? vms->introfn : vms->fn;
3095         unsigned long len;
3096         unsigned long newlen;
3097         char filename[256];
3098         
3099         if (!body || body == NIL)
3100                 return -1;
3101
3102         ast_mutex_lock(&vms->lock);
3103         body_content = mail_fetchbody(vms->mailstream, vms->msgArray[vms->curmsg], section, &len);
3104         ast_mutex_unlock(&vms->lock);
3105         if (body_content != NIL) {
3106                 snprintf(filename, sizeof(filename), "%s.%s", fn, format);
3107                 /* ast_debug(1,body_content); */
3108                 body_decoded = rfc822_base64((unsigned char *) body_content, len, &newlen);
3109                 /* If the body of the file is empty, return an error */
3110                 if (!newlen) {
3111                         return -1;
3112                 }
3113                 write_file(filename, (char *) body_decoded, newlen);
3114         } else {
3115                 ast_debug(5, "Body of message is NULL.\n");
3116                 return -1;
3117         }
3118         return 0;
3119 }
3120
3121 /*! 
3122  * \brief Get delimiter via mm_list callback 
3123  * \param stream
3124  *
3125  * Determines the delimiter character that is used by the underlying IMAP based mail store.
3126  */
3127 /* MUTEX should already be held */
3128 static void get_mailbox_delimiter(MAILSTREAM *stream) {
3129         char tmp[50];
3130         snprintf(tmp, sizeof(tmp), "{%s}", imapserver);
3131         mail_list(stream, tmp, "*");
3132 }
3133
3134 /*! 
3135  * \brief Check Quota for user 
3136  * \param vms a pointer to a vm_state struct, will use the mailstream property of this.
3137  * \param mailbox the mailbox to check the quota for.
3138  *
3139  * Calls imap_getquotaroot, which will populate its results into the vm_state vms input structure.
3140  */
3141 static void check_quota(struct vm_state *vms, char *mailbox) {
3142         ast_mutex_lock(&vms->lock);
3143         mail_parameters(NULL, SET_QUOTA, (void *) mm_parsequota);
3144         ast_debug(3, "Mailbox name set to: %s, about to check quotas\n", mailbox);
3145         if (vms && vms->mailstream != NULL) {
3146                 imap_getquotaroot(vms->mailstream, mailbox);
3147         } else {
3148                 ast_log(AST_LOG_WARNING, "Mailstream not available for mailbox: %s\n", mailbox);
3149         }
3150         ast_mutex_unlock(&vms->lock);
3151 }
3152
3153 #endif /* IMAP_STORAGE */
3154
3155 /*! \brief Lock file path
3156     only return failure if ast_lock_path returns 'timeout',
3157    not if the path does not exist or any other reason
3158 */
3159 static int vm_lock_path(const char *path)
3160 {
3161         switch (ast_lock_path(path)) {
3162         case AST_LOCK_TIMEOUT:
3163                 return -1;
3164         default:
3165                 return 0;
3166         }
3167 }
3168
3169
3170 #ifdef ODBC_STORAGE
3171 struct generic_prepare_struct {
3172         char *sql;
3173         int argc;
3174         char **argv;
3175 };
3176
3177 static SQLHSTMT generic_prepare(struct odbc_obj *obj, void *data)
3178 {
3179         struct generic_prepare_struct *gps = data;
3180         int res, i;
3181         SQLHSTMT stmt;
3182
3183         res = SQLAllocHandle(SQL_HANDLE_STMT, obj->con, &stmt);
3184         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3185                 ast_log(AST_LOG_WARNING, "SQL Alloc Handle failed!\n");
3186                 return NULL;
3187         }
3188         res = SQLPrepare(stmt, (unsigned char *) gps->sql, SQL_NTS);
3189         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3190                 ast_log(AST_LOG_WARNING, "SQL Prepare failed![%s]\n", gps->sql);
3191                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
3192                 return NULL;
3193         }
3194         for (i = 0; i < gps->argc; i++)
3195                 SQLBindParameter(stmt, i + 1, SQL_PARAM_INPUT, SQL_C_CHAR, SQL_CHAR, strlen(gps->argv[i]), 0, gps->argv[i], 0, NULL);
3196
3197         return stmt;
3198 }
3199
3200 /*!
3201  * \brief Retrieves a file from an ODBC data store.
3202  * \param dir the path to the file to be retreived.
3203  * \param msgnum the message number, such as within a mailbox folder.
3204  * 
3205  * This method is used by the RETRIEVE macro when mailboxes are stored in an ODBC back end.
3206  * The purpose is to get the message from the database store to the local file system, so that the message may be played, or the information file may be read.
3207  *
3208  * The file is looked up by invoking a SQL on the odbc_table (default 'voicemessages') using the dir and msgnum input parameters.
3209  * The output is the message information file with the name msgnum and the extension .txt
3210  * and the message file with the extension of its format, in the directory with base file name of the msgnum.
3211  * 
3212  * \return 0 on success, -1 on error.
3213  */
3214 static int retrieve_file(char *dir, int msgnum)
3215 {
3216         int x = 0;
3217         int res;
3218         int fd = -1;
3219         size_t fdlen = 0;
3220         void *fdm = MAP_FAILED;
3221         SQLSMALLINT colcount = 0;
3222         SQLHSTMT stmt;
3223         char sql[PATH_MAX];
3224         char fmt[80]="";
3225         char *c;
3226         char coltitle[256];
3227         SQLSMALLINT collen;
3228         SQLSMALLINT datatype;
3229         SQLSMALLINT decimaldigits;
3230         SQLSMALLINT nullable;
3231         SQLULEN colsize;
3232         SQLLEN colsize2;
3233         FILE *f = NULL;
3234         char rowdata[80];
3235         char fn[PATH_MAX];
3236         char full_fn[PATH_MAX];
3237         char msgnums[80];
3238         char *argv[] = { dir, msgnums };
3239         struct generic_prepare_struct gps = { .sql = sql, .argc = 2, .argv = argv };
3240
3241         struct odbc_obj *obj;
3242         obj = ast_odbc_request_obj(odbc_database, 0);
3243         if (obj) {
3244                 ast_copy_string(fmt, vmfmts, sizeof(fmt));
3245                 c = strchr(fmt, '|');
3246                 if (c)
3247                         *c = '\0';
3248                 if (!strcasecmp(fmt, "wav49"))
3249                         strcpy(fmt, "WAV");
3250                 snprintf(msgnums, sizeof(msgnums), "%d", msgnum);
3251                 if (msgnum > -1)
3252                         make_file(fn, sizeof(fn), dir, msgnum);
3253                 else
3254                         ast_copy_string(fn, dir, sizeof(fn));
3255
3256                 /* Create the information file */
3257                 snprintf(full_fn, sizeof(full_fn), "%s.txt", fn);
3258                 
3259                 if (!(f = fopen(full_fn, "w+"))) {
3260                         ast_log(AST_LOG_WARNING, "Failed to open/create '%s'\n", full_fn);
3261                         goto yuck;
3262                 }
3263                 
3264                 snprintf(full_fn, sizeof(full_fn), "%s.%s", fn, fmt);
3265                 snprintf(sql, sizeof(sql), "SELECT * FROM %s WHERE dir=? AND msgnum=?", odbc_table);
3266                 stmt = ast_odbc_prepare_and_execute(obj, generic_prepare, &gps);
3267                 if (!stmt) {
3268                         ast_log(AST_LOG_WARNING, "SQL Execute error!\n[%s]\n\n", sql);
3269                         ast_odbc_release_obj(obj);
3270                         goto yuck;
3271                 }
3272                 res = SQLFetch(stmt);
3273                 if (res == SQL_NO_DATA) {
3274                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3275                         ast_odbc_release_obj(obj);
3276                         goto yuck;
3277                 } else if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3278                         ast_log(AST_LOG_WARNING, "SQL Fetch error!\n[%s]\n\n", sql);
3279                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3280                         ast_odbc_release_obj(obj);
3281                         goto yuck;
3282                 }
3283                 fd = open(full_fn, O_RDWR | O_CREAT | O_TRUNC, VOICEMAIL_FILE_MODE);
3284                 if (fd < 0) {
3285                         ast_log(AST_LOG_WARNING, "Failed to write '%s': %s\n", full_fn, strerror(errno));
3286                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3287                         ast_odbc_release_obj(obj);
3288                         goto yuck;
3289                 }
3290                 res = SQLNumResultCols(stmt, &colcount);
3291                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {   
3292                         ast_log(AST_LOG_WARNING, "SQL Column Count error!\n[%s]\n\n", sql);
3293                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3294                         ast_odbc_release_obj(obj);
3295                         goto yuck;
3296                 }
3297                 if (f) 
3298                         fprintf(f, "[message]\n");
3299                 for (x = 0; x < colcount; x++) {
3300                         rowdata[0] = '\0';
3301                         collen = sizeof(coltitle);
3302                         res = SQLDescribeCol(stmt, x + 1, (unsigned char *) coltitle, sizeof(coltitle), &collen, 
3303                                                 &datatype, &colsize, &decimaldigits, &nullable);
3304                         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3305                                 ast_log(AST_LOG_WARNING, "SQL Describe Column error!\n[%s]\n\n", sql);
3306                                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3307                                 ast_odbc_release_obj(obj);
3308                                 goto yuck;
3309                         }
3310                         if (!strcasecmp(coltitle, "recording")) {
3311                                 off_t offset;
3312                                 res = SQLGetData(stmt, x + 1, SQL_BINARY, rowdata, 0, &colsize2);
3313                                 fdlen = colsize2;
3314                                 if (fd > -1) {
3315                                         char tmp[1]="";
3316                                         lseek(fd, fdlen - 1, SEEK_SET);
3317                                         if (write(fd, tmp, 1) != 1) {
3318                                                 close(fd);
3319                                                 fd = -1;
3320                                                 continue;
3321                                         }
3322                                         /* Read out in small chunks */
3323                                         for (offset = 0; offset < colsize2; offset += CHUNKSIZE) {
3324                                                 if ((fdm = mmap(NULL, CHUNKSIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, offset)) == MAP_FAILED) {
3325                                                         ast_log(AST_LOG_WARNING, "Could not mmap the output file: %s (%d)\n", strerror(errno), errno);
3326                                                         SQLFreeHandle(SQL_HANDLE_STMT, stmt);
3327                                                         ast_odbc_release_obj(obj);
3328                                                         goto yuck;
3329                                                 } else {
3330                                                         res = SQLGetData(stmt, x + 1, SQL_BINARY, fdm, CHUNKSIZE, NULL);
3331                                                         munmap(fdm, CHUNKSIZE);
3332                                                         if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3333                                                                 ast_log(AST_LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", sql);
3334                                                                 unlink(full_fn);
3335                                                                 SQLFreeHandle(SQL_HANDLE_STMT, stmt);
3336                                                                 ast_odbc_release_obj(obj);
3337                                                                 goto yuck;
3338                                                         }
3339                                                 }
3340                                         }
3341                                         if (truncate(full_fn, fdlen) < 0) {
3342                                                 ast_log(LOG_WARNING, "Unable to truncate '%s': %s\n", full_fn, strerror(errno));
3343                                         }
3344                                 }
3345                         } else {
3346                                 res = SQLGetData(stmt, x + 1, SQL_CHAR, rowdata, sizeof(rowdata), NULL);
3347                                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3348                                         ast_log(AST_LOG_WARNING, "SQL Get Data error! coltitle=%s\n[%s]\n\n", coltitle, sql);
3349                                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3350                                         ast_odbc_release_obj(obj);
3351                                         goto yuck;
3352                                 }
3353                                 if (strcasecmp(coltitle, "msgnum") && strcasecmp(coltitle, "dir") && f)
3354                                         fprintf(f, "%s=%s\n", coltitle, rowdata);
3355                         }
3356                 }
3357                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3358                 ast_odbc_release_obj(obj);
3359         } else
3360                 ast_log(AST_LOG_WARNING, "Failed to obtain database object for '%s'!\n", odbc_database);
3361 yuck:   
3362         if (f)
3363                 fclose(f);
3364         if (fd > -1)
3365                 close(fd);
3366         return x - 1;
3367 }
3368
3369 /*!
3370  * \brief Determines the highest message number in use for a given user and mailbox folder.
3371  * \param vmu 
3372  * \param dir the folder the mailbox folder to look for messages. Used to construct the SQL where clause.
3373  *
3374  * This method is used when mailboxes are stored in an ODBC back end.
3375  * Typical use to set the msgnum would be to take the value returned from this method and add one to it.
3376  *
3377  * \return the value of zero or greaterto indicate the last message index in use, -1 to indicate none.
3378  */
3379 static int last_message_index(struct ast_vm_user *vmu, char *dir)
3380 {
3381         int x = 0;
3382         int res;
3383         SQLHSTMT stmt;
3384         char sql[PATH_MAX];
3385         char rowdata[20];
3386         char *argv[] = { dir };
3387         struct generic_prepare_struct gps = { .sql = sql, .argc = 1, .argv = argv };
3388
3389         struct odbc_obj *obj;
3390         obj = ast_odbc_request_obj(odbc_database, 0);
3391         if (obj) {
3392                 snprintf(sql, sizeof(sql), "SELECT COUNT(*) FROM %s WHERE dir=?", odbc_table);
3393                 stmt = ast_odbc_prepare_and_execute(obj, generic_prepare, &gps);
3394                 if (!stmt) {
3395                         ast_log(AST_LOG_WARNING, "SQL Execute error!\n[%s]\n\n", sql);
3396                         ast_odbc_release_obj(obj);
3397                         goto yuck;
3398                 }
3399                 res = SQLFetch(stmt);
3400                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3401                         ast_log(AST_LOG_WARNING, "SQL Fetch error!\n[%s]\n\n", sql);
3402                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3403                         ast_odbc_release_obj(obj);
3404                         goto yuck;
3405                 }
3406                 res = SQLGetData(stmt, 1, SQL_CHAR, rowdata, sizeof(rowdata), NULL);
3407                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3408                         ast_log(AST_LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", sql);
3409                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3410                         ast_odbc_release_obj(obj);
3411                         goto yuck;
3412                 }
3413                 if (sscanf(rowdata, "%30d", &x) != 1)
3414                         ast_log(AST_LOG_WARNING, "Failed to read message count!\n");
3415                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3416                 ast_odbc_release_obj(obj);
3417         } else
3418                 ast_log(AST_LOG_WARNING, "Failed to obtain database object for '%s'!\n", odbc_database);
3419 yuck:   
3420         return x - 1;
3421 }
3422
3423 /*!
3424  * \brief Determines if the specified message exists.
3425  * \param dir the folder the mailbox folder to look for messages. 
3426  * \param msgnum the message index to query for.
3427  *
3428  * This method is used when mailboxes are stored in an ODBC back end.
3429  *
3430  * \return greater than zero if the message exists, zero when the message does not exist or on error.
3431  */
3432 static int message_exists(char *dir, int msgnum)
3433 {
3434         int x = 0;
3435         int res;
3436         SQLHSTMT stmt;
3437         char sql[PATH_MAX];
3438         char rowdata[20];
3439         char msgnums[20];
3440         char *argv[] = { dir, msgnums };
3441         struct generic_prepare_struct gps = { .sql = sql, .argc = 2, .argv = argv };
3442
3443         struct odbc_obj *obj;
3444         obj = ast_odbc_request_obj(odbc_database, 0);
3445         if (obj) {
3446                 snprintf(msgnums, sizeof(msgnums), "%d", msgnum);
3447                 snprintf(sql, sizeof(sql), "SELECT COUNT(*) FROM %s WHERE dir=? AND msgnum=?", odbc_table);
3448                 stmt = ast_odbc_prepare_and_execute(obj, generic_prepare, &gps);
3449                 if (!stmt) {
3450                         ast_log(AST_LOG_WARNING, "SQL Execute error!\n[%s]\n\n", sql);
3451                         ast_odbc_release_obj(obj);
3452                         goto yuck;
3453                 }
3454                 res = SQLFetch(stmt);
3455                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3456                         ast_log(AST_LOG_WARNING, "SQL Fetch error!\n[%s]\n\n", sql);
3457                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3458                         ast_odbc_release_obj(obj);
3459                         goto yuck;
3460                 }
3461                 res = SQLGetData(stmt, 1, SQL_CHAR, rowdata, sizeof(rowdata), NULL);
3462                 if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
3463                         ast_log(AST_LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", sql);
3464                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3465                         ast_odbc_release_obj(obj);
3466                         goto yuck;
3467                 }
3468                 if (sscanf(rowdata, "%30d", &x) != 1)
3469                         ast_log(AST_LOG_WARNING, "Failed to read message count!\n");
3470                 SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3471                 ast_odbc_release_obj(obj);
3472         } else
3473                 ast_log(AST_LOG_WARNING, "Failed to obtain database object for '%s'!\n", odbc_database);
3474 yuck:   
3475         return x;
3476 }
3477
3478 /*!
3479  * \brief returns the one-based count for messages.
3480  * \param vmu
3481  * \param dir the folder the mailbox folder to look for messages. Used to construct the SQL where clause.
3482  *
3483  * This method is used when mailboxes are stored in an ODBC back end.
3484  * The message index is zero-based, the first message will be index 0. For convenient display it is good to have the
3485  * one-based messages.
3486  * This method just calls last_message_index and returns +1 of its value.
3487  *
3488  * \return the value greater than zero on success to indicate the one-based count of messages, less than zero on error.
3489  */
3490 static int count_messages(struct ast_vm_user *vmu, char *dir)
3491 {
3492         return last_message_index(vmu, dir) + 1;
3493 }
3494
3495 /*!
3496  * \brief Deletes a message from the mailbox folder.
3497  * \param sdir The mailbox folder to work in.
3498  * \param smsg The message index to be deleted.
3499  *
3500  * This method is used when mailboxes are stored in an ODBC back end.
3501  * The specified message is directly deleted from the database 'voicemessages' table.
3502  * 
3503  * \return the value greater than zero on success to indicate the number of messages, less than zero on error.
3504  */
3505 static void delete_file(const char *sdir, int smsg)
3506 {
3507         SQLHSTMT stmt;
3508         char sql[PATH_MAX];
3509         char msgnums[20];
3510         char *argv[] = { NULL, msgnums };
3511         struct generic_prepare_struct gps = { .sql = sql, .argc = 2, .argv = argv };
3512         struct odbc_obj *obj;
3513
3514         argv[0] = ast_strdupa(sdir);
3515
3516         obj = ast_odbc_request_obj(odbc_database, 0);
3517         if (obj) {
3518                 snprintf(msgnums, sizeof(msgnums), "%d", smsg);
3519                 snprintf(sql, sizeof(sql), "DELETE FROM %s WHERE dir=? AND msgnum=?", odbc_table);
3520                 stmt = ast_odbc_prepare_and_execute(obj, generic_prepare, &gps);
3521                 if (!stmt)
3522                         ast_log(AST_LOG_WARNING, "SQL Execute error!\n[%s]\n\n", sql);
3523                 else
3524                         SQLFreeHandle (SQL_HANDLE_STMT, stmt);
3525                 ast_odbc_release_obj(obj);
3526         } else
3527                 ast_log(AST_LOG_WARNING, "Failed to obtain database object for '%s'!\n", odbc_database);
3528         return; 
3529 }
3530
3531 /*!
3532  * \brief Copies a voicemail from one mailbox to another.
3533  * \param sdir the folder for which to look for the message to be copied.
3534  * \param smsg the index of the message to be copied.
3535  * \param ddir the destination folder to copy the message into.
3536  * \param dmsg the index to be used for the copied message.
3537  * \param dmailboxuser The user who owns the mailbox tha contains the destination folder.
3538  * \param dmailboxcontext The context for the destination user.
3539  *
3540  * This method is used for the COPY macro when mailboxes are stored in an ODBC back end.
3541  */
3542 static void copy_file(char *sdir, int smsg, char *ddir, int dmsg, char *dmailboxuser, char *dmailboxcontext)
3543 {
3544         SQLHSTMT stmt;
3545         char sql[512];
3546         char msgnums[20];
3547         char msgnumd[20];
3548         struct odbc_obj *obj;
3549         char *argv[] = { ddir, msgnumd, dmailboxuser, dmailboxcontext, sdir, msgnums };
3550         struct generic_prepare_struct gps = { .sql = sql, .argc = 6, .argv = argv };
3551
3552         delete_file(ddir, dmsg);
3553         obj = ast_odbc_request_obj(odbc_database, 0);
3554         if (obj) {
3555                 snprintf(msgnums, sizeof(msgnums), "%d", smsg);
3556                 snprintf(msgnumd, sizeof(msgnumd), "%d", dmsg);
3557                 snprintf(sql, sizeof(sql), "INSERT INTO %s (dir, msgnum, context, macrocontext, callerid, origtime, duration, recording, flag, mailboxuser, mailboxcontext) SELECT ?,?,context,macrocontext,callerid,origtime,duration,recording,flag,?,? FROM %s WHERE dir=? AND msgnum=?", odbc_table, odbc_table);