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                 }
 491         }
 492
 493         if (num_expunged > 0) {
 494                 imap_rescan_msgids();
 495         }
 496
 497         return(num_expunged);
 498 }
 499
 500
 501 /*
 502  * implements the EXPUNGE command syntax
 503  */
 504 void imap_expunge(int num_parms, char *parms[]) {
 505         int num_expunged = 0;
 506
 507         num_expunged = imap_do_expunge();
 508         cprintf("%s OK expunged %d messages.\r\n", parms[0], num_expunged);
 509 }
 510
 511
 512 /*
 513  * implements the CLOSE command
 514  */
 515 void imap_close(int num_parms, char *parms[]) {
 516
 517         /* Yes, we always expunge on close. */
 518         imap_do_expunge();
 519
 520         IMAP->selected = 0;
 521         IMAP->readonly = 0;
 522         imap_free_msgids();
 523         cprintf("%s OK CLOSE completed\r\n", parms[0]);
 524 }
 525
 526
 527
 528
 529 /*
 530  * Used by LIST and LSUB to show the floors in the listing
 531  */
 532 void imap_list_floors(char *cmd, char *pattern) {
 533         int i;
 534         struct floor *fl;
 535
 536         for (i=0; i<MAXFLOORS; ++i) {
 537                 fl = cgetfloor(i);
 538                 if (fl->f_flags & F_INUSE) {
 539                         if (imap_mailbox_matches_pattern(pattern, fl->f_name)) {
 540                                 cprintf("* %s (\\NoSelect) \"|\" ", cmd);
 541                                 imap_strout(fl->f_name);
 542                                 cprintf("\r\n");
 543                         }
 544                 }
 545         }
 546 }
 547
 548
 549
 550 /*
 551  * Back end for imap_lsub()
 552  *
 553  * IMAP "subscribed folder" is equivocated to Citadel "known rooms."  This
 554  * may or may not be the desired behavior in the future.
 555  */
 556 void imap_lsub_listroom(struct quickroom *qrbuf, void *data) {
 557         char buf[SIZ];
 558         int ra;
 559         char *pattern;
 560
 561         pattern = (char *)data;
 562
 563         /* Only list rooms to which the user has access!! */
 564         ra = CtdlRoomAccess(qrbuf, &CC->usersupp);
 565         if (ra & UA_KNOWN) {
 566                 imap_mailboxname(buf, sizeof buf, qrbuf);
 567                 if (imap_mailbox_matches_pattern(pattern, buf)) {
 568                         cprintf("* LSUB () \"|\" ");
 569                         imap_strout(buf);
 570                         cprintf("\r\n");
 571                 }
 572         }
 573 }
 574
 575
 576 /*
 577  * Implements the LSUB command
 578  */
 579 void imap_lsub(int num_parms, char *parms[]) {
 580         char pattern[SIZ];
 581         if (num_parms < 4) {
 582                 cprintf("%s BAD arguments invalid\r\n", parms[0]);
 583                 return;
 584         }
 585         snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
 586
 587         if (strlen(parms[3])==0) {
 588                 cprintf("* LIST (\\Noselect) \"|\" \"\"\r\n");
 589         }
 590
 591         else {
 592                 imap_list_floors("LSUB", pattern);
 593                 ForEachRoom(imap_lsub_listroom, pattern);
 594         }
 595
 596         cprintf("%s OK LSUB completed\r\n", parms[0]);
 597 }
 598
 599
 600
 601 /*
 602  * Back end for imap_list()
 603  */
 604 void imap_list_listroom(struct quickroom *qrbuf, void *data) {
 605         char buf[SIZ];
 606         int ra;
 607         char *pattern;
 608
 609         pattern = (char *)data;
 610
 611         /* Only list rooms to which the user has access!! */
 612         ra = CtdlRoomAccess(qrbuf, &CC->usersupp);
 613         if ( (ra & UA_KNOWN)
 614           || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
 615                 imap_mailboxname(buf, sizeof buf, qrbuf);
 616                 if (imap_mailbox_matches_pattern(pattern, buf)) {
 617                         cprintf("* LIST () \"|\" ");
 618                         imap_strout(buf);
 619                         cprintf("\r\n");
 620                 }
 621         }
 622 }
 623
 624
 625 /*
 626  * Implements the LIST command
 627  */
 628 void imap_list(int num_parms, char *parms[]) {
 629         char pattern[SIZ];
 630         if (num_parms < 4) {
 631                 cprintf("%s BAD arguments invalid\r\n", parms[0]);
 632                 return;
 633         }
 634         snprintf(pattern, sizeof pattern, "%s%s", parms[2], parms[3]);
 635
 636         if (strlen(parms[3])==0) {
 637                 cprintf("* LIST (\\Noselect) \"|\" \"\"\r\n");
 638         }
 639
 640         else {
 641                 imap_list_floors("LIST", pattern);
 642                 ForEachRoom(imap_list_listroom, pattern);
 643         }
 644
 645         cprintf("%s OK LIST completed\r\n", parms[0]);
 646 }
 647
 648
 649
 650 /*
 651  * Implements the CREATE command
 652  *
 653  */
 654 void imap_create(int num_parms, char *parms[]) {
 655         int ret;
 656         char roomname[ROOMNAMELEN];
 657         int floornum;
 658         int flags;
 659         int newroomtype;
 660
 661         ret = imap_roomname(roomname, sizeof roomname, parms[2]);
 662         if (ret < 0) {
 663                 cprintf("%s NO Invalid mailbox name or location\r\n",
 664                         parms[0]);
 665                 return;
 666         }
 667         floornum = ( ret & 0x00ff );    /* lower 8 bits = floor number */
 668         flags =    ( ret & 0xff00 );    /* upper 8 bits = flags        */
 669
 670         if (flags & IR_MAILBOX) {
 671                 newroomtype = 4;        /* private mailbox */
 672         }
 673         else {
 674                 newroomtype = 0;        /* public folder */
 675         }
 676
 677         lprintf(7, "Create new room <%s> on floor <%d> with type <%d>\n",
 678                 roomname, floornum, newroomtype);
 679
 680         ret = create_room(roomname, newroomtype, "", floornum, 1, 0);
 681         if (ret == 0) {
 682                 cprintf("%s NO Mailbox already exists, or create failed\r\n",
 683                         parms[0]);
 684         }
 685         else {
 686                 cprintf("%s OK CREATE completed\r\n", parms[0]);
 687         }
 688 }
 689
 690
 691 /*
 692  * Locate a room by its IMAP folder name, and check access to it
 693  */
 694 int imap_grabroom(char *returned_roomname, char *foldername) {
 695         int ret;
 696         char augmented_roomname[ROOMNAMELEN];
 697         char roomname[ROOMNAMELEN];
 698         int c;
 699         struct quickroom QRscratch;
 700         int ra;
 701         int ok = 0;
 702
 703         ret = imap_roomname(roomname, sizeof roomname, foldername);
 704         if (ret < 0) {
 705                 return(1);
 706         }
 707
 708         /* First try a regular match */
 709         c = getroom(&QRscratch, roomname);
 710
 711         /* Then try a mailbox name match */
 712         if (c != 0) {
 713                 MailboxName(augmented_roomname, sizeof augmented_roomname,
 714                             &CC->usersupp, roomname);
 715                 c = getroom(&QRscratch, augmented_roomname);
 716                 if (c == 0)
 717                         strcpy(roomname, augmented_roomname);
 718         }
 719
 720         /* If the room exists, check security/access */
 721         if (c == 0) {
 722                 /* See if there is an existing user/room relationship */
 723                 ra = CtdlRoomAccess(&QRscratch, &CC->usersupp);
 724
 725                 /* normal clients have to pass through security */
 726                 if (ra & UA_KNOWN) {
 727                         ok = 1;
 728                 }
 729         }
 730
 731         /* Fail here if no such room */
 732         if (!ok) {
 733                 strcpy(returned_roomname, "");
 734                 return(2);
 735         }
 736         else {
 737                 strcpy(returned_roomname, QRscratch.QRname);
 738                 return(0);
 739         }
 740 }
 741
 742
 743 /*
 744  * Implements the STATUS command (sort of)
 745  *
 746  */
 747 void imap_status(int num_parms, char *parms[]) {
 748         int ret;
 749         char roomname[ROOMNAMELEN];
 750         char buf[SIZ];
 751         char savedroom[ROOMNAMELEN];
 752         int msgs, new;
 753
 754         ret = imap_grabroom(roomname, parms[2]);
 755         if (ret != 0) {
 756                 cprintf("%s NO Invalid mailbox name or location, or access denied\r\n",
 757                         parms[0]);
 758                 return;
 759         }
 760
 761         /*
 762          * usergoto() formally takes us to the desired room, happily returning
 763          * the number of messages and number of new messages.  (If another
 764          * folder is selected, save its name so we can return there!!!!!)
 765          */
 766         if (IMAP->selected) {
 767                 strcpy(savedroom, CC->quickroom.QRname);
 768         }
 769         usergoto(roomname, 0, 0, &msgs, &new);
 770
 771         /*
 772          * Tell the client what it wants to know.  In fact, tell it *more* than
 773          * it wants to know.  We happily IGnore the supplied status data item
 774          * names and simply spew all possible data items.  It's far easier to
 775          * code and probably saves us some processing time too.
 776          */
 777         imap_mailboxname(buf, sizeof buf, &CC->quickroom);
 778         cprintf("* STATUS ");
 779         imap_strout(buf);
 780         cprintf(" (MESSAGES %d ", msgs);
 781         cprintf("RECENT 0 ");   /* FIXME we need to implement this */
 782         cprintf("UIDNEXT %ld ", CitControl.MMhighest + 1);
 783         cprintf("UNSEEN %d)\r\n", new);
 784
 785         /*
 786          * If another folder is selected, go back to that room so we can resume
 787          * our happy day without violent explosions.
 788          */
 789         if (IMAP->selected) {
 790                 usergoto(savedroom, 0, 0, &msgs, &new);
 791         }
 792
 793         /*
 794          * Oooh, look, we're done!
 795          */
 796         cprintf("%s OK STATUS completed\r\n", parms[0]);
 797 }
 798
 799
 800
 801 /*
 802  * Implements the SUBSCRIBE command
 803  *
 804  */
 805 void imap_subscribe(int num_parms, char *parms[]) {
 806         int ret;
 807         char roomname[ROOMNAMELEN];
 808         char savedroom[ROOMNAMELEN];
 809         int msgs, new;
 810
 811         ret = imap_grabroom(roomname, parms[2]);
 812         if (ret != 0) {
 813                 cprintf("%s NO Invalid mailbox name or location, or access denied\r\n",
 814                         parms[0]);
 815                 return;
 816         }
 817
 818         /*
 819          * usergoto() formally takes us to the desired room, which has the side
 820          * effect of marking the room as not-zapped ... exactly the effect
 821          * we're looking for.
 822          */
 823         if (IMAP->selected) {
 824                 strcpy(savedroom, CC->quickroom.QRname);
 825         }
 826         usergoto(roomname, 0, 0, &msgs, &new);
 827
 828         /*
 829          * If another folder is selected, go back to that room so we can resume
 830          * our happy day without violent explosions.
 831          */
 832         if (IMAP->selected) {
 833                 usergoto(savedroom, 0, 0, &msgs, &new);
 834         }
 835
 836         cprintf("%s OK SUBSCRIBE completed\r\n", parms[0]);
 837 }
 838
 839
 840 /*
 841  * Implements the UNSUBSCRIBE command
 842  *
 843  */
 844 void imap_unsubscribe(int num_parms, char *parms[]) {
 845         int ret;
 846         char roomname[ROOMNAMELEN];
 847         char savedroom[ROOMNAMELEN];
 848         int msgs, new;
 849
 850         ret = imap_grabroom(roomname, parms[2]);
 851         if (ret != 0) {
 852                 cprintf("%s NO Invalid mailbox name or location, or access denied\r\n",
 853                         parms[0]);
 854                 return;
 855         }
 856
 857         /*
 858          * usergoto() formally takes us to the desired room.
 859          */
 860         if (IMAP->selected) {
 861                 strcpy(savedroom, CC->quickroom.QRname);
 862         }
 863         usergoto(roomname, 0, 0, &msgs, &new);
 864
 865         /*
 866          * Now make the API call to zap the room
 867          */
 868         if (CtdlForgetThisRoom() == 0) {
 869                 cprintf("%s OK UNSUBSCRIBE completed\r\n", parms[0]);
 870         }
 871         else {
 872                 cprintf("%s NO You may not unsubscribe from this folder.\r\n",
 873                         parms[0]);
 874         }
 875
 876         /*
 877          * If another folder is selected, go back to that room so we can resume
 878          * our happy day without violent explosions.
 879          */
 880         if (IMAP->selected) {
 881                 usergoto(savedroom, 0, 0, &msgs, &new);
 882         }
 883 }
 884
 885
 886
 887 /*
 888  * Implements the DELETE command
 889  *
 890  */
 891 void imap_delete(int num_parms, char *parms[]) {
 892         int ret;
 893         char roomname[ROOMNAMELEN];
 894         char savedroom[ROOMNAMELEN];
 895         int msgs, new;
 896
 897         ret = imap_grabroom(roomname, parms[2]);
 898         if (ret != 0) {
 899                 cprintf("%s NO Invalid mailbox name, or access denied\r\n",
 900                         parms[0]);
 901                 return;
 902         }
 903
 904         /*
 905          * usergoto() formally takes us to the desired room, happily returning
 906          * the number of messages and number of new messages.  (If another
 907          * folder is selected, save its name so we can return there!!!!!)
 908          */
 909         if (IMAP->selected) {
 910                 strcpy(savedroom, CC->quickroom.QRname);
 911         }
 912         usergoto(roomname, 0, 0, &msgs, &new);
 913
 914         /*
 915          * Now delete the room.
 916          */
 917         if (CtdlDoIHavePermissionToDeleteThisRoom(&CC->quickroom)) {
 918                 cprintf("%s OK DELETE completed\r\n", parms[0]);
 919                 delete_room(&CC->quickroom);
 920         }
 921         else {
 922                 cprintf("%s NO Can't delete this folder.\r\n", parms[0]);
 923         }
 924
 925         /*
 926          * If another folder is selected, go back to that room so we can resume
 927          * our happy day without violent explosions.
 928          */
 929         if (IMAP->selected) {
 930                 usergoto(savedroom, 0, 0, &msgs, &new);
 931         }
 932 }
 933
 934
 935 /*
 936  * Back end function for imap_rename()
 937  */
 938 void imap_rename_backend(struct quickroom *qrbuf, void *data) {
 939         char foldername[SIZ];
 940         char newfoldername[SIZ];
 941         char newroomname[ROOMNAMELEN];
 942         int newfloor = 0;
 943         struct irl *irlp = NULL;        /* scratch pointer */
 944         struct irlparms *irlparms;
 945
 946         irlparms = (struct irlparms *)data;
 947         imap_mailboxname(foldername, sizeof foldername, qrbuf);
 948
 949         /* Rename subfolders */
 950         if ( (!strncasecmp(foldername, irlparms->oldname,
 951            strlen(irlparms->oldname))
 952            && (foldername[strlen(irlparms->oldname)] == '|')) ) {
 953
 954                 sprintf(newfoldername, "%s|%s",
 955                         irlparms->newname,
 956                         &foldername[strlen(irlparms->oldname)+1]
 957                 );
 958
 959                 newfloor = imap_roomname(newroomname,
 960                         sizeof newroomname, newfoldername) & 0xFF;
 961
 962                 irlp = (struct irl *) mallok(sizeof(struct irl));
 963                 strcpy(irlp->irl_newroom, newroomname);
 964                 strcpy(irlp->irl_oldroom, qrbuf->QRname);
 965                 irlp->irl_newfloor = newfloor;
 966                 irlp->next = *(irlparms->irl);
 967                 *(irlparms->irl) = irlp;
 968         }
 969 }
 970
 971
 972 /*
 973  * Implements the RENAME command
 974  *
 975  */
 976 void imap_rename(int num_parms, char *parms[]) {
 977         char old_room[ROOMNAMELEN];
 978         char new_room[ROOMNAMELEN];
 979         int oldr, newr;
 980         int new_floor;
 981         int r;
 982         struct irl *irl = NULL;         /* the list */
 983         struct irl *irlp = NULL;        /* scratch pointer */
 984         struct irlparms irlparms;
 985
 986         oldr = imap_roomname(old_room, sizeof old_room, parms[2]);
 987         newr = imap_roomname(new_room, sizeof new_room, parms[3]);
 988         new_floor = (newr & 0xFF);
 989
 990         r = CtdlRenameRoom(old_room, new_room, new_floor);
 991
 992         if (r == crr_room_not_found) {
 993                 cprintf("%s NO Could not locate this folder\r\n", parms[0]);
 994                 return;
 995         }
 996         if (r == crr_already_exists) {
 997                 cprintf("%s '%s' already exists.\r\n", parms[0], parms[2]);
 998                 return;
 999         }
1000         if (r == crr_noneditable) {
1001                 cprintf("%s This folder is not editable.\r\n", parms[0]);
1002                 return;
1003         }
1004         if (r == crr_invalid_floor) {
1005                 cprintf("%s Folder root does not exist.\r\n", parms[0]);
1006                 return;
1007         }
1008         if (r == crr_access_denied) {
1009                 cprintf("%s You do not have permission to edit "
1010                         "this folder.\r\n", parms[0]);
1011                 return;
1012         }
1013         if (r != crr_ok) {
1014                 cprintf("%s NO Rename failed - undefined error %d\r\n",
1015                         parms[0], r);
1016                 return;
1017         }
1018
1019
1020         /* If this is the INBOX, then RFC2060 says we have to just move the
1021          * contents.  In a Citadel environment it's easier to rename the room
1022          * (already did that) and create a new inbox.
1023          */
1024         if (!strcasecmp(parms[2], "INBOX")) {
1025                 create_room(MAILROOM, 4, "", 0, 1, 0);
1026         }
1027
1028         /* Otherwise, do the subfolders.  Build a list of rooms to rename... */
1029         else {
1030                 irlparms.oldname = parms[2];
1031                 irlparms.newname = parms[3];
1032                 irlparms.irl = &irl;
1033                 ForEachRoom(imap_rename_backend, (void *)&irlparms);
1034
1035                 /* ... and now rename them. */
1036                 while (irl != NULL) {
1037                         r = CtdlRenameRoom(irl->irl_oldroom,
1038                                 irl->irl_newroom, irl->irl_newfloor);
1039                         if (r != crr_ok) {
1040                                 /* FIXME handle error returns better */
1041                                 lprintf(5, "CtdlRenameRoom() error %d\n", r);
1042                         }
1043                         irlp = irl;
1044                         irl = irl->next;
1045                         phree(irlp);
1046                 }
1047         }
1048
1049         cprintf("%s OK RENAME completed\r\n", parms[0]);
1050 }
1051
1052
1053
1054
1055 /*
1056  * Main command loop for IMAP sessions.
1057  */
1058 void imap_command_loop(void) {
1059         char cmdbuf[SIZ];
1060         char *parms[SIZ];
1061         int num_parms;
1062
1063         time(&CC->lastcmd);
1064         memset(cmdbuf, 0, sizeof cmdbuf); /* Clear it, just in case */
1065         if (client_gets(cmdbuf) < 1) {
1066                 lprintf(3, "IMAP socket is broken.  Ending session.\r\n");
1067                 CC->kill_me = 1;
1068                 return;
1069         }
1070
1071         lprintf(5, "IMAP: %s\r\n", cmdbuf);
1072         while (strlen(cmdbuf) < 5) strcat(cmdbuf, " ");
1073
1074
1075         /* strip off l/t whitespace and CRLF */
1076         if (cmdbuf[strlen(cmdbuf)-1]=='\n') cmdbuf[strlen(cmdbuf)-1]=0;
1077         if (cmdbuf[strlen(cmdbuf)-1]=='\r') cmdbuf[strlen(cmdbuf)-1]=0;
1078         striplt(cmdbuf);
1079
1080         /* If we're in the middle of a multi-line command, handle that */
1081         if (IMAP->authstate == imap_as_expecting_username) {
1082                 imap_auth_login_user(cmdbuf);
1083                 return;
1084         }
1085         if (IMAP->authstate == imap_as_expecting_password) {
1086                 imap_auth_login_pass(cmdbuf);
1087                 return;
1088         }
1089
1090
1091         /* Ok, at this point we're in normal command mode.  The first thing
1092          * we do is print any incoming pages (yeah! we really do!)
1093          */
1094         imap_print_express_messages();
1095
1096         /*
1097          * Before processing the command that was just entered... if we happen
1098          * to have a folder selected, we'd like to rescan that folder for new
1099          * messages, and for deletions/changes of existing messages.  This
1100          * could probably be optimized somehow, but IMAP sucks...
1101          */
1102         if (IMAP->selected) {
1103                 imap_rescan_msgids();
1104         }
1105
1106         /* Now for the command set. */
1107
1108         /* Grab the tag, command, and parameters.  Check syntax. */
1109         num_parms = imap_parameterize(parms, cmdbuf);
1110         if (num_parms < 2) {
1111                 cprintf("BAD syntax error\r\n");
1112         }
1113
1114         /* The commands below may be executed in any state */
1115
1116         else if ( (!strcasecmp(parms[1], "NOOP"))
1117            || (!strcasecmp(parms[1], "CHECK")) ) {
1118                 cprintf("%s OK This command successfully did nothing.\r\n",
1119                         parms[0]);
1120         }
1121
1122         else if (!strcasecmp(parms[1], "LOGOUT")) {
1123                 cprintf("* BYE %s logging out\r\n", config.c_fqdn);
1124                 cprintf("%s OK thank you for using Citadel IMAP\r\n", parms[0]);
1125                 CC->kill_me = 1;
1126                 return;
1127         }
1128
1129         else if (!strcasecmp(parms[1], "LOGIN")) {
1130                 imap_login(num_parms, parms);
1131         }
1132
1133         else if (!strcasecmp(parms[1], "AUTHENTICATE")) {
1134                 imap_authenticate(num_parms, parms);
1135         }
1136
1137         else if (!strcasecmp(parms[1], "CAPABILITY")) {
1138                 imap_capability(num_parms, parms);
1139         }
1140
1141         else if (!CC->logged_in) {
1142                 cprintf("%s BAD Not logged in.\r\n", parms[0]);
1143         }
1144
1145         /* The commans below require a logged-in state */
1146
1147         else if (!strcasecmp(parms[1], "SELECT")) {
1148                 imap_select(num_parms, parms);
1149         }
1150
1151         else if (!strcasecmp(parms[1], "EXAMINE")) {
1152                 imap_select(num_parms, parms);
1153         }
1154
1155         else if (!strcasecmp(parms[1], "LSUB")) {
1156                 imap_lsub(num_parms, parms);
1157         }
1158
1159         else if (!strcasecmp(parms[1], "LIST")) {
1160                 imap_list(num_parms, parms);
1161         }
1162
1163         else if (!strcasecmp(parms[1], "CREATE")) {
1164                 imap_create(num_parms, parms);
1165         }
1166
1167         else if (!strcasecmp(parms[1], "DELETE")) {
1168                 imap_delete(num_parms, parms);
1169         }
1170
1171         else if (!strcasecmp(parms[1], "RENAME")) {
1172                 imap_rename(num_parms, parms);
1173         }
1174
1175         else if (!strcasecmp(parms[1], "STATUS")) {
1176                 imap_status(num_parms, parms);
1177         }
1178
1179         else if (!strcasecmp(parms[1], "SUBSCRIBE")) {
1180                 imap_subscribe(num_parms, parms);
1181         }
1182
1183         else if (!strcasecmp(parms[1], "UNSUBSCRIBE")) {
1184                 imap_unsubscribe(num_parms, parms);
1185         }
1186
1187         else if (!strcasecmp(parms[1], "APPEND")) {
1188                 imap_append(num_parms, parms);
1189         }
1190
1191         else if (IMAP->selected == 0) {
1192                 cprintf("%s BAD no folder selected\r\n", parms[0]);
1193         }
1194
1195         /* The commands below require the SELECT state on a mailbox */
1196
1197         else if (!strcasecmp(parms[1], "FETCH")) {
1198                 imap_fetch(num_parms, parms);
1199         }
1200
1201         else if ( (!strcasecmp(parms[1], "UID"))
1202                 && (!strcasecmp(parms[2], "FETCH")) ) {
1203                 imap_uidfetch(num_parms, parms);
1204         }
1205
1206         else if (!strcasecmp(parms[1], "SEARCH")) {
1207                 imap_search(num_parms, parms);
1208         }
1209
1210         else if ( (!strcasecmp(parms[1], "UID"))
1211                 && (!strcasecmp(parms[2], "SEARCH")) ) {
1212                 imap_uidsearch(num_parms, parms);
1213         }
1214
1215         else if (!strcasecmp(parms[1], "STORE")) {
1216                 imap_store(num_parms, parms);
1217         }
1218
1219         else if ( (!strcasecmp(parms[1], "UID"))
1220                 && (!strcasecmp(parms[2], "STORE")) ) {
1221                 imap_uidstore(num_parms, parms);
1222         }
1223
1224         else if (!strcasecmp(parms[1], "COPY")) {
1225                 imap_copy(num_parms, parms);
1226         }
1227
1228         else if ( (!strcasecmp(parms[1], "UID"))
1229                 && (!strcasecmp(parms[2], "COPY")) ) {
1230                 imap_uidcopy(num_parms, parms);
1231         }
1232
1233         else if (!strcasecmp(parms[1], "EXPUNGE")) {
1234                 imap_expunge(num_parms, parms);
1235         }
1236
1237         else if (!strcasecmp(parms[1], "CLOSE")) {
1238                 imap_close(num_parms, parms);
1239         }
1240
1241         /* End of commands.  If we get here, the command is either invalid
1242          * or unimplemented.
1243          */
1244
1245         else {
1246                 cprintf("%s BAD command unrecognized\r\n", parms[0]);
1247         }
1248
1249         /* If the client transmitted a message we can free it now */
1250         imap_free_transmitted_message();
1251 }
1252
1253
1254
1255 /*
1256  * This function is called to register the IMAP extension with Citadel.
1257  */
1258 char *serv_imap_init(void)
1259 {
1260         SYM_IMAP = CtdlGetDynamicSymbol();
1261         CtdlRegisterServiceHook(config.c_imap_port,
1262                                 NULL,
1263                                 imap_greeting,
1264                                 imap_command_loop);
1265         CtdlRegisterSessionHook(imap_cleanup_function, EVT_STOP);
1266         return "$Id$";
1267 }