citadel/modules/imap/serv_imap.c

   1 /*
   2  * IMAP server for the Citadel system
   3  *
   4  * Copyright (C) 2000-2011 by Art Cancro and others.
   5  * This code is released under the terms of the GNU General Public License.
   6  *
   7  * WARNING: the IMAP protocol is badly designed.  No implementation of it
   8  * is perfect.  Indeed, with so much gratuitous complexity, *all* IMAP
   9  * implementations have bugs.
  10  *
  11  * This program is open source software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #include "sysdep.h"
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <stdio.h>
  30 #include <fcntl.h>
  31 #include <signal.h>
  32 #include <pwd.h>
  33 #include <errno.h>
  34 #include <sys/types.h>
  35
  36 #if TIME_WITH_SYS_TIME
  37 # include <sys/time.h>
  38 # include <time.h>
  39 #else
  40 # if HAVE_SYS_TIME_H
  41 #  include <sys/time.h>
  42 # else
  43 #  include <time.h>
  44 # endif
  45 #endif
  46
  47 #include <sys/wait.h>
  48 #include <ctype.h>
  49 #include <string.h>
  50 #include <limits.h>
  51 #include <libcitadel.h>
  52 #include "citadel.h"
  53 #include "server.h"
  54 #include "citserver.h"
  55 #include "support.h"
  56 #include "config.h"
  57 #include "user_ops.h"
  58 #include "database.h"
  59 #include "msgbase.h"
  60 #include "internet_addressing.h"
  61 #include "serv_imap.h"
  62 #include "imap_tools.h"
  63 #include "imap_list.h"
  64 #include "imap_fetch.h"
  65 #include "imap_search.h"
  66 #include "imap_store.h"
  67 #include "imap_acl.h"
  68 #include "imap_metadata.h"
  69 #include "imap_misc.h"
  70
  71 #include "ctdl_module.h"
  72 int IMAPDebugEnabled = 0;
  73 HashList *ImapCmds = NULL;
  74 void registerImapCMD(const char *First, long FLen,
  75                      const char *Second, long SLen,
  76                      imap_handler H,
  77                      int Flags)
  78 {
  79         imap_handler_hook *h;
  80
  81         h = (imap_handler_hook*) malloc(sizeof(imap_handler_hook));
  82         memset(h, 0, sizeof(imap_handler_hook));
  83
  84         h->Flags = Flags;
  85         h->h = H;
  86         if (SLen == 0) {
  87                 Put(ImapCmds, First, FLen, h, NULL);
  88         }
  89         else {
  90                 char CMD[SIZ];
  91                 memcpy(CMD, First, FLen);
  92                 memcpy(CMD+FLen, Second, SLen);
  93                 CMD[FLen+SLen] = '\0';
  94                 Put(ImapCmds, CMD, FLen + SLen, h, NULL);
  95         }
  96 }
  97
  98 void imap_cleanup(void)
  99 {
 100         DeleteHash(&ImapCmds);
 101 }
 102
 103 const imap_handler_hook *imap_lookup(int num_parms, ConstStr *Params)
 104 {
 105         struct CitContext *CCC = CC;
 106         void *v;
 107         citimap *Imap = CCCIMAP;
 108
 109         if (num_parms < 1)
 110                 return NULL;
 111
 112         /* we abuse the Reply-buffer for uppercasing... */
 113         StrBufPlain(Imap->Reply, CKEY(Params[1]));
 114         StrBufUpCase(Imap->Reply);
 115
 116         IMAP_syslog(LOG_DEBUG, "---- Looking up [%s] -----",
 117                       ChrPtr(Imap->Reply));
 118         if (GetHash(ImapCmds, SKEY(Imap->Reply), &v))
 119         {
 120                 IMAPM_syslog(LOG_DEBUG, "Found.");
 121                 FlushStrBuf(Imap->Reply);
 122                 return (imap_handler_hook *) v;
 123         }
 124
 125         if (num_parms == 1)
 126         {
 127                 IMAPM_syslog(LOG_DEBUG, "NOT Found.");
 128                 FlushStrBuf(Imap->Reply);
 129                 return NULL;
 130         }
 131
 132         IMAP_syslog(LOG_DEBUG, "---- Looking up [%s] -----",
 133                       ChrPtr(Imap->Reply));
 134         StrBufAppendBufPlain(Imap->Reply, CKEY(Params[2]), 0);
 135         StrBufUpCase(Imap->Reply);
 136         if (GetHash(ImapCmds, SKEY(Imap->Reply), &v))
 137         {
 138                 IMAPM_syslog(LOG_DEBUG, "Found.");
 139                 FlushStrBuf(Imap->Reply);
 140                 return (imap_handler_hook *) v;
 141         }
 142         IMAPM_syslog(LOG_DEBUG, "NOT Found.");
 143         FlushStrBuf(Imap->Reply);
 144         return NULL;
 145 }
 146
 147 /* imap_rename() uses this struct containing list of rooms to rename */
 148 struct irl {
 149         struct irl *next;
 150         char irl_oldroom[ROOMNAMELEN];
 151         char irl_newroom[ROOMNAMELEN];
 152         int irl_newfloor;
 153 };
 154
 155 /* Data which is passed between imap_rename() and imap_rename_backend() */
 156 typedef struct __irlparms {
 157         const char *oldname;
 158         long oldnamelen;
 159         const char *newname;
 160         long newnamelen;
 161         struct irl **irl;
 162 }irlparms;
 163
 164
 165 /*
 166  * If there is a message ID map in memory, free it
 167  */
 168 void imap_free_msgids(void)
 169 {
 170         citimap *Imap = IMAP;
 171         if (Imap->msgids != NULL) {
 172                 free(Imap->msgids);
 173                 Imap->msgids = NULL;
 174                 Imap->num_msgs = 0;
 175                 Imap->num_alloc = 0;
 176         }
 177         if (Imap->flags != NULL) {
 178                 free(Imap->flags);
 179                 Imap->flags = NULL;
 180         }
 181         Imap->last_mtime = (-1);
 182 }
 183
 184
 185 /*
 186  * If there is a transmitted message in memory, free it
 187  */
 188 void imap_free_transmitted_message(void)
 189 {
 190         FreeStrBuf(&IMAP->TransmittedMessage);
 191 }
 192
 193
 194 /*
 195  * Set the \Seen, \Recent. and \Answered flags, based on the sequence
 196  * sets stored in the visit record for this user/room.  Note that we have
 197  * to parse each sequence set manually here, because calling the utility
 198  * function is_msg_in_sequence_set() over and over again is too expensive.
 199  *
 200  * first_msg should be set to 0 to rescan the flags for every message in the
 201  * room, or some other value if we're only interested in an incremental
 202  * update.
 203  */
 204 void imap_set_seen_flags(int first_msg)
 205 {
 206         citimap *Imap = IMAP;
 207         visit vbuf;
 208         int i;
 209         int num_sets;
 210         int s;
 211         char setstr[64], lostr[64], histr[64];
 212         long lo, hi;
 213
 214         if (Imap->num_msgs < 1) return;
 215         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 216
 217         for (i = first_msg; i < Imap->num_msgs; ++i) {
 218                 Imap->flags[i] = Imap->flags[i] & ~IMAP_SEEN;
 219                 Imap->flags[i] |= IMAP_RECENT;
 220                 Imap->flags[i] = Imap->flags[i] & ~IMAP_ANSWERED;
 221         }
 222
 223         /*
 224          * Do the "\Seen" flag.
 225          * (Any message not "\Seen" is considered "\Recent".)
 226          */
 227         num_sets = num_tokens(vbuf.v_seen, ',');
 228         for (s=0; s<num_sets; ++s) {
 229                 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
 230
 231                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 232                 if (num_tokens(setstr, ':') >= 2) {
 233                         extract_token(histr, setstr, 1, ':', sizeof histr);
 234                         if (!strcmp(histr, "*")) {
 235                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 236                         }
 237                 }
 238                 else {
 239                         strcpy(histr, lostr);
 240                 }
 241                 lo = atol(lostr);
 242                 hi = atol(histr);
 243
 244                 for (i = first_msg; i < Imap->num_msgs; ++i) {
 245                         if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
 246                                 Imap->flags[i] |= IMAP_SEEN;
 247                                 Imap->flags[i] = Imap->flags[i] & ~IMAP_RECENT;
 248                         }
 249                 }
 250         }
 251
 252         /* Do the ANSWERED flag */
 253         num_sets = num_tokens(vbuf.v_answered, ',');
 254         for (s=0; s<num_sets; ++s) {
 255                 extract_token(setstr, vbuf.v_answered, s, ',', sizeof setstr);
 256
 257                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 258                 if (num_tokens(setstr, ':') >= 2) {
 259                         extract_token(histr, setstr, 1, ':', sizeof histr);
 260                         if (!strcmp(histr, "*")) {
 261                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 262                         }
 263                 }
 264                 else {
 265                         strcpy(histr, lostr);
 266                 }
 267                 lo = atol(lostr);
 268                 hi = atol(histr);
 269
 270                 for (i = first_msg; i < Imap->num_msgs; ++i) {
 271                         if ((Imap->msgids[i] >= lo) && (Imap->msgids[i] <= hi)){
 272                                 Imap->flags[i] |= IMAP_ANSWERED;
 273                         }
 274                 }
 275         }
 276
 277 }
 278
 279
 280
 281 /*
 282  * Back end for imap_load_msgids()
 283  *
 284  * Optimization: instead of calling realloc() to add each message, we
 285  * allocate space in the list for REALLOC_INCREMENT messages at a time.  This
 286  * allows the mapping to proceed much faster.
 287  */
 288 void imap_add_single_msgid(long msgnum, void *userdata)
 289 {
 290         citimap *Imap = IMAP;
 291
 292         ++Imap->num_msgs;
 293         if (Imap->num_msgs > Imap->num_alloc) {
 294                 Imap->num_alloc += REALLOC_INCREMENT;
 295                 Imap->msgids = realloc(Imap->msgids, (Imap->num_alloc * sizeof(long)) );
 296                 Imap->flags = realloc(Imap->flags, (Imap->num_alloc * sizeof(unsigned int *)) );
 297         }
 298         Imap->msgids[Imap->num_msgs - 1] = msgnum;
 299         Imap->flags[Imap->num_msgs - 1] = 0;
 300 }
 301
 302
 303
 304 /*
 305  * Set up a message ID map for the current room (folder)
 306  */
 307 void imap_load_msgids(void)
 308 {
 309         struct CitContext *CCC = CC;
 310         struct cdbdata *cdbfr;
 311         citimap *Imap = CCCIMAP;
 312
 313         if (Imap->selected == 0) {
 314                 IMAPM_syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
 315                 return;
 316         }
 317
 318         imap_free_msgids();     /* If there was already a map, free it */
 319
 320         /* Load the message list */
 321         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
 322         if (cdbfr != NULL) {
 323                 Imap->msgids = malloc(cdbfr->len);
 324                 memcpy(Imap->msgids, cdbfr->ptr, cdbfr->len);
 325                 Imap->num_msgs = cdbfr->len / sizeof(long);
 326                 Imap->num_alloc = cdbfr->len / sizeof(long);
 327                 cdb_free(cdbfr);
 328         }
 329
 330         if (Imap->num_msgs) {
 331                 Imap->flags = malloc(Imap->num_alloc * sizeof(unsigned int *));
 332                 memset(Imap->flags, 0, (Imap->num_alloc * sizeof(long)) );
 333         }
 334
 335         imap_set_seen_flags(0);
 336 }
 337
 338
 339 /*
 340  * Re-scan the selected room (folder) and see if it's been changed at all
 341  */
 342 void imap_rescan_msgids(void)
 343 {
 344         struct CitContext *CCC = CC;
 345         citimap *Imap = CCCIMAP;
 346         int original_num_msgs = 0;
 347         long original_highest = 0L;
 348         int i, j, jstart;
 349         int message_still_exists;
 350         struct cdbdata *cdbfr;
 351         long *msglist = NULL;
 352         int num_msgs = 0;
 353         int num_recent = 0;
 354
 355         if (Imap->selected == 0) {
 356                 IMAPM_syslog(LOG_ERR, "imap_load_msgids() can't run; no room selected");
 357                 return;
 358         }
 359
 360         /*
 361          * Check to see if the room's contents have changed.
 362          * If not, we can avoid this rescan.
 363          */
 364         CtdlGetRoom(&CC->room, CC->room.QRname);
 365         if (Imap->last_mtime == CC->room.QRmtime) {     /* No changes! */
 366                 return;
 367         }
 368
 369         /* Load the *current* message list from disk, so we can compare it
 370          * to what we have in memory.
 371          */
 372         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
 373         if (cdbfr != NULL) {
 374                 msglist = malloc(cdbfr->len + 1);
 375                 if (msglist == NULL) {
 376                         IMAPM_syslog(LOG_CRIT, "malloc() failed");
 377                         CC->kill_me = KILLME_MALLOC_FAILED;
 378                         return;
 379                 }
 380                 memcpy(msglist, cdbfr->ptr, (size_t)cdbfr->len);
 381                 num_msgs = cdbfr->len / sizeof(long);
 382                 cdb_free(cdbfr);
 383         } else {
 384                 num_msgs = 0;
 385         }
 386
 387         /*
 388          * Check to see if any of the messages we know about have been expunged
 389          */
 390         if (Imap->num_msgs > 0) {
 391                 jstart = 0;
 392                 for (i = 0; i < Imap->num_msgs; ++i) {
 393
 394                         message_still_exists = 0;
 395                         if (num_msgs > 0) {
 396                                 for (j = jstart; j < num_msgs; ++j) {
 397                                         if (msglist[j] == Imap->msgids[i]) {
 398                                                 message_still_exists = 1;
 399                                                 jstart = j;
 400                                                 break;
 401                                         }
 402                                 }
 403                         }
 404
 405                         if (message_still_exists == 0) {
 406                                 IAPrintf("* %d EXPUNGE\r\n", i + 1);
 407
 408                                 /* Here's some nice stupid nonsense.  When a
 409                                  * message is expunged, we have to slide all
 410                                  * the existing messages up in the message
 411                                  * array.
 412                                  */
 413                                 --Imap->num_msgs;
 414                                 memmove(&Imap->msgids[i],
 415                                         &Imap->msgids[i + 1],
 416                                         (sizeof(long) *
 417                                          (Imap->num_msgs - i)));
 418                                 memmove(&Imap->flags[i],
 419                                         &Imap->flags[i + 1],
 420                                         (sizeof(long) *
 421                                          (Imap->num_msgs - i)));
 422
 423                                 --i;
 424                         }
 425
 426                 }
 427         }
 428
 429         /*
 430          * Remember how many messages were here before we re-scanned.
 431          */
 432         original_num_msgs = Imap->num_msgs;
 433         if (Imap->num_msgs > 0) {
 434                 original_highest = Imap->msgids[Imap->num_msgs - 1];
 435         } else {
 436                 original_highest = 0L;
 437         }
 438
 439         /*
 440          * Now peruse the room for *new* messages only.
 441          * This logic is probably the cause of Bug # 368
 442          * [ http://bugzilla.citadel.org/show_bug.cgi?id=368 ]
 443          */
 444         if (num_msgs > 0) {
 445                 for (j = 0; j < num_msgs; ++j) {
 446                         if (msglist[j] > original_highest) {
 447                                 imap_add_single_msgid(msglist[j], NULL);
 448                         }
 449                 }
 450         }
 451         imap_set_seen_flags(original_num_msgs);
 452
 453         /*
 454          * If new messages have arrived, tell the client about them.
 455          */
 456         if (Imap->num_msgs > original_num_msgs) {
 457
 458                 for (j = 0; j < num_msgs; ++j) {
 459                         if (Imap->flags[j] & IMAP_RECENT) {
 460                                 ++num_recent;
 461                         }
 462                 }
 463
 464                 IAPrintf("* %d EXISTS\r\n", Imap->num_msgs);
 465                 IAPrintf("* %d RECENT\r\n", num_recent);
 466         }
 467
 468         if (msglist != NULL) {
 469                 free(msglist);
 470         }
 471         Imap->last_mtime = CC->room.QRmtime;
 472 }
 473
 474
 475 /*
 476  * This cleanup function blows away the temporary memory and files used by
 477  * the IMAP server.
 478  */
 479 void imap_cleanup_function(void)
 480 {
 481         struct CitContext *CCC = CC;
 482         citimap *Imap = CCCIMAP;
 483
 484         /* Don't do this stuff if this is not a Imap session! */
 485         if (CC->h_command_function != imap_command_loop)
 486                 return;
 487
 488         /* If there is a mailbox selected, auto-expunge it. */
 489         if (Imap->selected) {
 490                 imap_do_expunge();
 491         }
 492
 493         IMAPM_syslog(LOG_DEBUG, "Performing IMAP cleanup hook");
 494         imap_free_msgids();
 495         imap_free_transmitted_message();
 496
 497         if (Imap->cached_rfc822 != NULL) {
 498                 FreeStrBuf(&Imap->cached_rfc822);
 499                 Imap->cached_rfc822_msgnum = (-1);
 500                 Imap->cached_rfc822_withbody = 0;
 501         }
 502
 503         if (Imap->cached_body != NULL) {
 504                 free(Imap->cached_body);
 505                 Imap->cached_body = NULL;
 506                 Imap->cached_body_len = 0;
 507                 Imap->cached_bodymsgnum = (-1);
 508         }
 509         FreeStrBuf(&Imap->Cmd.CmdBuf);
 510         FreeStrBuf(&Imap->Reply);
 511         if (Imap->Cmd.Params != NULL) free(Imap->Cmd.Params);
 512         free(Imap);
 513         IMAPM_syslog(LOG_DEBUG, "Finished IMAP cleanup hook");
 514 }
 515
 516
 517 /*
 518  * Does the actual work of the CAPABILITY command (because we need to
 519  * output this stuff in other places as well)
 520  */
 521 void imap_output_capability_string(void) {
 522         IAPuts("CAPABILITY IMAP4REV1 NAMESPACE ID AUTH=PLAIN AUTH=LOGIN UIDPLUS");
 523
 524 #ifdef HAVE_OPENSSL
 525         if (!CC->redirect_ssl) IAPuts(" STARTTLS");
 526 #endif
 527
 528 #ifndef DISABLE_IMAP_ACL
 529         IAPuts(" ACL");
 530 #endif
 531
 532         /* We are building a partial implementation of METADATA for the sole purpose
 533          * of interoperating with the ical/vcard version of the Bynari Insight Connector.
 534          * It is not a full RFC5464 implementation, but it should refuse non-Bynari
 535          * metadata in a compatible and graceful way.
 536          */
 537         IAPuts(" METADATA");
 538
 539         /*
 540          * LIST-EXTENDED was originally going to be required by the METADATA extension.
 541          * It was mercifully removed prior to the finalization of RFC5464.  We started
 542          * implementing this but stopped when we learned that it would not be needed.
 543          * If you uncomment this declaration you are responsible for writing a lot of new
 544          * code.
 545          *
 546          * IAPuts(" LIST-EXTENDED")
 547          */
 548 }
 549
 550
 551 /*
 552  * implements the CAPABILITY command
 553  */
 554 void imap_capability(int num_parms, ConstStr *Params)
 555 {
 556         IAPuts("* ");
 557         imap_output_capability_string();
 558         IAPuts("\r\n");
 559         IReply("OK CAPABILITY completed");
 560 }
 561
 562
 563 /*
 564  * Implements the ID command (specified by RFC2971)
 565  *
 566  * We ignore the client-supplied information, and output a NIL response.
 567  * Although this is technically a valid implementation of the extension, it
 568  * is quite useless.  It exists only so that we may see which clients are
 569  * making use of this extension.
 570  *
 571  */
 572 void imap_id(int num_parms, ConstStr *Params)
 573 {
 574         IAPuts("* ID NIL\r\n");
 575         IReply("OK ID completed");
 576 }
 577
 578
 579 /*
 580  * Here's where our IMAP session begins its happy day.
 581  */
 582 void imap_greeting(void)
 583 {
 584         citimap *Imap;
 585         CitContext *CCC = CC;
 586
 587         strcpy(CCC->cs_clientname, "IMAP session");
 588         CCC->session_specific_data = malloc(sizeof(citimap));
 589         Imap = (citimap *)CCC->session_specific_data;
 590         memset(Imap, 0, sizeof(citimap));
 591         Imap->authstate = imap_as_normal;
 592         Imap->cached_rfc822_msgnum = (-1);
 593         Imap->cached_rfc822_withbody = 0;
 594         Imap->Reply = NewStrBufPlain(NULL, SIZ * 10); /* 40k */
 595
 596         if (CCC->nologin)
 597         {
 598                 IAPuts("* BYE; Server busy, try later\r\n");
 599                 CCC->kill_me = KILLME_NOLOGIN;
 600                 IUnbuffer();
 601                 return;
 602         }
 603
 604         IAPuts("* OK [");
 605         imap_output_capability_string();
 606         IAPrintf("] %s IMAP4rev1 %s ready\r\n", config.c_fqdn, CITADEL);
 607         IUnbuffer();
 608 }
 609
 610
 611 /*
 612  * IMAPS is just like IMAP, except it goes crypto right away.
 613  */
 614 void imaps_greeting(void) {
 615         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
 616 #ifdef HAVE_OPENSSL
 617         if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO;          /* kill session if no crypto */
 618 #endif
 619         imap_greeting();
 620 }
 621
 622
 623 /*
 624  * implements the LOGIN command (ordinary username/password login)
 625  */
 626 void imap_login(int num_parms, ConstStr *Params)
 627 {
 628
 629         switch (num_parms) {
 630         case 3:
 631                 if (Params[2].Key[0] == '{') {
 632                         IAPuts("+ go ahead\r\n");
 633                         IMAP->authstate = imap_as_expecting_multilineusername;
 634                         strcpy(IMAP->authseq, Params[0].Key);
 635                         return;
 636                 }
 637                 else {
 638                         IReply("BAD incorrect number of parameters");
 639                         return;
 640                 }
 641         case 4:
 642                 if (CtdlLoginExistingUser(NULL, Params[2].Key) == login_ok) {
 643                         if (CtdlTryPassword(Params[3].Key, Params[3].len) == pass_ok) {
 644                                 /* hm, thats not doable by IReply :-( */
 645                                 IAPrintf("%s OK [", Params[0].Key);
 646                                 imap_output_capability_string();
 647                                 IAPrintf("] Hello, %s\r\n", CC->user.fullname);
 648                                 return;
 649                         }
 650                         else
 651                         {
 652                                 IReplyPrintf("NO AUTHENTICATE %s failed",
 653                                              Params[3].Key);
 654                         }
 655                 }
 656
 657                 IReply("BAD Login incorrect");
 658         default:
 659                 IReply("BAD incorrect number of parameters");
 660                 return;
 661         }
 662
 663 }
 664
 665
 666 /*
 667  * Implements the AUTHENTICATE command
 668  */
 669 void imap_authenticate(int num_parms, ConstStr *Params)
 670 {
 671         char UsrBuf[SIZ];
 672
 673         if (num_parms != 3) {
 674                 IReply("BAD incorrect number of parameters");
 675                 return;
 676         }
 677
 678         if (CC->logged_in) {
 679                 IReply("BAD Already logged in.");
 680                 return;
 681         }
 682
 683         if (!strcasecmp(Params[2].Key, "LOGIN")) {
 684                 CtdlEncodeBase64(UsrBuf, "Username:", 9, 0);
 685                 IAPrintf("+ %s\r\n", UsrBuf);
 686                 IMAP->authstate = imap_as_expecting_username;
 687                 strcpy(IMAP->authseq, Params[0].Key);
 688                 return;
 689         }
 690
 691         if (!strcasecmp(Params[2].Key, "PLAIN")) {
 692                 // CtdlEncodeBase64(UsrBuf, "Username:", 9, 0);
 693                 // IAPuts("+ %s\r\n", UsrBuf);
 694                 IAPuts("+ \r\n");
 695                 IMAP->authstate = imap_as_expecting_plainauth;
 696                 strcpy(IMAP->authseq, Params[0].Key);
 697                 return;
 698         }
 699
 700         else {
 701                 IReplyPrintf("NO AUTHENTICATE %s failed",
 702                              Params[1].Key);
 703         }
 704 }
 705
 706
 707 void imap_auth_plain(void)
 708 {
 709         citimap *Imap = IMAP;
 710         const char *decoded_authstring;
 711         char ident[256];
 712         char user[256];
 713         char pass[256];
 714         int result;
 715         long len;
 716
 717         memset(pass, 0, sizeof(pass));
 718         StrBufDecodeBase64(Imap->Cmd.CmdBuf);
 719
 720         decoded_authstring = ChrPtr(Imap->Cmd.CmdBuf);
 721         safestrncpy(ident, decoded_authstring, sizeof ident);
 722         safestrncpy(user, &decoded_authstring[strlen(ident) + 1], sizeof user);
 723         len = safestrncpy(pass, &decoded_authstring[strlen(ident) + strlen(user) + 2], sizeof pass);
 724         if (len < 0)
 725                 len = sizeof(pass) - 1;
 726
 727         Imap->authstate = imap_as_normal;
 728
 729         if (!IsEmptyStr(ident)) {
 730                 result = CtdlLoginExistingUser(user, ident);
 731         }
 732         else {
 733                 result = CtdlLoginExistingUser(NULL, user);
 734         }
 735
 736         if (result == login_ok) {
 737                 if (CtdlTryPassword(pass, len) == pass_ok) {
 738                         IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
 739                         return;
 740                 }
 741         }
 742         IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
 743 }
 744
 745
 746 void imap_auth_login_user(long state)
 747 {
 748         char PWBuf[SIZ];
 749         citimap *Imap = IMAP;
 750
 751         switch (state){
 752         case imap_as_expecting_username:
 753                 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
 754                 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
 755                 CtdlEncodeBase64(PWBuf, "Password:", 9, 0);
 756                 IAPrintf("+ %s\r\n", PWBuf);
 757
 758                 Imap->authstate = imap_as_expecting_password;
 759                 return;
 760         case imap_as_expecting_multilineusername:
 761                 extract_token(PWBuf, ChrPtr(Imap->Cmd.CmdBuf), 1, ' ', sizeof(PWBuf));
 762                 CtdlLoginExistingUser(NULL, ChrPtr(Imap->Cmd.CmdBuf));
 763                 IAPuts("+ go ahead\r\n");
 764                 Imap->authstate = imap_as_expecting_multilinepassword;
 765                 return;
 766         }
 767 }
 768
 769
 770 void imap_auth_login_pass(long state)
 771 {
 772         citimap *Imap = IMAP;
 773         const char *pass = NULL;
 774         long len = 0;
 775
 776         switch (state) {
 777         default:
 778         case imap_as_expecting_password:
 779                 StrBufDecodeBase64(Imap->Cmd.CmdBuf);
 780                 pass = ChrPtr(Imap->Cmd.CmdBuf);
 781                 len = StrLength(Imap->Cmd.CmdBuf);
 782                 break;
 783         case imap_as_expecting_multilinepassword:
 784                 pass = ChrPtr(Imap->Cmd.CmdBuf);
 785                 len = StrLength(Imap->Cmd.CmdBuf);
 786                 break;
 787         }
 788         if (len > USERNAME_SIZE)
 789                 StrBufCutAt(Imap->Cmd.CmdBuf, USERNAME_SIZE, NULL);
 790
 791         if (CtdlTryPassword(pass, len) == pass_ok) {
 792                 IAPrintf("%s OK authentication succeeded\r\n", Imap->authseq);
 793         } else {
 794                 IAPrintf("%s NO authentication failed\r\n", Imap->authseq);
 795         }
 796         Imap->authstate = imap_as_normal;
 797         return;
 798 }
 799
 800
 801 /*
 802  * implements the STARTTLS command (Citadel API version)
 803  */
 804 void imap_starttls(int num_parms, ConstStr *Params)
 805 {
 806         char ok_response[SIZ];
 807         char nosup_response[SIZ];
 808         char error_response[SIZ];
 809
 810         snprintf(ok_response, SIZ,      "%s OK begin TLS negotiation now\r\n",  Params[0].Key);
 811         snprintf(nosup_response, SIZ,   "%s NO TLS not supported here\r\n",     Params[0].Key);
 812         snprintf(error_response, SIZ,   "%s BAD Internal error\r\n",            Params[0].Key);
 813         CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
 814 }
 815
 816
 817 /*
 818  * implements the SELECT command
 819  */
 820 void imap_select(int num_parms, ConstStr *Params)
 821 {
 822         citimap *Imap = IMAP;
 823         char towhere[ROOMNAMELEN];
 824         char augmented_roomname[ROOMNAMELEN];
 825         int c = 0;
 826         int ok = 0;
 827         int ra = 0;
 828         struct ctdlroom QRscratch;
 829         int msgs, new;
 830         int i;
 831
 832         /* Convert the supplied folder name to a roomname */
 833         i = imap_roomname(towhere, sizeof towhere, Params[2].Key);
 834         if (i < 0) {
 835                 IReply("NO Invalid mailbox name.");
 836                 Imap->selected = 0;
 837                 return;
 838         }
 839
 840         /* First try a regular match */
 841         c = CtdlGetRoom(&QRscratch, towhere);
 842
 843         /* Then try a mailbox name match */
 844         if (c != 0) {
 845                 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, towhere);
 846                 c = CtdlGetRoom(&QRscratch, augmented_roomname);
 847                 if (c == 0) {
 848                         safestrncpy(towhere, augmented_roomname, sizeof(towhere));
 849                 }
 850         }
 851
 852         /* If the room exists, check security/access */
 853         if (c == 0) {
 854                 /* See if there is an existing user/room relationship */
 855                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
 856
 857                 /* normal clients have to pass through security */
 858                 if (ra & UA_KNOWN) {
 859                         ok = 1;
 860                 }
 861         }
 862
 863         /* Fail here if no such room */
 864         if (!ok) {
 865                 IReply("NO ... no such room, or access denied");
 866                 return;
 867         }
 868
 869         /* If we already had some other folder selected, auto-expunge it */
 870         imap_do_expunge();
 871
 872         /*
 873          * CtdlUserGoto() formally takes us to the desired room, happily returning
 874          * the number of messages and number of new messages.
 875          */
 876         memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
 877         CtdlUserGoto(NULL, 0, 0, &msgs, &new);
 878         Imap->selected = 1;
 879
 880         if (!strcasecmp(Params[1].Key, "EXAMINE")) {
 881                 Imap->readonly = 1;
 882         } else {
 883                 Imap->readonly = 0;
 884         }
 885
 886         imap_load_msgids();
 887         Imap->last_mtime = CC->room.QRmtime;
 888
 889         IAPrintf("* %d EXISTS\r\n", msgs);
 890         IAPrintf("* %d RECENT\r\n", new);
 891
 892         IAPrintf("* OK [UIDVALIDITY %ld] UID validity status\r\n", GLOBAL_UIDVALIDITY_VALUE);
 893         IAPrintf("* OK [UIDNEXT %ld] Predicted next UID\r\n", CitControl.MMhighest + 1);
 894
 895         /* Technically, \Deleted is a valid flag, but not a permanent flag,
 896          * because we don't maintain its state across sessions.  Citadel
 897          * automatically expunges mailboxes when they are de-selected.
 898          *
 899          * Unfortunately, omitting \Deleted as a PERMANENTFLAGS flag causes
 900          * some clients (particularly Thunderbird) to misbehave -- they simply
 901          * elect not to transmit the flag at all.  So we have to advertise
 902          * \Deleted as a PERMANENTFLAGS flag, even though it technically isn't.
 903          */
 904         IAPuts("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
 905         IAPuts("* OK [PERMANENTFLAGS (\\Deleted \\Seen \\Answered)] permanent flags\r\n");
 906
 907         IReplyPrintf("OK [%s] %s completed",
 908                 (Imap->readonly ? "READ-ONLY" : "READ-WRITE"), Params[1].Key
 909         );
 910 }
 911
 912
 913 /*
 914  * Does the real work for expunge.
 915  */
 916 int imap_do_expunge(void)
 917 {
 918         struct CitContext *CCC = CC;
 919         citimap *Imap = CCCIMAP;
 920         int i;
 921         int num_expunged = 0;
 922         long *delmsgs = NULL;
 923         int num_delmsgs = 0;
 924
 925         IMAPM_syslog(LOG_DEBUG, "imap_do_expunge() called");
 926         if (Imap->selected == 0) {
 927                 return (0);
 928         }
 929
 930         if (Imap->num_msgs > 0) {
 931                 delmsgs = malloc(Imap->num_msgs * sizeof(long));
 932                 for (i = 0; i < Imap->num_msgs; ++i) {
 933                         if (Imap->flags[i] & IMAP_DELETED) {
 934                                 delmsgs[num_delmsgs++] = Imap->msgids[i];
 935                         }
 936                 }
 937                 if (num_delmsgs > 0) {
 938                         CtdlDeleteMessages(CC->room.QRname, delmsgs, num_delmsgs, "");
 939                 }
 940                 num_expunged += num_delmsgs;
 941                 free(delmsgs);
 942         }
 943
 944         if (num_expunged > 0) {
 945                 imap_rescan_msgids();
 946         }
 947
 948         IMAP_syslog(LOG_DEBUG, "Expunged %d messages from <%s>", num_expunged, CC->room.QRname);
 949         return (num_expunged);
 950 }
 951
 952
 953 /*
 954  * implements the EXPUNGE command syntax
 955  */
 956 void imap_expunge(int num_parms, ConstStr *Params)
 957 {
 958         int num_expunged = 0;
 959
 960         num_expunged = imap_do_expunge();
 961         IReplyPrintf("OK expunged %d messages.", num_expunged);
 962 }
 963
 964
 965 /*
 966  * implements the CLOSE command
 967  */
 968 void imap_close(int num_parms, ConstStr *Params)
 969 {
 970
 971         /* Yes, we always expunge on close. */
 972         if (IMAP->selected) {
 973                 imap_do_expunge();
 974         }
 975
 976         IMAP->selected = 0;
 977         IMAP->readonly = 0;
 978         imap_free_msgids();
 979         IReply("OK CLOSE completed");
 980 }
 981
 982
 983 /*
 984  * Implements the NAMESPACE command.
 985  */
 986 void imap_namespace(int num_parms, ConstStr *Params)
 987 {
 988         int i;
 989         struct floor *fl;
 990         int floors = 0;
 991         char Namespace[SIZ];
 992
 993         IAPuts("* NAMESPACE ");
 994
 995         /* All personal folders are subordinate to INBOX. */
 996         IAPuts("((\"INBOX/\" \"/\")) ");
 997
 998         /* Other users' folders ... coming soon! FIXME */
 999         IAPuts("NIL ");
1000
1001         /* Show all floors as shared namespaces.  Neato! */
1002         IAPuts("(");
1003         for (i = 0; i < MAXFLOORS; ++i) {
1004                 fl = CtdlGetCachedFloor(i);
1005                 if (fl->f_flags & F_INUSE) {
1006                         /* if (floors > 0) IAPuts(" "); samjam says this confuses javamail */
1007                         IAPuts("(");
1008                         snprintf(Namespace, sizeof(Namespace), "%s/", fl->f_name);
1009                         plain_imap_strout(Namespace);
1010                         IAPuts(" \"/\")");
1011                         ++floors;
1012                 }
1013         }
1014         IAPuts(")");
1015
1016         /* Wind it up with a newline and a completion message. */
1017         IAPuts("\r\n");
1018         IReply("OK NAMESPACE completed");
1019 }
1020
1021
1022 /*
1023  * Implements the CREATE command
1024  *
1025  */
1026 void imap_create(int num_parms, ConstStr *Params)
1027 {
1028         struct CitContext *CCC = CC;
1029         int ret;
1030         char roomname[ROOMNAMELEN];
1031         int floornum;
1032         int flags;
1033         int newroomtype = 0;
1034         int newroomview = 0;
1035         char *notification_message = NULL;
1036
1037         if (num_parms < 3) {
1038                 IReply("NO A foder name must be specified");
1039                 return;
1040         }
1041
1042         if (strchr(Params[2].Key, '\\') != NULL) {
1043                 IReply("NO Invalid character in folder name");
1044                 IMAPM_syslog(LOG_ERR, "invalid character in folder name");
1045                 return;
1046         }
1047
1048         ret = imap_roomname(roomname, sizeof roomname, Params[2].Key);
1049         if (ret < 0) {
1050                 IReply("NO Invalid mailbox name or location");
1051                 IMAPM_syslog(LOG_ERR, "invalid mailbox name or location");
1052                 return;
1053         }
1054         floornum = (ret & 0x00ff);      /* lower 8 bits = floor number */
1055         flags = (ret & 0xff00); /* upper 8 bits = flags        */
1056
1057         if (flags & IR_MAILBOX) {
1058                 if (strncasecmp(Params[2].Key, "INBOX/", 6)) {
1059                         IReply("NO Personal folders must be created under INBOX");
1060                         IMAPM_syslog(LOG_ERR, "not subordinate to inbox");
1061                         return;
1062                 }
1063         }
1064
1065         if (flags & IR_MAILBOX) {
1066                 newroomtype = 4;                /* private mailbox */
1067                 newroomview = VIEW_MAILBOX;
1068         } else {
1069                 newroomtype = 0;                /* public folder */
1070                 newroomview = VIEW_BBS;
1071         }
1072
1073         IMAP_syslog(LOG_INFO, "Create new room <%s> on floor <%d> with type <%d>",
1074                     roomname, floornum, newroomtype);
1075
1076         ret = CtdlCreateRoom(roomname, newroomtype, "", floornum, 1, 0, newroomview);
1077         if (ret == 0) {
1078                 /*** DO NOT CHANGE THIS ERROR MESSAGE IN ANY WAY!  BYNARI CONNECTOR DEPENDS ON IT! ***/
1079                 IReply("NO Mailbox already exists, or create failed");
1080         } else {
1081                 IReply("OK CREATE completed");
1082                 /* post a message in Aide> describing the new room */
1083                 notification_message = malloc(1024);
1084                 snprintf(notification_message, 1024,
1085                         "A new room called \"%s\" has been created by %s%s%s%s\n",
1086                         roomname,
1087                         CC->user.fullname,
1088                         ((ret & QR_MAILBOX) ? " [personal]" : ""),
1089                         ((ret & QR_PRIVATE) ? " [private]" : ""),
1090                         ((ret & QR_GUESSNAME) ? " [hidden]" : "")
1091                 );
1092                 CtdlAideMessage(notification_message, "Room Creation Message");
1093                 free(notification_message);
1094         }
1095         IMAPM_syslog(LOG_DEBUG, "imap_create() completed");
1096 }
1097
1098
1099 /*
1100  * Locate a room by its IMAP folder name, and check access to it.
1101  * If zapped_ok is nonzero, we can also look for the room in the zapped list.
1102  */
1103 int imap_grabroom(char *returned_roomname, const char *foldername, int zapped_ok)
1104 {
1105         int ret;
1106         char augmented_roomname[ROOMNAMELEN];
1107         char roomname[ROOMNAMELEN];
1108         int c;
1109         struct ctdlroom QRscratch;
1110         int ra;
1111         int ok = 0;
1112
1113         ret = imap_roomname(roomname, sizeof roomname, foldername);
1114         if (ret < 0) {
1115                 return (1);
1116         }
1117
1118         /* First try a regular match */
1119         c = CtdlGetRoom(&QRscratch, roomname);
1120
1121         /* Then try a mailbox name match */
1122         if (c != 0) {
1123                 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname,
1124                             &CC->user, roomname);
1125                 c = CtdlGetRoom(&QRscratch, augmented_roomname);
1126                 if (c == 0)
1127                         safestrncpy(roomname, augmented_roomname, sizeof(roomname));
1128         }
1129
1130         /* If the room exists, check security/access */
1131         if (c == 0) {
1132                 /* See if there is an existing user/room relationship */
1133                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
1134
1135                 /* normal clients have to pass through security */
1136                 if (ra & UA_KNOWN) {
1137                         ok = 1;
1138                 }
1139                 if ((zapped_ok) && (ra & UA_ZAPPED)) {
1140                         ok = 1;
1141                 }
1142         }
1143
1144         /* Fail here if no such room */
1145         if (!ok) {
1146                 strcpy(returned_roomname, "");
1147                 return (2);
1148         } else {
1149                 safestrncpy(returned_roomname, QRscratch.QRname, ROOMNAMELEN);
1150                 return (0);
1151         }
1152 }
1153
1154
1155 /*
1156  * Implements the STATUS command (sort of)
1157  *
1158  */
1159 void imap_status(int num_parms, ConstStr *Params)
1160 {
1161         int ret;
1162         char roomname[ROOMNAMELEN];
1163         char imaproomname[SIZ];
1164         char savedroom[ROOMNAMELEN];
1165         int msgs, new;
1166
1167         ret = imap_grabroom(roomname, Params[2].Key, 1);
1168         if (ret != 0) {
1169                 IReply("NO Invalid mailbox name or location, or access denied");
1170                 return;
1171         }
1172
1173         /*
1174          * CtdlUserGoto() formally takes us to the desired room, happily returning
1175          * the number of messages and number of new messages.  (If another
1176          * folder is selected, save its name so we can return there!!!!!)
1177          */
1178         if (IMAP->selected) {
1179                 strcpy(savedroom, CC->room.QRname);
1180         }
1181         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1182
1183         /*
1184          * Tell the client what it wants to know.  In fact, tell it *more* than
1185          * it wants to know.  We happily IGnore the supplied status data item
1186          * names and simply spew all possible data items.  It's far easier to
1187          * code and probably saves us some processing time too.
1188          */
1189         imap_mailboxname(imaproomname, sizeof imaproomname, &CC->room);
1190         IAPuts("* STATUS ");
1191                plain_imap_strout(imaproomname);
1192         IAPrintf(" (MESSAGES %d ", msgs);
1193         IAPrintf("RECENT %d ", new);    /* Initially, new==recent */
1194         IAPrintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
1195         IAPrintf("UNSEEN %d)\r\n", new);
1196
1197         /*
1198          * If another folder is selected, go back to that room so we can resume
1199          * our happy day without violent explosions.
1200          */
1201         if (IMAP->selected) {
1202                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1203         }
1204
1205         /*
1206          * Oooh, look, we're done!
1207          */
1208         IReply("OK STATUS completed");
1209 }
1210
1211
1212 /*
1213  * Implements the SUBSCRIBE command
1214  *
1215  */
1216 void imap_subscribe(int num_parms, ConstStr *Params)
1217 {
1218         int ret;
1219         char roomname[ROOMNAMELEN];
1220         char savedroom[ROOMNAMELEN];
1221         int msgs, new;
1222
1223         ret = imap_grabroom(roomname, Params[2].Key, 1);
1224         if (ret != 0) {
1225                 IReplyPrintf(
1226                         "NO Error %d: invalid mailbox name or location, or access denied",
1227                         ret
1228                 );
1229                 return;
1230         }
1231
1232         /*
1233          * CtdlUserGoto() formally takes us to the desired room, which has the side
1234          * effect of marking the room as not-zapped ... exactly the effect
1235          * we're looking for.
1236          */
1237         if (IMAP->selected) {
1238                 strcpy(savedroom, CC->room.QRname);
1239         }
1240         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1241
1242         /*
1243          * If another folder is selected, go back to that room so we can resume
1244          * our happy day without violent explosions.
1245          */
1246         if (IMAP->selected) {
1247                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1248         }
1249
1250         IReply("OK SUBSCRIBE completed");
1251 }
1252
1253
1254 /*
1255  * Implements the UNSUBSCRIBE command
1256  *
1257  */
1258 void imap_unsubscribe(int num_parms, ConstStr *Params)
1259 {
1260         int ret;
1261         char roomname[ROOMNAMELEN];
1262         char savedroom[ROOMNAMELEN];
1263         int msgs, new;
1264
1265         ret = imap_grabroom(roomname, Params[2].Key, 1);
1266         if (ret != 0) {
1267                 IReply("NO Invalid mailbox name or location, or access denied");
1268                 return;
1269         }
1270
1271         /*
1272          * CtdlUserGoto() formally takes us to the desired room.
1273          */
1274         if (IMAP->selected) {
1275                 strcpy(savedroom, CC->room.QRname);
1276         }
1277         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1278
1279         /*
1280          * Now make the API call to zap the room
1281          */
1282         if (CtdlForgetThisRoom() == 0) {
1283                 IReply("OK UNSUBSCRIBE completed");
1284         } else {
1285                 IReply("NO You may not unsubscribe from this folder.");
1286         }
1287
1288         /*
1289          * If another folder is selected, go back to that room so we can resume
1290          * our happy day without violent explosions.
1291          */
1292         if (IMAP->selected) {
1293                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1294         }
1295 }
1296
1297
1298 /*
1299  * Implements the DELETE command
1300  *
1301  */
1302 void imap_delete(int num_parms, ConstStr *Params)
1303 {
1304         int ret;
1305         char roomname[ROOMNAMELEN];
1306         char savedroom[ROOMNAMELEN];
1307         int msgs, new;
1308
1309         ret = imap_grabroom(roomname, Params[2].Key, 1);
1310         if (ret != 0) {
1311                 IReply("NO Invalid mailbox name, or access denied");
1312                 return;
1313         }
1314
1315         /*
1316          * CtdlUserGoto() formally takes us to the desired room, happily returning
1317          * the number of messages and number of new messages.  (If another
1318          * folder is selected, save its name so we can return there!!!!!)
1319          */
1320         if (IMAP->selected) {
1321                 strcpy(savedroom, CC->room.QRname);
1322         }
1323         CtdlUserGoto(roomname, 0, 0, &msgs, &new);
1324
1325         /*
1326          * Now delete the room.
1327          */
1328         if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1329                 CtdlScheduleRoomForDeletion(&CC->room);
1330                 IReply("OK DELETE completed");
1331         } else {
1332                 IReply("NO Can't delete this folder.");
1333         }
1334
1335         /*
1336          * If another folder is selected, go back to that room so we can resume
1337          * our happy day without violent explosions.
1338          */
1339         if (IMAP->selected) {
1340                 CtdlUserGoto(savedroom, 0, 0, &msgs, &new);
1341         }
1342 }
1343
1344
1345 /*
1346  * Back end function for imap_rename()
1347  */
1348 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1349 {
1350         char foldername[SIZ];
1351         char newfoldername[SIZ];
1352         char newroomname[ROOMNAMELEN];
1353         int newfloor = 0;
1354         struct irl *irlp = NULL;        /* scratch pointer */
1355         irlparms *myirlparms;
1356
1357         myirlparms = (irlparms *) data;
1358         imap_mailboxname(foldername, sizeof foldername, qrbuf);
1359
1360         /* Rename subfolders */
1361         if ((!strncasecmp(foldername, myirlparms->oldname,
1362                           myirlparms->oldnamelen)
1363             && (foldername[myirlparms->oldnamelen] == '/'))) {
1364
1365                 sprintf(newfoldername, "%s/%s",
1366                         myirlparms->newname,
1367                         &foldername[myirlparms->oldnamelen + 1]
1368                     );
1369
1370                 newfloor = imap_roomname(newroomname,
1371                                          sizeof newroomname,
1372                                          newfoldername) & 0xFF;
1373
1374                 irlp = (struct irl *) malloc(sizeof(struct irl));
1375                 strcpy(irlp->irl_newroom, newroomname);
1376                 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1377                 irlp->irl_newfloor = newfloor;
1378                 irlp->next = *(myirlparms->irl);
1379                 *(myirlparms->irl) = irlp;
1380         }
1381 }
1382
1383
1384 /*
1385  * Implements the RENAME command
1386  *
1387  */
1388 void imap_rename(int num_parms, ConstStr *Params)
1389 {
1390         char old_room[ROOMNAMELEN];
1391         char new_room[ROOMNAMELEN];
1392         int newr;
1393         int new_floor;
1394         int r;
1395         struct irl *irl = NULL; /* the list */
1396         struct irl *irlp = NULL;        /* scratch pointer */
1397         irlparms irlparms;
1398         char aidemsg[1024];
1399
1400         if (strchr(Params[3].Key, '\\') != NULL) {
1401                 IReply("NO Invalid character in folder name");
1402                 return;
1403         }
1404
1405         imap_roomname(old_room, sizeof old_room, Params[2].Key);
1406         newr = imap_roomname(new_room, sizeof new_room, Params[3].Key);
1407         new_floor = (newr & 0xFF);
1408
1409         r = CtdlRenameRoom(old_room, new_room, new_floor);
1410
1411         if (r == crr_room_not_found) {
1412                 IReply("NO Could not locate this folder");
1413                 return;
1414         }
1415         if (r == crr_already_exists) {
1416                 IReplyPrintf("NO '%s' already exists.");
1417                 return;
1418         }
1419         if (r == crr_noneditable) {
1420                 IReply("NO This folder is not editable.");
1421                 return;
1422         }
1423         if (r == crr_invalid_floor) {
1424                 IReply("NO Folder root does not exist.");
1425                 return;
1426         }
1427         if (r == crr_access_denied) {
1428                 IReply("NO You do not have permission to edit this folder.");
1429                 return;
1430         }
1431         if (r != crr_ok) {
1432                 IReplyPrintf("NO Rename failed - undefined error %d", r);
1433                 return;
1434         }
1435
1436         /* If this is the INBOX, then RFC2060 says we have to just move the
1437          * contents.  In a Citadel environment it's easier to rename the room
1438          * (already did that) and create a new inbox.
1439          */
1440         if (!strcasecmp(Params[2].Key, "INBOX")) {
1441                 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
1442         }
1443
1444         /* Otherwise, do the subfolders.  Build a list of rooms to rename... */
1445         else {
1446                 irlparms.oldname = Params[2].Key;
1447                 irlparms.oldnamelen = Params[2].len;
1448                 irlparms.newname = Params[3].Key;
1449                 irlparms.newnamelen = Params[3].len;
1450                 irlparms.irl = &irl;
1451                 CtdlForEachRoom(imap_rename_backend, (void *) &irlparms);
1452
1453                 /* ... and now rename them. */
1454                 while (irl != NULL) {
1455                         r = CtdlRenameRoom(irl->irl_oldroom,
1456                                            irl->irl_newroom,
1457                                            irl->irl_newfloor);
1458                         if (r != crr_ok) {
1459                                 struct CitContext *CCC = CC;
1460                                 /* FIXME handle error returns better */
1461                                 IMAP_syslog(LOG_ERR, "CtdlRenameRoom() error %d", r);
1462                         }
1463                         irlp = irl;
1464                         irl = irl->next;
1465                         free(irlp);
1466                 }
1467         }
1468
1469         snprintf(aidemsg, sizeof aidemsg, "IMAP folder \"%s\" renamed to \"%s\" by %s\n",
1470                 Params[2].Key,
1471                 Params[3].Key,
1472                 CC->curr_user
1473         );
1474         CtdlAideMessage(aidemsg, "IMAP folder rename");
1475
1476         IReply("OK RENAME completed");
1477 }
1478
1479
1480 /*
1481  * Main command loop for IMAP sessions.
1482  */
1483 void imap_command_loop(void)
1484 {
1485         struct CitContext *CCC = CC;
1486         struct timeval tv1, tv2;
1487         suseconds_t total_time = 0;
1488         citimap *Imap;
1489         const char *pchs, *pche;
1490         const imap_handler_hook *h;
1491
1492         gettimeofday(&tv1, NULL);
1493         CCC->lastcmd = time(NULL);
1494         Imap = CCCIMAP;
1495
1496         flush_output();
1497         if (Imap->Cmd.CmdBuf == NULL)
1498                 Imap->Cmd.CmdBuf = NewStrBufPlain(NULL, SIZ);
1499         else
1500                 FlushStrBuf(Imap->Cmd.CmdBuf);
1501
1502         if (CtdlClientGetLine(Imap->Cmd.CmdBuf) < 1) {
1503                 IMAPM_syslog(LOG_ERR, "client disconnected: ending session.");
1504                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
1505                 return;
1506         }
1507
1508         if (Imap->authstate == imap_as_expecting_password) {
1509                 IMAPM_syslog(LOG_INFO, "<password>");
1510         }
1511         else if (Imap->authstate == imap_as_expecting_plainauth) {
1512                 IMAPM_syslog(LOG_INFO, "<plain_auth>");
1513         }
1514         else if ((Imap->authstate == imap_as_expecting_multilineusername) ||
1515                  cbmstrcasestr(ChrPtr(Imap->Cmd.CmdBuf), " LOGIN ")) {
1516                 IMAPM_syslog(LOG_INFO, "LOGIN...");
1517         }
1518         else {
1519                 IMAP_syslog(LOG_DEBUG, "%s", ChrPtr(Imap->Cmd.CmdBuf));
1520         }
1521
1522         pchs = ChrPtr(Imap->Cmd.CmdBuf);
1523         pche = pchs + StrLength(Imap->Cmd.CmdBuf);
1524
1525         while ((pche > pchs) &&
1526                ((*pche == '\n') ||
1527                 (*pche == '\r')))
1528         {
1529                 pche --;
1530                 StrBufCutRight(Imap->Cmd.CmdBuf, 1);
1531         }
1532         StrBufTrim(Imap->Cmd.CmdBuf);
1533
1534         /* If we're in the middle of a multi-line command, handle that */
1535         switch (Imap->authstate){
1536         case imap_as_expecting_username:
1537                 imap_auth_login_user(imap_as_expecting_username);
1538                 IUnbuffer();
1539                 return;
1540         case imap_as_expecting_multilineusername:
1541                 imap_auth_login_user(imap_as_expecting_multilineusername);
1542                 IUnbuffer();
1543                 return;
1544         case imap_as_expecting_plainauth:
1545                 imap_auth_plain();
1546                 IUnbuffer();
1547                 return;
1548         case imap_as_expecting_password:
1549                 imap_auth_login_pass(imap_as_expecting_password);
1550                 IUnbuffer();
1551                 return;
1552         case imap_as_expecting_multilinepassword:
1553                 imap_auth_login_pass(imap_as_expecting_multilinepassword);
1554                 IUnbuffer();
1555                 return;
1556         default:
1557                 break;
1558         }
1559
1560         /* Ok, at this point we're in normal command mode.
1561          * If the command just submitted does not contain a literal, we
1562          * might think about delivering some untagged stuff...
1563          */
1564
1565         /* Grab the tag, command, and parameters. */
1566         imap_parameterize(&Imap->Cmd);
1567 #if 0
1568 /* debug output the parsed vector */
1569         {
1570                 int i;
1571                 IMAP_syslog(LOG_DEBUG, "----- %ld params", Imap->Cmd.num_parms);
1572
1573         for (i=0; i < Imap->Cmd.num_parms; i++) {
1574                 if (Imap->Cmd.Params[i].len != strlen(Imap->Cmd.Params[i].Key))
1575                         IMAP_syslog(LOG_DEBUG, "*********** %ld != %ld : %s",
1576                                     Imap->Cmd.Params[i].len,
1577                                     strlen(Imap->Cmd.Params[i].Key),
1578                                       Imap->Cmd.Params[i].Key);
1579                 else
1580                         IMAP_syslog(LOG_DEBUG, "%ld : %s",
1581                                     Imap->Cmd.Params[i].len,
1582                                     Imap->Cmd.Params[i].Key);
1583         }}
1584 #endif
1585
1586         /* Now for the command set. */
1587         h = imap_lookup(Imap->Cmd.num_parms, Imap->Cmd.Params);
1588
1589         if (h == NULL)
1590         {
1591                 IReply("BAD command unrecognized");
1592                 goto BAIL;
1593         }
1594
1595         /* RFC3501 says that we cannot output untagged data during these commands */
1596         if ((h->Flags & I_FLAG_UNTAGGED) == 0) {
1597
1598                 /* we can put any additional untagged stuff right here in the future */
1599
1600                 /*
1601                  * Before processing the command that was just entered... if we happen
1602                  * to have a folder selected, we'd like to rescan that folder for new
1603                  * messages, and for deletions/changes of existing messages.  This
1604                  * could probably be optimized better with some deep thought...
1605                  */
1606                 if (Imap->selected) {
1607                         imap_rescan_msgids();
1608                 }
1609         }
1610
1611         /* does our command require a logged-in state */
1612         if ((!CC->logged_in) && ((h->Flags & I_FLAG_LOGGED_IN) != 0)) {
1613                 IReply("BAD Not logged in.");
1614                 goto BAIL;
1615         }
1616
1617         /* does our command require the SELECT state on a mailbox */
1618         if ((Imap->selected == 0) && ((h->Flags & I_FLAG_SELECT) != 0)){
1619                 IReply("BAD no folder selected");
1620                 goto BAIL;
1621         }
1622         h->h(Imap->Cmd.num_parms, Imap->Cmd.Params);
1623
1624         /* If the client transmitted a message we can free it now */
1625
1626 BAIL:
1627         IUnbuffer();
1628
1629         imap_free_transmitted_message();
1630
1631         gettimeofday(&tv2, NULL);
1632         total_time = (tv2.tv_usec + (tv2.tv_sec * 1000000)) - (tv1.tv_usec + (tv1.tv_sec * 1000000));
1633         IMAP_syslog(LOG_DEBUG, "IMAP command completed in %ld.%ld seconds",
1634                     (total_time / 1000000),
1635                     (total_time % 1000000)
1636                 );
1637 }
1638
1639 void imap_noop (int num_parms, ConstStr *Params)
1640 {
1641         IReply("OK No operation");
1642 }
1643
1644 void imap_logout(int num_parms, ConstStr *Params)
1645 {
1646         if (IMAP->selected) {
1647                 imap_do_expunge();      /* yes, we auto-expunge at logout */
1648         }
1649         IAPrintf("* BYE %s logging out\r\n", config.c_fqdn);
1650         IReply("OK Citadel IMAP session ended.");
1651         CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
1652         return;
1653 }
1654
1655 const char *CitadelServiceIMAP="IMAP";
1656 const char *CitadelServiceIMAPS="IMAPS";
1657
1658 void SetIMAPDebugEnabled(const int n)
1659 {
1660         IMAPDebugEnabled = n;
1661 }
1662 /*
1663  * This function is called to register the IMAP extension with Citadel.
1664  */
1665 CTDL_MODULE_INIT(imap)
1666 {
1667         if (ImapCmds == NULL)
1668                 ImapCmds = NewHash(1, NULL);
1669
1670         RegisterImapCMD("NOOP", "", imap_noop, I_FLAG_NONE);
1671         RegisterImapCMD("CHECK", "", imap_noop, I_FLAG_NONE);
1672         RegisterImapCMD("ID", "", imap_id, I_FLAG_NONE);
1673         RegisterImapCMD("LOGOUT", "", imap_logout, I_FLAG_NONE);
1674         RegisterImapCMD("LOGIN", "", imap_login, I_FLAG_NONE);
1675         RegisterImapCMD("AUTHENTICATE", "", imap_authenticate, I_FLAG_NONE);
1676         RegisterImapCMD("CAPABILITY", "", imap_capability, I_FLAG_NONE);
1677 #ifdef HAVE_OPENSSL
1678         RegisterImapCMD("STARTTLS", "", imap_starttls, I_FLAG_NONE);
1679 #endif
1680
1681         /* The commans below require a logged-in state */
1682         RegisterImapCMD("SELECT", "", imap_select, I_FLAG_LOGGED_IN);
1683         RegisterImapCMD("EXAMINE", "", imap_select, I_FLAG_LOGGED_IN);
1684         RegisterImapCMD("LSUB", "", imap_list, I_FLAG_LOGGED_IN);
1685         RegisterImapCMD("LIST", "", imap_list, I_FLAG_LOGGED_IN);
1686         RegisterImapCMD("CREATE", "", imap_create, I_FLAG_LOGGED_IN);
1687         RegisterImapCMD("DELETE", "", imap_delete, I_FLAG_LOGGED_IN);
1688         RegisterImapCMD("RENAME", "", imap_rename, I_FLAG_LOGGED_IN);
1689         RegisterImapCMD("STATUS", "", imap_status, I_FLAG_LOGGED_IN);
1690         RegisterImapCMD("SUBSCRIBE", "", imap_subscribe, I_FLAG_LOGGED_IN);
1691         RegisterImapCMD("UNSUBSCRIBE", "", imap_unsubscribe, I_FLAG_LOGGED_IN);
1692         RegisterImapCMD("APPEND", "", imap_append, I_FLAG_LOGGED_IN);
1693         RegisterImapCMD("NAMESPACE", "", imap_namespace, I_FLAG_LOGGED_IN);
1694         RegisterImapCMD("SETACL", "", imap_setacl, I_FLAG_LOGGED_IN);
1695         RegisterImapCMD("DELETEACL", "", imap_deleteacl, I_FLAG_LOGGED_IN);
1696         RegisterImapCMD("GETACL", "", imap_getacl, I_FLAG_LOGGED_IN);
1697         RegisterImapCMD("LISTRIGHTS", "", imap_listrights, I_FLAG_LOGGED_IN);
1698         RegisterImapCMD("MYRIGHTS", "", imap_myrights, I_FLAG_LOGGED_IN);
1699         RegisterImapCMD("GETMETADATA", "", imap_getmetadata, I_FLAG_LOGGED_IN);
1700         RegisterImapCMD("SETMETADATA", "", imap_setmetadata, I_FLAG_LOGGED_IN);
1701
1702         /* The commands below require the SELECT state on a mailbox */
1703         RegisterImapCMD("FETCH", "", imap_fetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1704         RegisterImapCMD("UID", "FETCH", imap_uidfetch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1705         RegisterImapCMD("SEARCH", "", imap_search, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1706         RegisterImapCMD("UID", "SEARCH", imap_uidsearch, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1707         RegisterImapCMD("STORE", "", imap_store, I_FLAG_LOGGED_IN | I_FLAG_SELECT | I_FLAG_UNTAGGED);
1708         RegisterImapCMD("UID", "STORE", imap_uidstore, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1709         RegisterImapCMD("COPY", "", imap_copy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1710         RegisterImapCMD("UID", "COPY", imap_uidcopy, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1711         RegisterImapCMD("EXPUNGE", "", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1712         RegisterImapCMD("UID", "EXPUNGE", imap_expunge, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1713         RegisterImapCMD("CLOSE", "", imap_close, I_FLAG_LOGGED_IN | I_FLAG_SELECT);
1714
1715         if (!threading)
1716         {
1717                 CtdlRegisterDebugFlagHook(HKEY("imapsrv"), SetIMAPDebugEnabled, &IMAPDebugEnabled);
1718                 CtdlRegisterServiceHook(config.c_imap_port,
1719                                         NULL, imap_greeting, imap_command_loop, NULL, CitadelServiceIMAP);
1720 #ifdef HAVE_OPENSSL
1721                 CtdlRegisterServiceHook(config.c_imaps_port,
1722                                         NULL, imaps_greeting, imap_command_loop, NULL, CitadelServiceIMAPS);
1723 #endif
1724                 CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP, PRIO_STOP + 30);
1725                 CtdlRegisterCleanupHook(imap_cleanup);
1726         }
1727
1728         /* return our module name for the log */
1729         return "imap";
1730 }