citadel/modules/imap/serv_imap.c

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