lib-lua/madmutt.cpkg

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2007 Pierre Habouzit
  18  */
  19
  20 #include <lib-lib/lib-lib.h>
  21
  22 #include <sys/utsname.h>
  23 #include <sys/types.h>
  24 #include <pwd.h>
  25
  26 #include <lib-lua/lib-lua.h>
  27 #include <lib-sys/unix.h>
  28
  29 #include "../mutt.h"
  30 @import "base.cpkg"
  31
  32 static char *madmutt_init_shell(void)
  33 {
  34     struct passwd *pw = getpwuid(getuid());
  35     return m_strdup(pw ? pw->pw_shell : (getenv("SHELL") ?: "/bin/sh"));
  36 }
  37
  38 static char *madmutt_init_username(void)
  39 {
  40     struct passwd *pw = getpwuid(getuid());
  41     return m_strdup(pw ? pw->pw_name : (getenv("USER") ?: "john_doe"));
  42 }
  43
  44 static char *madmutt_init_homedir(void)
  45 {
  46     struct passwd *pw = getpwuid(getuid());
  47     return m_strdup(pw ? pw->pw_dir : (getenv("HOME") ?: "/"));
  48 }
  49
  50 static char *madmutt_init_shorthost(void)
  51 {
  52     struct utsname utsname;
  53     const char *p;
  54
  55     /* some systems report the FQDN instead of just the hostname */
  56     uname(&utsname);
  57     p = strchrnul(utsname.nodename, '.');
  58     return p_dupstr(utsname.nodename, p - utsname.nodename);
  59 }
  60
  61 static char *madmutt_init_hostname(void)
  62 {
  63     char buffer[STRING];
  64
  65     if (getdnsdomainname(buffer, sizeof(buffer)) < 0)
  66         return m_strdup("@");
  67
  68     if (*buffer != '@') {
  69         int len   = m_strlen(buffer) + m_strlen(MCore.shorthost) + 2;
  70         char *res = p_new(char, len);
  71         snprintf(res, len, "%s.%s", NONULL(MCore.shorthost), buffer);
  72         return res;
  73     }
  74
  75     return m_strdup(NONULL(MCore.shorthost));
  76 }
  77
  78 #if defined(HAVE_QDBM)
  79 #  define HCACHE_BACKEND  "qdbm"
  80 #elif defined(HAVE_GDBM)
  81 #  define HCACHE_BACKEND  "gdbm"
  82 #elif defined(HAVE_DB4)
  83 #  define HCACHE_BACKEND  "db4"
  84 #else
  85 #  define HCACHE_BACKEND  NULL
  86 #endif
  87
  88 @package MCore {
  89     /*
  90      ** .pp
  91      ** \fIThis is a read-only system property and specifies madmutt's
  92      ** version string.\fP
  93      */
  94     const string_t version    = VERSION;
  95     /*
  96      ** .pp
  97      ** \fIThis is a read-only system property and specifies madmutt's
  98      ** subversion revision string.\fP
  99      */
 100     const string_t sysconfdir = SYSCONFDIR;
 101     /*
 102      ** .pp
 103      ** \fIThis is a read-only system property and specifies the
 104      ** directory containing the madmutt binary.\fP
 105      */
 106     const string_t bindir     = BINDIR;
 107     /*
 108      ** .pp
 109      ** \fIThis is a read-only system property and specifies the
 110      ** directory containing the madmutt documentation.\fP
 111      */
 112     const string_t docdir     = PKGDOCDIR;
 113     /*
 114      ** .pp
 115      ** \fIThis is a read-only system property and specifies the
 116      ** header chaching's database backend.\fP
 117      */
 118     const string_t hcache_backend = HCACHE_BACKEND;
 119
 120     /*
 121      ** .pp
 122      ** Contains the path of the \fTmadmutt_dotlock(1)\fP binary to be used by
 123      ** Madmutt.
 124      */
 125     path_t dotlock        = m_strdup(BINDIR "/mutt_dotlock");
 126     /*
 127      ** .pp
 128      ** This variable specifies which editor is used by Madmutt.
 129      ** It defaults to the value of the \fT$$$VISUAL\fP, or \fT$$$EDITOR\fP, environment
 130      ** variable, or to the string "\fTvi\fP" if neither of those are set.
 131      */
 132     path_t editor         = m_strdup(getenv("VISUAL") ?: getenv("EDITOR") ?: "vi");
 133     /*
 134      ** .pp
 135      ** Command to use when spawning a subshell.  By default, the user's login
 136      ** shell from \fT/etc/passwd\fP is used.
 137      */
 138     path_t shell          = madmutt_init_shell();
 139
 140     path_t username       = madmutt_init_username();
 141     path_t homedir        = madmutt_init_homedir();
 142
 143     /*
 144      ** .pp
 145      ** Specifies the hostname to use after the ``\fT@\fP'' in local e-mail
 146      ** addresses and during generation of \fTMessage-ID:\fP headers.
 147      ** .pp
 148      ** Please be sure to really know what you are doing when changing this variable
 149      ** to configure a custom domain part of Message-IDs.
 150      */
 151     string_t hostname     = madmutt_init_hostname();
 152     string_t shorthost    = madmutt_init_shorthost();
 153
 154     /*
 155      ** .pp
 156      ** This variable allows you to specify where Madmutt will place its
 157      ** temporary files needed for displaying and composing messages.  If
 158      ** this variable is not set, the environment variable \fT$$$TMPDIR\fP is
 159      ** used.  If \fT$$$TMPDIR\fP is not set then "\fT/tmp\fP" is used.
 160      */
 161     path_t tmpdir         = m_strdup(getenv("TMPDIR") ?: "/tmp");
 162     /*
 163      ** .pp
 164      ** A regular expression used by Madmutt to parse the GECOS field of a password
 165      ** entry when expanding the alias.  By default the regular expression is set
 166      ** to ``\fT^[^,]*\fP'' which will return the string up to the first ``\fT,\fP'' encountered.
 167      ** If the GECOS field contains a string like "lastname, firstname" then you
 168      ** should do: \fTset gecos_mask=".*"\fP.
 169      ** .pp
 170      ** This can be useful if you see the following behavior: you address a e-mail
 171      ** to user ID stevef whose full name is Steve Franklin.  If Madmutt expands
 172      ** stevef to ``Franklin'' stevef@foo.bar then you should set the gecos_mask to
 173      ** a regular expression that will match the whole name so Madmutt will expand
 174      ** ``Franklin'' to ``Franklin, Steve''.
 175      */
 176     rx_t   gecos_mask     = luaM_rxnew("^[^,]*");
 177
 178     /*
 179      ** .pp
 180      ** This variable controls whether ``quit'' and ``exit'' actually quit
 181      ** from Madmutt.  If it set to \fIyes\fP, they do quit, if it is set to \fIno\fP, they
 182      ** have no effect, and if it is set to \fIask-yes\fP or \fIask-no\fP, you are
 183      ** prompted for confirmation when you try to quit.
 184      */
 185     quadopt_t quit        = M_YES;
 186     /*
 187      ** .pp
 188      ** When this variable is \fIset\fP, Madmutt will beep when an error occurs.
 189      */
 190     bool      beep        = 1;
 191     /*
 192      ** .pp
 193      ** When this variable is \fIset\fP, Madmutt will beep whenever it prints a message
 194      ** notifying you of new mail.  This is independent of the setting of the
 195      ** ``$$beep'' variable.
 196      */
 197     bool      beep_new    = 0;
 198
 199     /*
 200      ** .pp
 201      ** When \fIset\fP, Madmutt will qualify all local addresses (ones without the
 202      ** @host portion) with the value of ``$$hostname''.  If \fIunset\fP, no
 203      ** addresses will be qualified.
 204      */
 205     bool      use_domain  = 1;
 206
 207     /*
 208      ** .pp
 209      ** \fIThis is a read-only system property and, at runtime,
 210      ** specifies the current working directory of the madmutt
 211      ** binary.\fP
 212      */
 213     const string_t pwd(void) {
 214         char path[_POSIX_PATH_MAX];
 215         getcwd(path, sizeof(path));
 216         RETURN(path);
 217     };
 218
 219     /*
 220      ** .pp
 221      ** \fIThis is a read-only system property and, at runtime,
 222      ** specifies the full path or URI of the folder currently
 223      ** open (if any).\fP
 224      */
 225     const string_t folder_path(void) {
 226         RETURN(CurrentFolder);
 227     };
 228
 229     /*
 230      ** .pp
 231      ** \fIThis is a read-only system property and, at runtime,
 232      ** specifies the actual name of the folder as far as it could
 233      ** be detected.\fP
 234      ** .pp
 235      ** For detection, $$$folder is first taken into account
 236      ** and simply stripped to form the result when a match is found. For
 237      ** example, with $$$folder being \fTimap://host\fP and the folder is
 238      ** \fTimap://host/INBOX/foo\fP, $$$madmutt_folder_name will be just
 239      ** \fTINBOX/foo\fP.)
 240      ** .pp
 241      ** Second, if the initial portion of a name is not $$$folder,
 242      ** the result will be everything after the last ``/''.
 243      ** .pp
 244      ** Third and last, the result will be just the name if neither
 245      ** $$$folder nor a ``/'' were found in the name.
 246      */
 247     const string_t folder_name(void) {
 248         const char *p;
 249
 250         if (!m_strisempty(Maildir)
 251         &&  m_strstart(CurrentFolder, Maildir, &p) && *p) {
 252             while (*p == '/')
 253                 p++;
 254             RETURN(p);
 255         } else {
 256             p = strchr(CurrentFolder ?: "", '/');
 257             RETURN(p ? p + 1 : (CurrentFolder ?: ""));
 258         }
 259     };
 260 };
 261
 262 @package MTransport {
 263     /*
 264      ** .pp
 265      ** Specifies the program and arguments used to deliver mail sent by Madmutt.
 266      ** Madmutt expects that the specified program interprets additional
 267      ** arguments as recipient addresses.
 268      */
 269     path_t   sendmail = m_strdup(SENDMAIL " -eom -oi");
 270
 271     /*
 272      ** .pp
 273      ** \fBNote:\fP you should not enable this unless you are using Sendmail
 274      ** 8.8.x or greater or in connection with the SMTP support via libESMTP.
 275      ** .pp
 276      ** This variable sets the request for when notification is returned.  The
 277      ** string consists of a comma separated list (no spaces!) of one or more
 278      ** of the following: \fInever\fP, to never request notification,
 279      ** \fIfailure\fP, to request notification on transmission failure,
 280      ** \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
 281      ** notified of successful transmission.
 282      ** .pp
 283      ** Example: \fTset dsn_notify="failure,delay"\fP
 284      */
 285     /* TODO: check it's NULL, hdrs or full */
 286     string_t dsn_notify = NULL;
 287
 288     /*
 289      ** .pp
 290      ** \fBNote:\fP you should not enable this unless you are using Sendmail
 291      ** 8.8.x or greater or in connection with the SMTP support via libESMTP.
 292      ** .pp
 293      ** This variable controls how much of your message is returned in DSN
 294      ** messages.  It may be set to either \fIhdrs\fP to return just the
 295      ** message header, or \fIfull\fP to return the full message.
 296      ** .pp
 297      ** Example: \fTset dsn_return=hdrs\fP
 298      */
 299     /* TODO: check it's never, delay, failure, success with ',' */
 300     string_t dsn_return = NULL;
 301
 302     /*
 303      ** .pp
 304      ** Specifies the number of seconds to wait for the ``$$sendmail'' process
 305      ** to finish before giving up and putting delivery in the background.
 306      ** .pp
 307      ** Madmutt interprets the value of this variable as follows:
 308      ** .dl
 309      ** .dt >0 .dd number of seconds to wait for sendmail to finish before continuing
 310      ** .dt 0  .dd wait forever for sendmail to finish
 311      ** .dt <0 .dd always put sendmail in the background without waiting
 312      ** .de
 313      ** .pp
 314      ** Note that if you specify a value other than 0, the output of the child
 315      ** process will be put in a temporary file.  If there is some error, you
 316      ** will be informed as to where to find the output.
 317      */
 318     int sendmail_wait = 0;
 319     /*
 320      ** .pp
 321      ** \fBWarning:\fP do not set this variable unless you are using a version
 322      ** of sendmail which supports the \fT-B8BITMIME\fP flag (such as sendmail
 323      ** 8.8.x) or in connection with the SMTP support via libESMTP.
 324      ** Otherwise you may not be able to send mail.
 325      ** .pp
 326      ** When \fIset\fP, Madmutt will either invoke ``$$sendmail'' with the \fT-B8BITMIME\fP
 327      ** flag when sending 8-bit messages to enable ESMTP negotiation or tell
 328      ** libESMTP to do so.
 329      */
 330     bool use_8bitmime = 0;
 331
 332     /*
 333      ** .pp
 334      ** When \fIset\fP, Madmutt will use ``$$envelope_from_address'' as the
 335      ** \fIenvelope\fP sender if that is set, otherwise it will attempt to
 336      ** derive it from the "From:" header.
 337      **
 338      ** .pp
 339      ** \fBNote:\fP This information is passed
 340      ** to sendmail command using the "-f" command line switch and
 341      ** passed to the SMTP server for libESMTP (if support is compiled in).
 342      */
 343     bool use_envelope_from = 0;
 344
 345     /*
 346      ** .pp
 347      ** Manually sets the \fIenvelope\fP sender for outgoing messages.
 348      ** This value is ignored if ``$$use_envelope_from'' is unset.
 349      */
 350     address_t envelope_from_address = NULL;
 351 };
 352
 353 /* vim:set ft=c: */