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