citadel/serv_imap.c

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