citadel/modules/imap/imap_list.c

   1 /*
   2  * $Id$
   3  *
   4  * Implements the LIST and LSUB commands.
   5  *
   6  * Copyright (C) 2000-2007 by Art Cancro and others.
   7  * This code is released under the terms of the GNU General Public License.
   8  *
   9  */
  10
  11 #include "sysdep.h"
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <stdio.h>
  15 #include <fcntl.h>
  16 #include <signal.h>
  17 #include <pwd.h>
  18 #include <errno.h>
  19 #include <sys/types.h>
  20
  21 #if TIME_WITH_SYS_TIME
  22 # include <sys/time.h>
  23 # include <time.h>
  24 #else
  25 # if HAVE_SYS_TIME_H
  26 #  include <sys/time.h>
  27 # else
  28 #  include <time.h>
  29 # endif
  30 #endif
  31
  32 #include <sys/wait.h>
  33 #include <ctype.h>
  34 #include <string.h>
  35 #include <limits.h>
  36 #include <libcitadel.h>
  37 #include "citadel.h"
  38 #include "server.h"
  39 #include "sysdep_decls.h"
  40 #include "citserver.h"
  41 #include "support.h"
  42 #include "config.h"
  43 #include "room_ops.h"
  44 #include "user_ops.h"
  45 #include "policy.h"
  46 #include "database.h"
  47 #include "msgbase.h"
  48 #include "internet_addressing.h"
  49 #include "serv_imap.h"
  50 #include "imap_tools.h"
  51 #include "imap_fetch.h"
  52 #include "imap_search.h"
  53 #include "imap_store.h"
  54 #include "imap_acl.h"
  55 #include "imap_misc.h"
  56 #include "imap_list.h"
  57 #include "ctdl_module.h"
  58
  59
  60 /*
  61  * Used by LIST and LSUB to show the floors in the listing
  62  */
  63 void imap_list_floors(char *verb, int num_patterns, char **patterns)
  64 {
  65         int i;
  66         struct floor *fl;
  67         int j = 0;
  68         int match = 0;
  69
  70         for (i = 0; i < MAXFLOORS; ++i) {
  71                 fl = cgetfloor(i);
  72                 if (fl->f_flags & F_INUSE) {
  73                         match = 0;
  74                         for (j=0; j<num_patterns; ++j) {
  75                                 if (imap_mailbox_matches_pattern (patterns[j], fl->f_name)) {
  76                                         match = 1;
  77                                 }
  78                         }
  79                         if (match) {
  80                                 cprintf("* %s (\\NoSelect \\HasChildren) \"/\" ", verb);
  81                                 imap_strout(fl->f_name);
  82                                 cprintf("\r\n");
  83                         }
  84                 }
  85         }
  86 }
  87
  88
  89 /*
  90  * Back end for imap_list()
  91  *
  92  * Implementation note: IMAP "subscribed folder" is equivalent to Citadel "known room"
  93  *
  94  * The "user data" field is actually an array of pointers; see below for the breakdown
  95  *
  96  */
  97 void imap_listroom(struct ctdlroom *qrbuf, void *data)
  98 {
  99         char buf[SIZ];
 100         char return_options[256];
 101         int ra;
 102         int yes_output_this_room;
 103
 104         char **data_for_callback;
 105         char *verb;
 106         int subscribed_rooms_only;
 107         int num_patterns;
 108         char **patterns;
 109         int return_subscribed = 0;
 110         int return_children = 0;
 111         int i = 0;
 112         int match = 0;
 113
 114         /* Here's how we break down the array of pointers passed to us */
 115         data_for_callback = data;
 116         verb = data_for_callback[0];
 117         subscribed_rooms_only = (int) data_for_callback[1];
 118         num_patterns = (int) data_for_callback[2];
 119         patterns = (char **) data_for_callback[3];
 120         return_subscribed = (int) data_for_callback[4];
 121         return_children = (int) data_for_callback[5];
 122
 123         /* Only list rooms to which the user has access!! */
 124         yes_output_this_room = 0;
 125         strcpy(return_options, "");
 126         CtdlRoomAccess(qrbuf, &CC->user, &ra, NULL);
 127
 128         if (return_subscribed) {
 129                 if (ra & UA_KNOWN) {
 130                         strcat(return_options, "\\Subscribed");
 131                 }
 132         }
 133
 134         /* Warning: ugly hack.
 135          * We don't have any way to determine the presence of child mailboxes
 136          * without refactoring this entire module.  So we're just going to return
 137          * the \HasChildren attribute for every room.
 138          * We'll fix this later when we have time.
 139          */
 140         if (return_children) {
 141                 if (!IsEmptyStr(return_options)) {
 142                         strcat(return_options, " ");
 143                 }
 144                 strcat(return_options, "\\HasChildren");
 145         }
 146
 147         if (subscribed_rooms_only) {
 148                 if (ra & UA_KNOWN) {
 149                         yes_output_this_room = 1;
 150                 }
 151         }
 152         else {
 153                 if ((ra & UA_KNOWN) || ((ra & UA_GOTOALLOWED) && (ra & UA_ZAPPED))) {
 154                         yes_output_this_room = 1;
 155                 }
 156         }
 157
 158         if (yes_output_this_room) {
 159                 imap_mailboxname(buf, sizeof buf, qrbuf);
 160                 match = 0;
 161                 for (i=0; i<num_patterns; ++i) {
 162                         if (imap_mailbox_matches_pattern(patterns[i], buf)) {
 163                                 match = 1;
 164                         }
 165                 }
 166                 if (match) {
 167                         cprintf("* %s (%s) \"/\" ", verb, return_options);
 168                         imap_strout(buf);
 169                         cprintf("\r\n");
 170                 }
 171         }
 172 }
 173
 174
 175 /*
 176  * Implements the LIST and LSUB commands
 177  */
 178 void imap_list(int num_parms, char *parms[])
 179 {
 180         int subscribed_rooms_only = 0;
 181         char verb[16];
 182         int i, j, paren_nest;
 183         char *data_for_callback[6];
 184         int num_patterns = 1;
 185         char *patterns[MAX_PATTERNS];
 186         int selection_left = (-1);
 187         int selection_right = (-1);
 188         int return_left = (-1);
 189         int return_right = (-1);
 190         int root_pos = 2;
 191         int patterns_left = 3;
 192         int patterns_right = 3;
 193         int extended_list_in_use = 0;
 194         int return_subscribed = 0;
 195         int return_children = 0;
 196
 197         if (num_parms < 4) {
 198                 cprintf("%s BAD arguments invalid\r\n", parms[0]);
 199                 return;
 200         }
 201
 202         /* parms[1] is the IMAP verb being used (e.g. LIST or LSUB)
 203          * This tells us how to behave, and what verb to return back to the caller
 204          */
 205         safestrncpy(verb, parms[1], sizeof verb);
 206         j = strlen(verb);
 207         for (i=0; i<j; ++i) {
 208                 verb[i] = toupper(verb[i]);
 209         }
 210
 211         if (!strcasecmp(verb, "LSUB")) {
 212                 subscribed_rooms_only = 1;
 213         }
 214
 215         /*
 216          * Partial implementation of LIST-EXTENDED (which will not get used because
 217          * we don't advertise it in our capabilities string).  Several requirements:
 218          *
 219          * Extraction of selection options:
 220          *      SUBSCRIBED option: done
 221          *      RECURSIVEMATCH option: not done yet
 222          *      REMOTE: safe to silently ignore
 223          *
 224          * Extraction of return options:
 225          *      SUBSCRIBED option: done
 226          *      CHILDREN option: done, but needs a non-ugly rewrite
 227          *
 228          * Multiple match patterns: done
 229          */
 230
 231         /*
 232          * If parameter 2 begins with a '(' character, the client is specifying
 233          * selection options.  Extract their exact position, and then modify our
 234          * expectation of where the root folder will be specified.
 235          */
 236         if (parms[2][0] == '(') {
 237                 extended_list_in_use = 1;
 238                 selection_left = 2;
 239                 paren_nest = 0;
 240                 for (i=2; i<num_parms; ++i) {
 241                         for (j=0; parms[i][j]; ++j) {
 242                                 if (parms[i][j] == '(') ++paren_nest;
 243                                 if (parms[i][j] == ')') --paren_nest;
 244                         }
 245                         if (paren_nest == 0) {
 246                                 selection_right = i;    /* found end of selection options */
 247                                 root_pos = i+1;         /* folder root appears after selection options */
 248                                 i = num_parms + 1;      /* break out of the loop */
 249                         }
 250                 }
 251         }
 252
 253         /* If selection options were found, do something with them.
 254          */
 255         if ((selection_left > 0) && (selection_right >= selection_left)) {
 256
 257                 /* Strip off the outer parentheses */
 258                 if (parms[selection_left][0] == '(') {
 259                         strcpy(parms[selection_left], &parms[selection_left][1]);
 260                 }
 261                 if (parms[selection_right][strlen(parms[selection_right])-1] == ')') {
 262                         parms[selection_right][strlen(parms[selection_right])-1] = 0;
 263                 }
 264
 265                 for (i=selection_left; i<=selection_right; ++i) {
 266
 267                         if (!strcasecmp(parms[i], "SUBSCRIBED")) {
 268                                 subscribed_rooms_only = 1;
 269                         }
 270
 271                         else if (!strcasecmp(parms[i], "RECURSIVEMATCH")) {
 272                                 /* FIXME - do this! */
 273                         }
 274
 275                 }
 276
 277         }
 278
 279         /* The folder root appears immediately after the selection options,
 280          * or in position 2 if no selection options were specified.
 281          */
 282         patterns_left = root_pos + 1;
 283         patterns_right = root_pos + 1;
 284
 285         if (parms[patterns_left][0] == '(') {
 286                 extended_list_in_use = 1;
 287                 paren_nest = 0;
 288                 for (i=patterns_left; i<num_parms; ++i) {
 289                         for (j=0; &parms[i][j]; ++j) {
 290                                 if (parms[i][j] == '(') ++paren_nest;
 291                                 if (parms[i][j] == ')') --paren_nest;
 292                         }
 293                         if (paren_nest == 0) {
 294                                 patterns_right = i;     /* found end of patterns */
 295                                 i = num_parms + 1;      /* break out of the loop */
 296                         }
 297                 }
 298                 num_patterns = patterns_right - patterns_left + 1;
 299                 for (i=0; i<num_patterns; ++i) {
 300                         if (i < MAX_PATTERNS) {
 301                                 patterns[i] = malloc(512);
 302                                 snprintf(patterns[i], 512, "%s%s", parms[root_pos], parms[patterns_left+i]);
 303                                 if (i == 0) {
 304                                         strcpy(patterns[i], &patterns[i][1]);
 305                                 }
 306                                 if (i == num_patterns-1) {
 307                                         patterns[i][strlen(patterns[i])-1] = 0;
 308                                 }
 309                         }
 310                 }
 311         }
 312         else {
 313                 num_patterns = 1;
 314                 patterns[0] = malloc(512);
 315                 snprintf(patterns[0], 512, "%s%s", parms[root_pos], parms[patterns_left]);
 316         }
 317
 318         /* If the word "RETURN" appears after the folder pattern list, then the client
 319          * is specifying return options.
 320          */
 321         if (num_parms - patterns_right > 2) if (!strcasecmp(parms[patterns_right+1], "RETURN")) {
 322                 return_left = patterns_right + 2;
 323                 extended_list_in_use = 1;
 324                 paren_nest = 0;
 325                 for (i=return_left; i<num_parms; ++i) {
 326                         for (j=0; parms[i][j]; ++j) {
 327                                 if (parms[i][j] == '(') ++paren_nest;
 328                                 if (parms[i][j] == ')') --paren_nest;
 329                         }
 330
 331                         /* Might as well look for these while we're in here... */
 332                         if (parms[i][0] == '(') strcpy(parms[i], &parms[i][1]);
 333                         if (parms[i][strlen(parms[i])-1] == ')') parms[i][strlen(parms[i])-1] = 0;
 334                         CtdlLogPrintf(9, "evaluating <%s>\n", parms[i]);
 335
 336                         if (!strcasecmp(parms[i], "SUBSCRIBED")) {
 337                                 return_subscribed = 1;
 338                         }
 339
 340                         else if (!strcasecmp(parms[i], "CHILDREN")) {
 341                                 return_children = 1;
 342                         }
 343
 344                         if (paren_nest == 0) {
 345                                 return_right = i;       /* found end of patterns */
 346                                 i = num_parms + 1;      /* break out of the loop */
 347                         }
 348                 }
 349         }
 350
 351         /* Now start setting up the data we're going to send to the ForEachRoom() callback.
 352          */
 353         data_for_callback[0] = (char *) verb;
 354         data_for_callback[1] = (char *) subscribed_rooms_only;
 355         data_for_callback[2] = (char *) num_patterns;
 356         data_for_callback[3] = (char *) patterns;
 357         data_for_callback[4] = (char *) return_subscribed;
 358         data_for_callback[5] = (char *) return_children;
 359
 360         /* The non-extended LIST command is required to treat an empty
 361          * ("" string) mailbox name argument as a special request to return the
 362          * hierarchy delimiter and the root name of the name given in the
 363          * reference parameter.
 364          */
 365         if ( (IsEmptyStr(patterns[0])) && (extended_list_in_use == 0) ) {
 366                 cprintf("* %s (\\Noselect) \"/\" \"\"\r\n", verb);
 367         }
 368
 369         /* Non-empty mailbox names, and any form of the extended LIST command,
 370          * is handled by this loop.
 371          */
 372         else {
 373                 imap_list_floors(verb, num_patterns, patterns);
 374                 ForEachRoom(imap_listroom, data_for_callback);
 375         }
 376
 377         /*
 378          * Free the pattern buffers we allocated above.
 379          */
 380         for (i=0; i<num_patterns; ++i) {
 381                 free(patterns[i]);
 382         }
 383
 384         cprintf("%s OK %s completed\r\n", parms[0], verb);
 385 }