citadel/modules/imap/serv_imap.c

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