imap/util.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   5  * Copyright (C) 1999-2002 Brendan Cully <brendan@kublai.com>
   6  *
   7  * This file is part of mutt-ng, see http://www.muttng.org/.
   8  * It's licensed under the GNU General Public License,
   9  * please see the file GPL in the top level source directory.
  10  */
  11
  12 /* general IMAP utility functions */
  13
  14 #include <lib-lib/lib-lib.h>
  15 #include <signal.h>
  16 #include <netdb.h>
  17 #include <lib-mx/mx.h>
  18
  19 #include "mutt.h"
  20 #include "imap_private.h"
  21
  22 /* -- public functions -- */
  23
  24 /* imap_parse_path: given an IMAP mailbox name, return host, port
  25  *   and a path IMAP servers will recognise.
  26  * mx.mbox is malloc'd, caller must free it */
  27 int imap_parse_path (const char *path, IMAP_MBOX * mx)
  28 {
  29   static unsigned short ImapPort = 0;
  30   static unsigned short ImapsPort = 0;
  31   struct servent *service;
  32   ciss_url_t url;
  33   char *c;
  34
  35   if (!ImapPort) {
  36     service = getservbyname ("imap", "tcp");
  37     if (service)
  38       ImapPort = ntohs (service->s_port);
  39     else
  40       ImapPort = IMAP_PORT;
  41   }
  42   if (!ImapsPort) {
  43     service = getservbyname ("imaps", "tcp");
  44     if (service)
  45       ImapsPort = ntohs (service->s_port);
  46     else
  47       ImapsPort = IMAP_SSL_PORT;
  48   }
  49
  50   /* Defaults */
  51   mx->account.flags = 0;
  52   mx->account.port = ImapPort;
  53   mx->account.type = M_ACCT_TYPE_IMAP;
  54
  55   c = m_strdup(path);
  56   url_parse_ciss (&url, c);
  57
  58   if (!(url.scheme == U_IMAP || url.scheme == U_IMAPS) ||
  59       mutt_account_fromurl (&mx->account, &url) < 0 || !*mx->account.host) {
  60     p_delete(&c);
  61     return -1;
  62   }
  63
  64   mx->mbox = m_strdup(url.path);
  65
  66   if (url.scheme == U_IMAPS)
  67     mx->account.has_ssl = 1;
  68
  69   p_delete(&c);
  70
  71   if (mx->account.has_ssl && !mx->account.has_port)
  72     mx->account.port = ImapsPort;
  73
  74   return 0;
  75 }
  76
  77 /* imap_pretty_mailbox: called by mutt_pretty_mailbox to make IMAP paths
  78  *   look nice. */
  79 void imap_pretty_mailbox (char *path)
  80 {
  81   IMAP_MBOX home, target;
  82   ciss_url_t url;
  83   char *delim;
  84   int tlen;
  85   int hlen = 0;
  86   char home_match = 0;
  87
  88   if (imap_parse_path (path, &target) < 0)
  89     return;
  90
  91   tlen = m_strlen(target.mbox);
  92   /* check whether we can do '=' substitution */
  93   if (mx_get_magic (Maildir) == M_IMAP && !imap_parse_path (Maildir, &home)) {
  94     hlen = m_strlen(home.mbox);
  95     if (tlen && mutt_account_match (&home.account, &target.account) &&
  96         !m_strncmp(home.mbox, target.mbox, hlen)) {
  97       if (!hlen)
  98         home_match = 1;
  99       else
 100         for (delim = ImapDelimChars; *delim != '\0'; delim++)
 101           if (target.mbox[hlen] == *delim)
 102             home_match = 1;
 103     }
 104     p_delete(&home.mbox);
 105   }
 106
 107   /* do the '=' substitution */
 108   if (home_match) {
 109     *path++ = '=';
 110     /* copy remaining path, skipping delimiter */
 111     if (!hlen)
 112       hlen = -1;
 113     memcpy (path, target.mbox + hlen + 1, tlen - hlen - 1);
 114     path[tlen - hlen - 1] = '\0';
 115   }
 116   else {
 117     mutt_account_tourl (&target.account, &url);
 118     url.path = target.mbox;
 119     /* FIXME: That hard-coded constant is bogus. But we need the actual
 120      *   size of the buffer from mutt_pretty_mailbox. And these pretty
 121      *   operations usually shrink the result. Still... */
 122     url_ciss_tostring (&url, path, 1024, 0);
 123   }
 124
 125   p_delete(&target.mbox);
 126 }
 127
 128 /* -- library functions -- */
 129
 130 /* imap_continue: display a message and ask the user if she wants to
 131  *   go on. */
 132 int imap_continue (const char *msg, const char *resp)
 133 {
 134   imap_error (msg, resp);
 135   return mutt_yesorno (_("Continue?"), 0);
 136 }
 137
 138 /* imap_error: show an error and abort */
 139 void imap_error (const char *where, const char *msg)
 140 {
 141   mutt_error ("%s [%s]\n", where, msg);
 142   mutt_sleep (2);
 143 }
 144
 145 /* imap_new_idata: Allocate and initialise a new IMAP_DATA structure.
 146  *   Returns NULL on failure (no mem) */
 147 IMAP_DATA *imap_new_idata (void)
 148 {
 149   IMAP_DATA *res = p_new(IMAP_DATA, 1);
 150   buffer_init(&res->cmd.buf);
 151   res->isnew = 1;
 152   return res;
 153 }
 154
 155 /* imap_free_idata: Release and clear storage in an IMAP_DATA structure. */
 156 void imap_free_idata (IMAP_DATA ** idata)
 157 {
 158     if (*idata) {
 159         p_delete(&(*idata)->capstr);
 160         string_list_wipe(&(*idata)->flags);
 161         buffer_wipe(&((*idata)->cmd.buf));
 162         p_delete(idata);
 163     }
 164 }
 165
 166 /*
 167  * Fix up the imap path.  This is necessary because the rest of mutt
 168  * assumes a hierarchy delimiter of '/', which is not necessarily true
 169  * in IMAP.  Additionally, the filesystem converts multiple hierarchy
 170  * delimiters into a single one, ie "///" is equal to "/".  IMAP servers
 171  * are not required to do this.
 172  * Moreover, IMAP servers may dislike the path ending with the delimiter.
 173  */
 174 char *imap_fix_path (IMAP_DATA * idata, char *mailbox, char *path,
 175                      ssize_t plen)
 176 {
 177   int x = 0;
 178
 179   if (!mailbox || !*mailbox) {
 180     m_strcpy(path, plen, "INBOX");
 181     return path;
 182   }
 183
 184   while (mailbox && *mailbox && (x < (plen - 1))) {
 185     if ((*mailbox == '/') || (*mailbox == idata->delim)) {
 186       while ((*mailbox == '/') || (*mailbox == idata->delim))
 187         mailbox++;
 188       path[x] = idata->delim;
 189     }
 190     else {
 191       path[x] = *mailbox;
 192       mailbox++;
 193     }
 194     x++;
 195   }
 196   if (x && path[--x] != idata->delim)
 197     x++;
 198   path[x] = '\0';
 199   return path;
 200 }
 201
 202 /* imap_get_literal_count: write number of bytes in an IMAP literal into
 203  *   bytes, return 0 on success, -1 on failure. */
 204 int imap_get_literal_count (const char *buf, long *bytes)
 205 {
 206   char *pc;
 207   char *pn;
 208
 209   if (!(pc = strchr (buf, '{')))
 210     return (-1);
 211   pc++;
 212   pn = pc;
 213   while (isdigit ((unsigned char) *pc))
 214     pc++;
 215   *pc = 0;
 216   *bytes = atoi (pn);
 217   return (0);
 218 }
 219
 220 /* imap_get_qualifier: in a tagged response, skip tag and status for
 221  *   the qualifier message. Used by imap_copy_message for TRYCREATE */
 222 char *imap_get_qualifier (char *buf)
 223 {
 224   char *s = buf;
 225
 226   /* skip tag */
 227   s = imap_next_word (s);
 228   /* skip OK/NO/BAD response */
 229   s = imap_next_word (s);
 230
 231   return s;
 232 }
 233
 234 /* imap_next_word: return index into string where next IMAP word begins */
 235 char *imap_next_word (char *s)
 236 {
 237   int quoted = 0;
 238
 239   while (*s) {
 240     if (*s == '\\') {
 241       s++;
 242       if (*s)
 243         s++;
 244       continue;
 245     }
 246     if (*s == '\"')
 247       quoted = quoted ? 0 : 1;
 248     if (!quoted && ISSPACE (*s))
 249       break;
 250     s++;
 251   }
 252
 253   return vskipspaces(s);
 254 }
 255
 256 /* imap_parse_date: date is of the form: DD-MMM-YYYY HH:MM:SS +ZZzz */
 257 time_t imap_parse_date(char *s)
 258 {
 259     struct tm tm;
 260     const char *loc;
 261     time_t tz;
 262
 263     p_clear(&tm, 1);
 264     loc = setlocale(LC_TIME, "C");
 265     strptime(s, "%d-%b-%Y %T %z", &tm);
 266     tz = tm.tm_gmtoff;
 267     setlocale(LC_TIME, loc);
 268     return timegm(&tm) + tz;
 269 }
 270
 271 /* imap_qualify_path: make an absolute IMAP folder target, given IMAP_MBOX
 272  *   and relative path. */
 273 void imap_qualify_path (char *dest, size_t len, IMAP_MBOX * mx, char *path)
 274 {
 275   ciss_url_t url;
 276
 277   mutt_account_tourl (&mx->account, &url);
 278   url.path = path;
 279
 280   url_ciss_tostring (&url, dest, len, 0);
 281 }
 282
 283
 284 /* imap_quote_string: quote string according to IMAP rules:
 285  *   surround string with quotes, escape " and \ with \ */
 286 void imap_quote_string (char *dest, size_t dlen, const char *src)
 287 {
 288   char quote[] = "\"\\", *pt;
 289   const char *s;
 290
 291   pt = dest;
 292   s = src;
 293
 294   *pt++ = '"';
 295   /* save room for trailing quote-char */
 296   dlen -= 2;
 297
 298   for (; *s && dlen; s++) {
 299     if (strchr (quote, *s)) {
 300       dlen -= 2;
 301       if (!dlen)
 302         break;
 303       *pt++ = '\\';
 304       *pt++ = *s;
 305     }
 306     else {
 307       *pt++ = *s;
 308       dlen--;
 309     }
 310   }
 311   *pt++ = '"';
 312   *pt = 0;
 313 }
 314
 315 /* imap_unquote_string: equally stupid unquoting routine */
 316 void imap_unquote_string (char *s)
 317 {
 318   char *d = s;
 319
 320   if (*s == '\"')
 321     s++;
 322   else
 323     return;
 324
 325   while (*s) {
 326     if (*s == '\"') {
 327       *d = '\0';
 328       return;
 329     }
 330     if (*s == '\\') {
 331       s++;
 332     }
 333     if (*s) {
 334       *d = *s;
 335       d++;
 336       s++;
 337     }
 338   }
 339   *d = '\0';
 340 }
 341
 342 /*
 343  * Quoting and UTF-7 conversion
 344  */
 345
 346 void imap_munge_mbox_name (char *dest, size_t dlen, const char *src)
 347 {
 348   char *buf;
 349
 350   buf = m_strdup(src);
 351   imap_utf7_encode (&buf);
 352
 353   imap_quote_string (dest, dlen, buf);
 354
 355   p_delete(&buf);
 356 }
 357
 358 void imap_unmunge_mbox_name (char *s)
 359 {
 360   char *buf;
 361
 362   imap_unquote_string (s);
 363
 364   buf = m_strdup(s);
 365   if (buf) {
 366     imap_utf7_decode (&buf);
 367     m_strcpy(s, m_strlen(s) + 1, buf);
 368   }
 369
 370   p_delete(&buf);
 371 }
 372
 373 /* imap_wordcasecmp: find word a in word list b */
 374 int imap_wordcasecmp (const char *a, const char *b)
 375 {
 376   char tmp[STRING];
 377   char *s = (char *) b;
 378   int i;
 379
 380   tmp[STRING - 1] = 0;
 381   for (i = 0; i < STRING - 2; i++, s++) {
 382     if (!*s || ISSPACE (*s)) {
 383       tmp[i] = 0;
 384       break;
 385     }
 386     tmp[i] = *s;
 387   }
 388   tmp[i + 1] = 0;
 389
 390   return ascii_strcasecmp (a, tmp);
 391 }
 392
 393 /*
 394  * Imap keepalive: poll the current folder to keep the
 395  * connection alive.
 396  *
 397  */
 398
 399 static void alrm_handler (int sig __attribute__((unused)))
 400 {
 401   /* empty */
 402 }
 403
 404 void imap_keepalive (void)
 405 {
 406   CONNECTION *conn;
 407   CONTEXT *ctx = NULL;
 408   IMAP_DATA *idata;
 409
 410   conn = mutt_socket_head ();
 411   while (conn) {
 412     if (conn->account.type == M_ACCT_TYPE_IMAP) {
 413       idata = (IMAP_DATA *) conn->data;
 414
 415       if (idata->state >= IMAP_AUTHENTICATED
 416           && time (NULL) >= idata->lastread + ImapKeepalive) {
 417         if (idata->ctx)
 418           ctx = idata->ctx;
 419         else {
 420           ctx = p_new(CONTEXT, 1);
 421           ctx->data = idata;
 422         }
 423         imap_check_mailbox (ctx, NULL, 1);
 424         if (!idata->ctx)
 425           p_delete(&ctx);
 426       }
 427     }
 428
 429     conn = conn->next;
 430   }
 431 }
 432
 433 int imap_wait_keepalive (pid_t pid)
 434 {
 435   struct sigaction oldalrm;
 436   struct sigaction act;
 437   sigset_t oldmask;
 438   int rc;
 439
 440   short imap_passive = option (OPTIMAPPASSIVE);
 441   int imap_askreconnect = quadoption (OPT_IMAPRECONNECT);
 442
 443   set_option (OPTIMAPPASSIVE);
 444   set_option (OPTKEEPQUIET);
 445   set_quadoption (OPT_IMAPRECONNECT, M_NO);
 446
 447   sigprocmask (SIG_SETMASK, NULL, &oldmask);
 448
 449   sigemptyset (&act.sa_mask);
 450   act.sa_handler = alrm_handler;
 451 #ifdef SA_INTERRUPT
 452   act.sa_flags = SA_INTERRUPT;
 453 #else
 454   act.sa_flags = 0;
 455 #endif
 456
 457   sigaction (SIGALRM, &act, &oldalrm);
 458
 459   alarm (ImapKeepalive);
 460   while (waitpid (pid, &rc, 0) < 0 && errno == EINTR) {
 461     alarm (0);                  /* cancel a possibly pending alarm */
 462     imap_keepalive ();
 463     alarm (ImapKeepalive);
 464   }
 465
 466   alarm (0);                    /* cancel a possibly pending alarm */
 467
 468   sigaction (SIGALRM, &oldalrm, NULL);
 469   sigprocmask (SIG_SETMASK, &oldmask, NULL);
 470
 471   unset_option (OPTKEEPQUIET);
 472   if (!imap_passive)
 473     unset_option (OPTIMAPPASSIVE);
 474   set_quadoption (OPT_IMAPRECONNECT, imap_askreconnect);
 475
 476   return rc;
 477 }
 478
 479 /* Allow/disallow re-opening a folder upon expunge. */
 480
 481 void imap_allow_reopen (CONTEXT * ctx)
 482 {
 483   if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
 484     CTX_DATA->reopen |= IMAP_REOPEN_ALLOW;
 485 }
 486
 487 void imap_disallow_reopen (CONTEXT * ctx)
 488 {
 489   if (ctx && ctx->magic == M_IMAP && CTX_DATA->ctx == ctx)
 490     CTX_DATA->reopen &= ~IMAP_REOPEN_ALLOW;
 491 }