citadel/serv_imap.c

   1 /*
   2  * $Id$
   3  *
   4  * IMAP server for the Citadel/UX system
   5  * Copyright (C) 2000-2002 by Art Cancro and others.
   6  * This code is released under the terms of the GNU General Public License.
   7  *
   8  * WARNING: Mark Crispin is an idiot.  IMAP is the most brain-damaged protocol
   9  * you will ever have the profound lack of pleasure to encounter.
  10  */
  11
  12 #include "sysdep.h"
  13 #include <stdlib.h>
  14 #include <unistd.h>
  15 #include <stdio.h>
  16 #include <fcntl.h>
  17 #include <signal.h>
  18 #include <pwd.h>
  19 #include <errno.h>
  20 #include <sys/types.h>
  21
  22 #if TIME_WITH_SYS_TIME
  23 # include <sys/time.h>
  24 # include <time.h>
  25 #else
  26 # if HAVE_SYS_TIME_H
  27 #  include <sys/time.h>
  28 # else
  29 #  include <time.h>
  30 # endif
  31 #endif
  32
  33 #include <sys/wait.h>
  34 #include <ctype.h>
  35 #include <string.h>
  36 #include <limits.h>
  37 #include "citadel.h"
  38 #include "server.h"
  39 #include "sysdep_decls.h"
  40 #include "citserver.h"
  41 #include "support.h"
  42 #include "config.h"
  43 #include "serv_extensions.h"
  44 #include "room_ops.h"
  45 #include "user_ops.h"
  46 #include "policy.h"
  47 #include "database.h"
  48 #include "msgbase.h"
  49 #include "tools.h"
  50 #include "internet_addressing.h"
  51 #include "serv_imap.h"
  52 #include "imap_tools.h"
  53 #include "imap_fetch.h"
  54 #include "imap_search.h"
  55 #include "imap_store.h"
  56 #include "imap_misc.h"
  57
  58 #ifdef HAVE_OPENSSL
  59 #include "serv_crypto.h"
  60 #endif
  61
  62 /* imap_rename() uses this struct containing list of rooms to rename */
  63 struct irl {
  64         struct irl *next;
  65         char irl_oldroom[ROOMNAMELEN];
  66         char irl_newroom[ROOMNAMELEN];
  67         int irl_newfloor;
  68 };
  69
  70 /* Data which is passed between imap_rename() and imap_rename_backend() */
  71 struct irlparms {
  72         char *oldname;
  73         char *newname;
  74         struct irl **irl;
  75 };
  76
  77
  78 /*
  79  * If there is a message ID map in memory, free it
  80  */
  81 void imap_free_msgids(void)
  82 {
  83         if (IMAP->msgids != NULL) {
  84                 phree(IMAP->msgids);
  85                 IMAP->msgids = NULL;
  86                 IMAP->num_msgs = 0;
  87         }
  88         if (IMAP->flags != NULL) {
  89                 phree(IMAP->flags);
  90                 IMAP->flags = NULL;
  91         }
  92 }
  93
  94
  95 /*
  96  * If there is a transmitted message in memory, free it
  97  */
  98 void imap_free_transmitted_message(void)
  99 {
 100         if (IMAP->transmitted_message != NULL) {
 101                 phree(IMAP->transmitted_message);
 102                 IMAP->transmitted_message = NULL;
 103                 IMAP->transmitted_length = 0;
 104         }
 105 }
 106
 107
 108 /*
 109  * Set the \\Seen flag for messages which aren't new
 110  */
 111 void imap_set_seen_flags(void)
 112 {
 113         struct visit vbuf;
 114         int i;
 115
 116         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 117         if (IMAP->num_msgs > 0) {
 118                 for (i = 0; i < IMAP->num_msgs; ++i) {
 119                         if (is_msg_in_mset(vbuf.v_seen, IMAP->msgids[i])) {
 120                                 IMAP->flags[i] |= IMAP_SEEN;
 121                         }
 122                         if (is_msg_in_mset
 123                             (vbuf.v_answered, IMAP->msgids[i])) {
 124                                 IMAP->flags[i] |= IMAP_ANSWERED;
 125                         }
 126                 }
 127         }
 128 }
 129
 130
 131
 132
 133 /*
 134  * Back end for imap_load_msgids()
 135  *
 136  * Optimization: instead of calling realloc() to add each message, we
 137  * allocate space in the list for REALLOC_INCREMENT messages at a time.  This
 138  * allows the mapping to proceed much faster.
 139  */
 140 void imap_add_single_msgid(long msgnum, void *userdata)
 141 {
 142
 143         IMAP->num_msgs = IMAP->num_msgs + 1;
 144         if (IMAP->msgids == NULL) {
 145                 IMAP->msgids = mallok(IMAP->num_msgs * sizeof(long)
 146                                       * REALLOC_INCREMENT);
 147         } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
 148                 IMAP->msgids = reallok(IMAP->msgids,
 149                                        (IMAP->num_msgs +
 150                                         REALLOC_INCREMENT) * sizeof(long));
 151         }
 152         if (IMAP->flags == NULL) {
 153                 IMAP->flags = mallok(IMAP->num_msgs * sizeof(long)
 154                                      * REALLOC_INCREMENT);
 155         } else if (IMAP->num_msgs % REALLOC_INCREMENT == 0) {
 156                 IMAP->flags = reallok(IMAP->flags,
 157                                       (IMAP->num_msgs +
 158                                        REALLOC_INCREMENT) * sizeof(long));
 159         }
 160         IMAP->msgids[IMAP->num_msgs - 1] = msgnum;
 161         IMAP->flags[IMAP->num_msgs - 1] = 0;
 162 }
 163
 164
 165
 166 /*
 167  * Set up a message ID map for the current room (folder)
 168  */
 169 void imap_load_msgids(void)
 170 {
 171
 172         if (IMAP->selected == 0) {
 173                 lprintf(5,
 174                         "imap_load_msgids() can't run; no room selected\n");
 175                 return;
 176         }
 177
 178         imap_free_msgids();     /* If there was already a map, free it */
 179
 180         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL,
 181                            imap_add_single_msgid, NULL);
 182
 183         imap_set_seen_flags();
 184         lprintf(9, "imap_load_msgids() mapped %d messages\n",
 185                 IMAP->num_msgs);
 186 }
 187
 188
 189 /*
 190  * Re-scan the selected room (folder) and see if it's been changed at all
 191  */
 192 void imap_rescan_msgids(void)
 193 {
 194
 195         int original_num_msgs = 0;
 196         long original_highest = 0L;
 197         int i, j;
 198         int message_still_exists;
 199         struct cdbdata *cdbfr;
 200         long *msglist = NULL;
 201         int num_msgs = 0;
 202
 203
 204         if (IMAP->selected == 0) {
 205                 lprintf(5,
 206                         "imap_load_msgids() can't run; no room selected\n");
 207                 return;
 208         }
 209
 210         /* Load the *current* message list from disk, so we can compare it
 211          * to what we have in memory.
 212          */
 213         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
 214         if (cdbfr != NULL) {
 215                 msglist = mallok(cdbfr->len);
 216                 memcpy(msglist, cdbfr->ptr, cdbfr->len);
 217                 num_msgs = cdbfr->len / sizeof(long);
 218                 cdb_free(cdbfr);
 219         } else {
 220                 num_msgs = 0;
 221         }
 222
 223         /*
 224          * Check to see if any of the messages we know about have been expunged
 225          */
 226         if (IMAP->num_msgs > 0)
 227                 for (i = 0; i < IMAP->num_msgs; ++i) {
 228
 229                         message_still_exists = 0;
 230                         if (num_msgs > 0)
 231                                 for (j = 0; j < num_msgs; ++j) {
 232                                         if (msglist[j] == IMAP->msgids[i]) {
 233                                                 message_still_exists = 1;
 234                                         }
 235                                 }
 236
 237                         if (message_still_exists == 0) {
 238                                 cprintf("* %d EXPUNGE\r\n", i + 1);
 239
 240                                 /* Here's some nice stupid nonsense.  When a message
 241                                  * is expunged, we have to slide all the existing
 242                                  * messages up in the message array.
 243                                  */
 244                                 --IMAP->num_msgs;
 245                                 memcpy(&IMAP->msgids[i],
 246                                        &IMAP->msgids[i + 1],
 247                                        (sizeof(long) *
 248                                         (IMAP->num_msgs - i)));
 249                                 memcpy(&IMAP->flags[i],
 250                                        &IMAP->flags[i + 1],
 251                                        (sizeof(long) *
 252                                         (IMAP->num_msgs - i)));
 253
 254                                 --i;
 255                         }
 256
 257                 }
 258
 259         /*
 260          * Remember how many messages were here before we re-scanned.
 261          */
 262         original_num_msgs = IMAP->num_msgs;
 263         if (IMAP->num_msgs > 0) {
 264                 original_highest = IMAP->msgids[IMAP->num_msgs - 1];
 265         } else {
 266                 original_highest = 0L;
 267         }
 268
 269         /*
 270          * Now peruse the room for *new* messages only.
 271          */
 272         if (num_msgs > 0)
 273                 for (j = 0; j < num_msgs; ++j) {
 274                         if (msglist[j] > original_highest) {
 275                                 imap_add_single_msgid(msglist[j], NULL);
 276                         }
 277                 }
 278         imap_set_seen_flags();
 279
 280         /*
 281          * If new messages have arrived, tell the client about them.
 282          */
 283         if (IMAP->num_msgs > original_num_msgs) {
 284                 cprintf("* %d EXISTS\r\n", IMAP->num_msgs);
 285         }
 286
 287         if (num_msgs != 0)
 288                 phree(msglist);
 289 }
 290
 291
 292
 293
 294
 295
 296
 297 /*
 298  * This cleanup function blows away the temporary memory and files used by
 299  * the IMAP server.
 300  */
 301 void imap_cleanup_function(void)
 302 {
 303
 304         /* Don't do this stuff if this is not a IMAP session! */
 305         if (CC->h_command_function != imap_command_loop)
 306                 return;
 307
 308         lprintf(9, "Performing IMAP cleanup hook\n");
 309         imap_free_msgids();
 310         imap_free_transmitted_message();
 311         lprintf(9, "Finished IMAP cleanup hook\n");
 312 }
 313
 314
 315
 316 /*
 317  * Here's where our IMAP session begins its happy day.
 318  */
 319 void imap_greeting(void)
 320 {
 321
 322         strcpy(CC->cs_clientname, "IMAP session");
 323         CtdlAllocUserData(SYM_IMAP, sizeof(struct citimap));
 324         IMAP->authstate = imap_as_normal;
 325
 326         cprintf("* OK %s Citadel/UX IMAP4rev1 server ready\r\n",
 327                 config.c_fqdn);
 328 }
 329
 330
 331 /*
 332  * implements the LOGIN command (ordinary username/password login)
 333  */
 334 void imap_login(int num_parms, char *parms[])
 335 {
 336         if (CtdlLoginExistingUser(parms[2]) == login_ok) {
 337                 if (CtdlTryPassword(parms[3]) == pass_ok) {
 338                         cprintf("%s OK login successful\r\n", parms[0]);
 339                         return;
 340                 }
 341         }
 342
 343         cprintf("%s BAD Login incorrect\r\n", parms[0]);
 344 }
 345
 346
 347 /*
 348  * Implements the AUTHENTICATE command
 349  */
 350 void imap_authenticate(int num_parms, char *parms[])
 351 {
 352         char buf[SIZ];
 353
 354         if (num_parms != 3) {
 355                 cprintf("%s BAD incorrect number of parameters\r\n",
 356                         parms[0]);
 357                 return;
 358         }
 359
 360         if (CC->logged_in) {
 361                 cprintf("%s BAD Already logged in.\r\n", parms[0]);
 362                 return;
 363         }
 364
 365         if (!strcasecmp(parms[2], "LOGIN")) {
 366                 CtdlEncodeBase64(buf, "Username:", 9);
 367                 cprintf("+ %s\r\n", buf);
 368                 IMAP->authstate = imap_as_expecting_username;
 369                 strcpy(IMAP->authseq, parms[0]);
 370                 return;
 371         }
 372
 373         else {
 374                 cprintf("%s NO AUTHENTICATE %s failed\r\n",
 375                         parms[0], parms[1]);
 376         }
 377 }
 378
 379 void imap_auth_login_user(char *cmd)
 380 {
 381         char buf[SIZ];
 382
 383         CtdlDecodeBase64(buf, cmd, SIZ);
 384         CtdlLoginExistingUser(buf);
 385         CtdlEncodeBase64(buf, "Password:", 9);
 386         cprintf("+ %s\r\n", buf);
 387         IMAP->authstate = imap_as_expecting_password;
 388         return;
 389 }
 390
 391 void imap_auth_login_pass(char *cmd)
 392 {
 393         char buf[SIZ];
 394
 395         CtdlDecodeBase64(buf, cmd, SIZ);
 396         if (CtdlTryPassword(buf) == pass_ok) {
 397                 cprintf("%s OK authentication succeeded\r\n",
 398                         IMAP->authseq);
 399         } else {
 400                 cprintf("%s NO authentication failed\r\n", IMAP->authseq);
 401         }
 402         IMAP->authstate = imap_as_normal;
 403         return;
 404 }
 405
 406
 407 /*
 408  * implements the CAPABILITY command
 409  */
 410 void imap_capability(int num_parms, char *parms[])
 411 {
 412         cprintf("* CAPABILITY IMAP4 IMAP4REV1 AUTH=LOGIN");
 413
 414 #ifdef HAVE_OPENSSL
 415         cprintf(" STARTTLS");
 416 #endif
 417
 418         cprintf("\r\n");
 419         cprintf("%s OK CAPABILITY completed\r\n", parms[0]);
 420 }
 421
 422
 423
 424 /*
 425  * implements the STARTTLS command (Citadel API version)
 426  */
 427 #ifdef HAVE_OPENSSL
 428 void imap_starttls(int num_parms, char *parms[])
 429 {
 430         char ok_response[SIZ];
 431         char nosup_response[SIZ];
 432         char error_response[SIZ];
 433
 434         sprintf(ok_response,
 435                 "%s OK begin TLS negotiation now\r\n",
 436                 parms[0]);
 437         sprintf(nosup_response,
 438                 "%s NO TLS not supported here\r\n",
 439                 parms[0]);
 440         sprintf(error_response,
 441                 "%s BAD Internal error\r\n",
 442                 parms[0]);
 443         CtdlStartTLS(ok_response, nosup_response, error_response);
 444 }
 445 #endif
 446
 447
 448 /*
 449  * implements the SELECT command
 450  */
 451 void imap_select(int num_parms, char *parms[])
 452 {
 453         char towhere[SIZ];
 454         char augmented_roomname[ROOMNAMELEN];
 455         int c = 0;
 456         int ok = 0;
 457         int ra = 0;
 458         struct ctdlroom QRscratch;
 459         int msgs, new;
 460         int floornum;
 461         int roomflags;
 462         int i;
 463
 464         /* Convert the supplied folder name to a roomname */
 465         i = imap_roomname(towhere, sizeof towhere, parms[2]);
 466         if (i < 0) {
 467                 cprintf("%s NO Invalid mailbox name.\r\n", parms[0]);
 468                 IMAP->selected = 0;
 469                 return;
 470         }
 471         floornum = (i & 0x00ff);
 472         roomflags = (i & 0xff00);
 473
 474         /* First try a regular match */
 475         c = getroom(&QRscratch, towhere);
 476
 477         /* Then try a mailbox name match */
 478         if (c != 0) {
 479                 MailboxName(augmented_roomname, sizeof augmented_roomname,
 480                             &CC->user, towhere);
 481                 c = getroom(&QRscratch, augmented_roomname);
 482                 if (c == 0)
 483                         strcpy(towhere, augmented_roomname);
 484         }
 485
 486         /* If the room exists, check security/access */
 487         if (c == 0) {
 488                 /* See if there is an existing user/room relationship */
 489                 ra = CtdlRoomAccess(&QRscratch, &CC->user);
 490
 491                 /* normal clients have to pass through security */
 492                 if (ra & UA_KNOWN) {
 493                         ok = 1;
 494                 }
 495         }
 496
 497         /* Fail here if no such room */
 498         if (!ok) {
 499                 cprintf("%s NO ... no such room, or access denied\r\n",
 500                         parms[0]);
 501                 /* IMAP->selected = 0; */
 502                 return;
 503         }
 504
 505         /* If we already had some other folder selected, auto-expunge it */
 506         imap_do_expunge();
 507
 508         /*
 509          * usergoto() formally takes us to the desired room, happily returning
 510          * the number of messages and number of new messages.
 511          */
 512         memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
 513         usergoto(NULL, 0, 0, &msgs, &new);
 514         IMAP->selected = 1;
 515
 516         if (!strcasecmp(parms[1], "EXAMINE")) {
 517                 IMAP->readonly = 1;
 518         } else {
 519                 IMAP->readonly = 0;
 520         }
 521
 522         imap_load_msgids();
 523
 524         cprintf("* %d EXISTS\r\n", msgs);
 525         cprintf("* %d RECENT\r\n", new);
 526
 527         /* Note that \Deleted is a valid flag, but not a permanent flag,
 528          * because we don't maintain its state across sessions.  Citadel
 529          * automatically expunges mailboxes when they are de-selected.
 530          */
 531         cprintf("* FLAGS (\\Deleted \\Seen \\Answered)\r\n");
 532         cprintf("* OK [PERMANENTFLAGS (\\Seen \\Answered)] "
 533                 "permanent flags\r\n");
 534
 535         cprintf("* OK [UIDVALIDITY 0] UIDs valid\r\n");
 536         cprintf("%s OK [%s] %s completed\r\n",
 537                 parms[0],
 538                 (IMAP->readonly ? "READ-ONLY" : "READ-WRITE"), parms[1]);
 539 }
 540
 541
 542
 543 /*
 544  * does the real work for expunge
 545  */
 546 int imap_do_expunge(void)
 547 {
 548         int i;
 549         int num_expunged = 0;
 550
 551         lprintf(9, "imap_do_expunge() called\n");
 552         if (IMAP->selected == 0)
 553                 return (0);
 554
 555         if (IMAP->num_msgs > 0)
 556                 for (i = 0; i < IMAP->num_msgs; ++i) {
 557                         if (IMAP->flags[i] & IMAP_DELETED) {
 558                                 CtdlDeleteMessages(CC->room.QRname,
 559                                                    IMAP->msgids[i], "");
 560                                 ++num_expunged;
 561                                 lprintf(9, "%ld ... deleted\n",
 562                                         IMAP->msgids[i]);
 563                         } else {
 564                                 lprintf(9, "%ld ... not deleted\n",
 565                                         IMAP->msgids[i]);
 566                         }
 567                 }
 568
 569         if (num_expunged > 0) {
 570                 imap_rescan_msgids();
 571         }
 572
 573         return (num_expunged);
 574 }
 575
 576
 577 /*
 578  * implements the EXPUNGE command syntax
 579  */
 580 void imap_expunge(int num_parms, char *parms[])
 581 {
 582         int num_expunged = 0;
 583
 584         num_expunged = imap_do_expunge();
 585         cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
 586 }
 587
 588
 589 /*
 590  * implements the CLOSE command
 591  */
 592 void imap_close(int num_parms, char *parms[])
 593 {
 594
 595         /* Yes, we always expunge on close. */
 596         imap_do_expunge();
 597
 598         IMAP->selected = 0;
 599         IMAP->readonly = 0;
 600         imap_free_msgids();
 601         cprintf("%s OK CLOSE completed\r\n", parms[0]);
 602 }
 603
 604
 605
 606
 607 /*
 608  * Used by LIST and LSUB to show the floors in the listing
 609  */
 610 void imap_list_floors(char *cmd, char *pattern)
 611 {
 612         int i;
 613         struct floor *fl;
 614
 615         for (i = 0; i < MAXFLOORS; ++i) {
 616                 fl = cgetfloor(i);
 617                 if (fl->f_flags & F_INUSE) {
 618                         if (imap_mailbox_matches_pattern
 619                             (pattern, fl->f_name)) {
 620                                 cprintf("* %s (\\NoSelect) \"|\" ", cmd);
 621                                 imap_strout(fl->f_name);
 622                                 cprintf("\r\n");
 623                         }
 624                 }
 625         }
 626 }
 627
 628
 629
 630 /*
 631  * Back end for imap_lsub()
 632  *
 633  * IMAP "subscribed folder" is equivocated to Citadel "known rooms."  This
 634  * may or may not be the desired behavior in the future.
 635  */
 636 void imap_lsub_listroom(struct ctdlroom *qrbuf, void *data)
 637 {
 638         char buf[SIZ];
 639         int ra;
 640         char *pattern;
 641
 642         pattern = (char *) data;
 643
 644         /* Only list rooms to which the user has access!! */
 645         ra = CtdlRoomAccess(qrbuf, &CC->user);
 646         if (ra & UA_KNOWN) {
 647                 imap_mailboxname(buf, sizeof buf, qrbuf);
 648                 if (imap_mailbox_matches_pattern(pattern, buf)) {
 649                         cprintf("* LSUB () \"|\" ");
 650                         imap_strout(buf);
 651                         cprintf("\r\n");
 652                 }
 653         }
 654 }
 655
 656
 657 /*
 658  * Implements the LSUB command
 659  */
 660 void imap_lsub(int num_parms, char *parms[])
 661 {
 662         char pattern[SIZ];
 663         if (num_parms < 4) {
 664                 cprintf("%s BAD arguments invalid\r\n", parms[0]);
 665                 return;
 666         }
 667         snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
 668
 669         if (strlen(parms[3]) == 0) {
 670                 cprintf("* LIST (\\Noselect) \"|\" \"\"\r\n");
 671         }
 672
 673         else {
 674                 imap_list_floors("LSUB", pattern);
 675                 ForEachRoom(imap_lsub_listroom, pattern);
 676         }
 677
 678         cprintf("%s OK LSUB completed\r\n", parms[0]);
 679 }
 680
 681
 682
 683 /*
 684  * Back end for imap_list()
 685  */
 686 void imap_list_listroom(struct ctdlroom *qrbuf, void *data)
 687 {
 688         char buf[SIZ];
 689         int ra;
 690         char *pattern;
 691
 692         pattern = (char *) data;
 693
 694         /* Only list rooms to which the user has access!! */
 695         ra = CtdlRoomAccess(qrbuf, &CC->user);
 696         if ((ra & UA_KNOWN)
 697             || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
 698                 imap_mailboxname(buf, sizeof buf, qrbuf);
 699                 if (imap_mailbox_matches_pattern(pattern, buf)) {
 700                         cprintf("* LIST () \"|\" ");
 701                         imap_strout(buf);
 702                         cprintf("\r\n");
 703                 }
 704         }
 705 }
 706
 707
 708 /*
 709  * Implements the LIST command
 710  */
 711 void imap_list(int num_parms, char *parms[])
 712 {
 713         char pattern[SIZ];
 714         if (num_parms < 4) {
 715                 cprintf("%s BAD arguments invalid\r\n", parms[0]);
 716                 return;
 717         }
 718         snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
 719
 720         if (strlen(parms[3]) == 0) {
 721                 cprintf("* LIST (\\Noselect) \"|\" \"\"\r\n");
 722         }
 723
 724         else {
 725                 imap_list_floors("LIST", pattern);
 726                 ForEachRoom(imap_list_listroom, pattern);
 727         }
 728
 729         cprintf("%s OK LIST completed\r\n", parms[0]);
 730 }
 731
 732
 733
 734 /*
 735  * Implements the CREATE command
 736  *
 737  */
 738 void imap_create(int num_parms, char *parms[])
 739 {
 740         int ret;
 741         char roomname[ROOMNAMELEN];
 742         int floornum;
 743         int flags;
 744         int newroomtype;
 745
 746         if (strchr(parms[2], '\\') != NULL) {
 747                 cprintf("%s NO Invalid character in folder name\r\n",
 748                         parms[0]);
 749                 return;
 750         }
 751
 752         ret = imap_roomname(roomname, sizeof roomname, parms[2]);
 753         if (ret < 0) {
 754                 cprintf("%s NO Invalid mailbox name or location\r\n",
 755                         parms[0]);
 756                 return;
 757         }
 758         floornum = (ret & 0x00ff);      /* lower 8 bits = floor number */
 759         flags = (ret & 0xff00); /* upper 8 bits = flags        */
 760
 761         if (flags & IR_MAILBOX) {
 762                 newroomtype = 4;        /* private mailbox */
 763         } else {
 764                 newroomtype = 0;        /* public folder */
 765         }
 766
 767         lprintf(7, "Create new room <%s> on floor <%d> with type <%d>\n",
 768                 roomname, floornum, newroomtype);
 769
 770         ret = create_room(roomname, newroomtype, "", floornum, 1, 0);
 771         if (ret == 0) {
 772                 cprintf
 773                     ("%s NO Mailbox already exists, or create failed\r\n",
 774                      parms[0]);
 775         } else {
 776                 cprintf("%s OK CREATE completed\r\n", parms[0]);
 777         }
 778 }
 779
 780
 781 /*
 782  * Locate a room by its IMAP folder name, and check access to it
 783  */
 784 int imap_grabroom(char *returned_roomname, char *foldername)
 785 {
 786         int ret;
 787         char augmented_roomname[ROOMNAMELEN];
 788         char roomname[ROOMNAMELEN];
 789         int c;
 790         struct ctdlroom QRscratch;
 791         int ra;
 792         int ok = 0;
 793
 794         ret = imap_roomname(roomname, sizeof roomname, foldername);
 795         if (ret < 0) {
 796                 return (1);
 797         }
 798
 799         /* First try a regular match */
 800         c = getroom(&QRscratch, roomname);
 801
 802         /* Then try a mailbox name match */
 803         if (c != 0) {
 804                 MailboxName(augmented_roomname, sizeof augmented_roomname,
 805                             &CC->user, roomname);
 806                 c = getroom(&QRscratch, augmented_roomname);
 807                 if (c == 0)
 808                         strcpy(roomname, augmented_roomname);
 809         }
 810
 811         /* If the room exists, check security/access */
 812         if (c == 0) {
 813                 /* See if there is an existing user/room relationship */
 814                 ra = CtdlRoomAccess(&QRscratch, &CC->user);
 815
 816                 /* normal clients have to pass through security */
 817                 if (ra & UA_KNOWN) {
 818                         ok = 1;
 819                 }
 820         }
 821
 822         /* Fail here if no such room */
 823         if (!ok) {
 824                 strcpy(returned_roomname, "");
 825                 return (2);
 826         } else {
 827                 strcpy(returned_roomname, QRscratch.QRname);
 828                 return (0);
 829         }
 830 }
 831
 832
 833 /*
 834  * Implements the STATUS command (sort of)
 835  *
 836  */
 837 void imap_status(int num_parms, char *parms[])
 838 {
 839         int ret;
 840         char roomname[ROOMNAMELEN];
 841         char buf[SIZ];
 842         char savedroom[ROOMNAMELEN];
 843         int msgs, new;
 844
 845         ret = imap_grabroom(roomname, parms[2]);
 846         if (ret != 0) {
 847                 cprintf
 848                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
 849                      parms[0]);
 850                 return;
 851         }
 852
 853         /*
 854          * usergoto() formally takes us to the desired room, happily returning
 855          * the number of messages and number of new messages.  (If another
 856          * folder is selected, save its name so we can return there!!!!!)
 857          */
 858         if (IMAP->selected) {
 859                 strcpy(savedroom, CC->room.QRname);
 860         }
 861         usergoto(roomname, 0, 0, &msgs, &new);
 862
 863         /*
 864          * Tell the client what it wants to know.  In fact, tell it *more* than
 865          * it wants to know.  We happily IGnore the supplied status data item
 866          * names and simply spew all possible data items.  It's far easier to
 867          * code and probably saves us some processing time too.
 868          */
 869         imap_mailboxname(buf, sizeof buf, &CC->room);
 870         cprintf("* STATUS ");
 871         imap_strout(buf);
 872         cprintf(" (MESSAGES %d ", msgs);
 873         cprintf("RECENT 0 ");   /* FIXME we need to implement this */
 874         cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
 875         cprintf("UNSEEN %d)\r\n", new);
 876
 877         /*
 878          * If another folder is selected, go back to that room so we can resume
 879          * our happy day without violent explosions.
 880          */
 881         if (IMAP->selected) {
 882                 usergoto(savedroom, 0, 0, &msgs, &new);
 883         }
 884
 885         /*
 886          * Oooh, look, we're done!
 887          */
 888         cprintf("%s OK STATUS completed\r\n", parms[0]);
 889 }
 890
 891
 892
 893 /*
 894  * Implements the SUBSCRIBE command
 895  *
 896  */
 897 void imap_subscribe(int num_parms, char *parms[])
 898 {
 899         int ret;
 900         char roomname[ROOMNAMELEN];
 901         char savedroom[ROOMNAMELEN];
 902         int msgs, new;
 903
 904         ret = imap_grabroom(roomname, parms[2]);
 905         if (ret != 0) {
 906                 cprintf
 907                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
 908                      parms[0]);
 909                 return;
 910         }
 911
 912         /*
 913          * usergoto() formally takes us to the desired room, which has the side
 914          * effect of marking the room as not-zapped ... exactly the effect
 915          * we're looking for.
 916          */
 917         if (IMAP->selected) {
 918                 strcpy(savedroom, CC->room.QRname);
 919         }
 920         usergoto(roomname, 0, 0, &msgs, &new);
 921
 922         /*
 923          * If another folder is selected, go back to that room so we can resume
 924          * our happy day without violent explosions.
 925          */
 926         if (IMAP->selected) {
 927                 usergoto(savedroom, 0, 0, &msgs, &new);
 928         }
 929
 930         cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
 931 }
 932
 933
 934 /*
 935  * Implements the UNSUBSCRIBE command
 936  *
 937  */
 938 void imap_unsubscribe(int num_parms, char *parms[])
 939 {
 940         int ret;
 941         char roomname[ROOMNAMELEN];
 942         char savedroom[ROOMNAMELEN];
 943         int msgs, new;
 944
 945         ret = imap_grabroom(roomname, parms[2]);
 946         if (ret != 0) {
 947                 cprintf
 948                     ("%s NO Invalid mailbox name or location, or access denied\r\n",
 949                      parms[0]);
 950                 return;
 951         }
 952
 953         /*
 954          * usergoto() formally takes us to the desired room.
 955          */
 956         if (IMAP->selected) {
 957                 strcpy(savedroom, CC->room.QRname);
 958         }
 959         usergoto(roomname, 0, 0, &msgs, &new);
 960
 961         /*
 962          * Now make the API call to zap the room
 963          */
 964         if (CtdlForgetThisRoom() == 0) {
 965                 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
 966         } else {
 967                 cprintf
 968                     ("%s NO You may not unsubscribe from this folder.\r\n",
 969                      parms[0]);
 970         }
 971
 972         /*
 973          * If another folder is selected, go back to that room so we can resume
 974          * our happy day without violent explosions.
 975          */
 976         if (IMAP->selected) {
 977                 usergoto(savedroom, 0, 0, &msgs, &new);
 978         }
 979 }
 980
 981
 982
 983 /*
 984  * Implements the DELETE command
 985  *
 986  */
 987 void imap_delete(int num_parms, char *parms[])
 988 {
 989         int ret;
 990         char roomname[ROOMNAMELEN];
 991         char savedroom[ROOMNAMELEN];
 992         int msgs, new;
 993
 994         ret = imap_grabroom(roomname, parms[2]);
 995         if (ret != 0) {
 996                 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
 997                         parms[0]);
 998                 return;
 999         }
