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