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