1000
1001         /*
1002          * usergoto() formally takes us to the desired room, happily returning
1003          * the number of messages and number of new messages.  (If another
1004          * folder is selected, save its name so we can return there!!!!!)
1005          */
1006         if (IMAP->selected) {
1007                 strcpy(savedroom, CC->room.QRname);
1008         }
1009         usergoto(roomname, 0, 0, &msgs, &new);
1010
1011         /*
1012          * Now delete the room.
1013          */
1014         if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->room)) {
1015                 cprintf("%s OK DELETE completed\r\n", parms[0]);
1016                 delete_room(&CC->room);
1017         } else {
1018                 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
1019         }
1020
1021         /*
1022          * If another folder is selected, go back to that room so we can resume
1023          * our happy day without violent explosions.
1024          */
1025         if (IMAP->selected) {
1026                 usergoto(savedroom, 0, 0, &msgs, &new);
1027         }
1028 }
1029
1030
1031 /*
1032  * Back end function for imap_rename()
1033  */
1034 void imap_rename_backend(struct ctdlroom *qrbuf, void *data)
1035 {
1036         char foldername[SIZ];
1037         char newfoldername[SIZ];
1038         char newroomname[ROOMNAMELEN];
1039         int newfloor = 0;
1040         struct irl *irlp = NULL;        /* scratch pointer */
1041         struct irlparms *irlparms;
1042
1043         irlparms = (struct irlparms *) data;
1044         imap_mailboxname(foldername, sizeof foldername, qrbuf);
1045
1046         /* Rename subfolders */
1047         if ((!strncasecmp(foldername, irlparms->oldname,
1048                           strlen(irlparms->oldname))
1049              && (foldername[strlen(irlparms->oldname)] == '|'))) {
1050
1051                 sprintf(newfoldername, "%s|%s",
1052                         irlparms->newname,
1053                         &foldername[strlen(irlparms->oldname) + 1]
1054                     );
1055
1056                 newfloor = imap_roomname(newroomname,
1057                                          sizeof newroomname,
1058                                          newfoldername) & 0xFF;
1059
1060                 irlp = (struct irl *) mallok(sizeof(struct irl));
1061                 strcpy(irlp->irl_newroom, newroomname);
1062                 strcpy(irlp->irl_oldroom, qrbuf->QRname);
1063                 irlp->irl_newfloor = newfloor;
1064                 irlp->next = *(irlparms->irl);
1065                 *(irlparms->irl) = irlp;
1066         }
1067 }
1068
1069
1070 /*
1071  * Implements the RENAME command
1072  *
1073  */
1074 void imap_rename(int num_parms, char *parms[])
1075 {
1076         char old_room[ROOMNAMELEN];
1077         char new_room[ROOMNAMELEN];
1078         int oldr, newr;
1079         int new_floor;
1080         int r;
1081         struct irl *irl = NULL; /* the list */
1082         struct irl *irlp = NULL;        /* scratch pointer */
1083         struct irlparms irlparms;
1084
1085         if (strchr(parms[3], '\\') != NULL) {
1086                 cprintf("%s NO Invalid character in folder name\r\n",
1087                         parms[0]);
1088                 return;
1089         }
1090
1091         oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
1092         newr = imap_roomname(new_room, sizeof new_room, parms[3]);
1093         new_floor = (newr & 0xFF);
1094
1095         r = CtdlRenameRoom(old_room, new_room, new_floor);
1096
1097         if (r == crr_room_not_found) {
1098                 cprintf("%s NO Could not locate this folder\r\n",
1099                         parms[0]);
1100                 return;
1101         }
1102         if (r == crr_already_exists) {
1103                 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
1104                 return;
1105         }
1106         if (r == crr_noneditable) {
1107                 cprintf("%s This folder is not editable.\r\n", parms[0]);
1108                 return;
1109         }
1110         if (r == crr_invalid_floor) {
1111                 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1112                 return;
1113         }
1114         if (r == crr_access_denied) {
1115                 cprintf("%s You do not have permission to edit "
1116                         "this folder.\r\n", parms[0]);
1117                 return;
1118         }
1119         if (r != crr_ok) {
1120                 cprintf("%s NO Rename failed - undefined error %d\r\n",
1121                         parms[0], r);
1122                 return;
1123         }
1124
1125
1126         /* If this is the INBOX, then RFC2060 says we have to just move the
1127          * contents.  In a Citadel environment it's easier to rename the room
1128          * (already did that) and create a new inbox.
1129          */
1130         if (!strcasecmp(parms[2], "INBOX")) {
1131                 create_room(MAILROOM, 4, "", 0, 1, 0);
1132         }
1133
1134         /* Otherwise, do the subfolders.  Build a list of rooms to rename... */
1135         else {
1136                 irlparms.oldname = parms[2];
1137                 irlparms.newname = parms[3];
1138                 irlparms.irl = &irl;
1139                 ForEachRoom(imap_rename_backend, (void *) &irlparms);
1140
1141                 /* ... and now rename them. */
1142                 while (irl != NULL) {
1143                         r = CtdlRenameRoom(irl->irl_oldroom,
1144                                            irl->irl_newroom,
1145                                            irl->irl_newfloor);
1146                         if (r != crr_ok) {
1147                                 /* FIXME handle error returns better */
1148                                 lprintf(5, "CtdlRenameRoom() error %d\n",
1149                                         r);
1150                         }
1151                         irlp = irl;
1152                         irl = irl->next;
1153                         phree(irlp);
1154                 }
1155         }
1156
1157         cprintf("%s OK RENAME completed\r\n", parms[0]);
1158 }
1159
1160
1161
1162
1163 /*
1164  * Main command loop for IMAP sessions.
1165  */
1166 void imap_command_loop(void)
1167 {
1168         char cmdbuf[SIZ];
1169         char *parms[SIZ];
1170         int num_parms;
1171
1172         time(&CC->lastcmd);
1173         memset(cmdbuf, 0, sizeof cmdbuf);       /* Clear it, just in case */
1174         if (client_gets(cmdbuf) < 1) {
1175                 lprintf(3, "IMAP socket is broken.  Ending session.\r\n");
1176                 CC->kill_me = 1;
1177                 return;
1178         }
1179
1180         lprintf(5, "IMAP: %s\r\n", cmdbuf);
1181         while (strlen(cmdbuf) < 5)
1182                 strcat(cmdbuf, " ");
1183
1184
1185         /* strip off l/t whitespace and CRLF */
1186         if (cmdbuf[strlen(cmdbuf) - 1] == '\n')
1187                 cmdbuf[strlen(cmdbuf) - 1] = 0;
1188         if (cmdbuf[strlen(cmdbuf) - 1] == '\r')
1189                 cmdbuf[strlen(cmdbuf) - 1] = 0;
1190         striplt(cmdbuf);
1191
1192         /* If we're in the middle of a multi-line command, handle that */
1193         if (IMAP->authstate == imap_as_expecting_username) {
1194                 imap_auth_login_user(cmdbuf);
1195                 return;
1196         }
1197         if (IMAP->authstate == imap_as_expecting_password) {
1198                 imap_auth_login_pass(cmdbuf);
1199                 return;
1200         }
1201
1202
1203         /* Ok, at this point we're in normal command mode.  The first thing
1204          * we do is print any incoming pages (yeah! we really do!)
1205          */
1206         imap_print_express_messages();
1207
1208         /*
1209          * Before processing the command that was just entered... if we happen
1210          * to have a folder selected, we'd like to rescan that folder for new
1211          * messages, and for deletions/changes of existing messages.  This
1212          * could probably be optimized somehow, but IMAP sucks...
1213          */
1214         if (IMAP->selected) {
1215                 imap_rescan_msgids();
1216         }
1217
1218         /* Now for the command set. */
1219
1220         /* Grab the tag, command, and parameters.  Check syntax. */
1221         num_parms = imap_parameterize(parms, cmdbuf);
1222         if (num_parms < 2) {
1223                 cprintf("BAD syntax error\r\n");
1224         }
1225
1226         /* The commands below may be executed in any state */
1227
1228         else if ((!strcasecmp(parms[1], "NOOP"))
1229                  || (!strcasecmp(parms[1], "CHECK"))) {
1230                 cprintf("%s OK This command successfully did nothing.\r\n",
1231                         parms[0]);
1232         }
1233
1234         else if (!strcasecmp(parms[1], "LOGOUT")) {
1235                 imap_do_expunge();      /* yes, we auto-expunge */
1236                 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1237                 cprintf("%s OK thank you for using Citadel IMAP\r\n",
1238                         parms[0]);
1239                 CC->kill_me = 1;
1240                 return;
1241         }
1242
1243         else if (!strcasecmp(parms[1], "LOGIN")) {
1244                 imap_login(num_parms, parms);
1245         }
1246
1247         else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1248                 imap_authenticate(num_parms, parms);
1249         }
1250
1251         else if (!strcasecmp(parms[1], "CAPABILITY")) {
1252                 imap_capability(num_parms, parms);
1253         }
1254 #ifdef HAVE_OPENSSL
1255         else if (!strcasecmp(parms[1], "STARTTLS")) {
1256                 imap_starttls(num_parms, parms);
1257         }
1258 #endif
1259         else if (!CC->logged_in) {
1260                 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1261         }
1262
1263         /* The commans below require a logged-in state */
1264
1265         else if (!strcasecmp(parms[1], "SELECT")) {
1266                 imap_select(num_parms, parms);
1267         }
1268
1269         else if (!strcasecmp(parms[1], "EXAMINE")) {
1270                 imap_select(num_parms, parms);
1271         }
1272
1273         else if (!strcasecmp(parms[1], "LSUB")) {
1274                 imap_lsub(num_parms, parms);
1275         }
1276
1277         else if (!strcasecmp(parms[1], "LIST")) {
1278                 imap_list(num_parms, parms);
1279         }
1280
1281         else if (!strcasecmp(parms[1], "CREATE")) {
1282                 imap_create(num_parms, parms);
1283         }
1284
1285         else if (!strcasecmp(parms[1], "DELETE")) {
1286                 imap_delete(num_parms, parms);
1287         }
1288
1289         else if (!strcasecmp(parms[1], "RENAME")) {
1290                 imap_rename(num_parms, parms);
1291         }
1292
1293         else if (!strcasecmp(parms[1], "STATUS")) {
1294                 imap_status(num_parms, parms);
1295         }
1296
1297         else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1298                 imap_subscribe(num_parms, parms);
1299         }
1300
1301         else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1302                 imap_unsubscribe(num_parms, parms);
1303         }
1304
1305         else if (!strcasecmp(parms[1], "APPEND")) {
1306                 imap_append(num_parms, parms);
1307         }
1308
1309         else if (IMAP->selected == 0) {
1310                 cprintf("%s BAD no folder selected\r\n", parms[0]);
1311         }
1312
1313         /* The commands below require the SELECT state on a mailbox */
1314
1315         else if (!strcasecmp(parms[1], "FETCH")) {
1316                 imap_fetch(num_parms, parms);
1317         }
1318
1319         else if ((!strcasecmp(parms[1], "UID"))
1320                  && (!strcasecmp(parms[2], "FETCH"))) {
1321                 imap_uidfetch(num_parms, parms);
1322         }
1323
1324         else if (!strcasecmp(parms[1], "SEARCH")) {
1325                 imap_search(num_parms, parms);
1326         }
1327
1328         else if ((!strcasecmp(parms[1], "UID"))
1329                  && (!strcasecmp(parms[2], "SEARCH"))) {
1330                 imap_uidsearch(num_parms, parms);
1331         }
1332
1333         else if (!strcasecmp(parms[1], "STORE")) {
1334                 imap_store(num_parms, parms);
1335         }
1336
1337         else if ((!strcasecmp(parms[1], "UID"))
1338                  && (!strcasecmp(parms[2], "STORE"))) {
1339                 imap_uidstore(num_parms, parms);
1340         }
1341
1342         else if (!strcasecmp(parms[1], "COPY")) {
1343                 imap_copy(num_parms, parms);
1344         }
1345
1346         else if ((!strcasecmp(parms[1], "UID"))
1347                  && (!strcasecmp(parms[2], "COPY"))) {
1348                 imap_uidcopy(num_parms, parms);
1349         }
1350
1351         else if (!strcasecmp(parms[1], "EXPUNGE")) {
1352                 imap_expunge(num_parms, parms);
1353         }
1354
1355         else if (!strcasecmp(parms[1], "CLOSE")) {
1356                 imap_close(num_parms, parms);
1357         }
1358
1359         /* End of commands.  If we get here, the command is either invalid
1360          * or unimplemented.
1361          */
1362
1363         else {
1364                 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1365         }
1366
1367         /* If the client transmitted a message we can free it now */
1368         imap_free_transmitted_message();
1369 }
1370
1371
1372
1373 /*
1374  * This function is called to register the IMAP extension with Citadel.
1375  */
1376 char *serv_imap_init(void)
1377 {
1378         CtdlRegisterServiceHook(config.c_imap_port,
1379                                 NULL, imap_greeting, imap_command_loop);
1380         CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1381         return "$Id$";
1382 }