citadel/server/modules/nntp/serv_nntp.c

   1 // NNTP server module (RFC 3977)
   2 //
   3 // Copyright (c) 2014-2023 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // are subject to the terms of the GNU General Public License version 3.
   7
   8 #include "../../sysdep.h"
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <stdio.h>
  12 #include <termios.h>
  13 #include <fcntl.h>
  14 #include <signal.h>
  15 #include <pwd.h>
  16 #include <errno.h>
  17 #include <sys/types.h>
  18 #include <syslog.h>
  19 #include <time.h>
  20 #include <sys/wait.h>
  21 #include <ctype.h>
  22 #include <string.h>
  23 #include <limits.h>
  24 #include <sys/socket.h>
  25 #include <netinet/in.h>
  26 #include <arpa/inet.h>
  27 #include <libcitadel.h>
  28 #include "../../citadel_defs.h"
  29 #include "../../server.h"
  30 #include "../../citserver.h"
  31 #include "../../support.h"
  32 #include "../../config.h"
  33 #include "../../control.h"
  34 #include "../../user_ops.h"
  35 #include "../../room_ops.h"
  36 #include "../../database.h"
  37 #include "../../msgbase.h"
  38 #include "../../internet_addressing.h"
  39 #include "../../genstamp.h"
  40 #include "../../domain.h"
  41 #include "../../clientsocket.h"
  42 #include "../../locate_host.h"
  43 #include "../../citadel_dirs.h"
  44 #include "../../ctdl_module.h"
  45 #include "serv_nntp.h"
  46
  47 #ifndef __FreeBSD__
  48 extern long timezone;
  49 #endif
  50
  51 // Tests whether the supplied string is a valid newsgroup name
  52 // Returns true (nonzero) or false (0)
  53 int is_valid_newsgroup_name(char *name) {
  54         char *ptr = name;
  55         int has_a_letter = 0;
  56         int num_dots = 0;
  57
  58         if (!ptr) return(0);
  59         if (!strncasecmp(name, "ctdl.", 5)) return(0);
  60
  61         while (*ptr != 0) {
  62
  63                 if (isalpha(ptr[0])) {
  64                         has_a_letter = 1;
  65                 }
  66
  67                 if (ptr[0] == '.') {
  68                         ++num_dots;
  69                 }
  70
  71                 if (    (isalnum(ptr[0]))
  72                         || (ptr[0] == '.')
  73                         || (ptr[0] == '+')
  74                         || (ptr[0] == '-')
  75                 ) {
  76                         ++ptr;
  77                 }
  78                 else {
  79                         return(0);
  80                 }
  81         }
  82         return( (has_a_letter) && (num_dots >= 1) ) ;
  83 }
  84
  85
  86 // Convert a Citadel room name to a valid newsgroup name
  87 void room_to_newsgroup(char *target, char *source, size_t target_size) {
  88
  89         if (!target) return;
  90         if (!source) return;
  91
  92         if (is_valid_newsgroup_name(source)) {
  93                 strncpy(target, source, target_size);
  94                 return;
  95         }
  96
  97         strcpy(target, "ctdl.");
  98         int len = 5;
  99         char *ptr = source;
 100         char ch;
 101
 102         while (ch=*ptr++, ch!=0) {
 103                 if (len >= target_size) return;
 104                 if (    (isalnum(ch))
 105                         || (ch == '.')
 106                         || (ch == '-')
 107                 ) {
 108                         target[len++] = tolower(ch);
 109                         target[len] = 0;
 110                 }
 111                 else {
 112                         target[len++] = '+' ;
 113                         sprintf(&target[len], "%02x", ch);
 114                         len += 2;
 115                         target[len] = 0;
 116                 }
 117         }
 118 }
 119
 120
 121 // Convert a newsgroup name to a Citadel room name.
 122 // This function recognizes names converted with room_to_newsgroup() and restores them with full fidelity.
 123 void newsgroup_to_room(char *target, char *source, size_t target_size) {
 124
 125         if (!target) return;
 126         if (!source) return;
 127
 128         if (strncasecmp(source, "ctdl.", 5)) {                  // not a converted room name; pass through as-is
 129                 strncpy(target, source, target_size);
 130                 return;
 131         }
 132
 133         target[0] = 0;
 134         int len = 0;
 135         char *ptr = &source[5];
 136         char ch;
 137
 138         while (ch=*ptr++, ch!=0) {
 139                 if (len >= target_size) return;
 140                 if (ch == '+') {
 141                         char hex[3];
 142                         long digit;
 143                         hex[0] = *ptr++;
 144                         hex[1] = *ptr++;
 145                         hex[2] = 0;
 146                         digit = strtol(hex, NULL, 16);
 147                         ch = (char)digit;
 148                 }
 149                 target[len++] = ch;
 150                 target[len] = 0;
 151         }
 152 }
 153
 154
 155 // Here's where our NNTP session begins its happy day.
 156 void nntp_greeting(void) {
 157         strcpy(CC->cs_clientname, "NNTP session");
 158         CC->cs_flags |= CS_STEALTH;
 159
 160         CC->session_specific_data = malloc(sizeof(citnntp));
 161         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
 162         memset(nntpstate, 0, sizeof(citnntp));
 163
 164         if (CC->nologin==1) {
 165                 cprintf("451 Too many connections are already open; please try again later.\r\n");
 166                 CC->kill_me = KILLME_MAX_SESSIONS_EXCEEDED;
 167                 return;
 168         }
 169
 170         // Display the standard greeting
 171         cprintf("200 %s NNTP Citadel server is not finished yet\r\n", CtdlGetConfigStr("c_fqdn"));
 172 }
 173
 174
 175 // NNTPS is just like NNTP, except it goes crypto right away.
 176 void nntps_greeting(void) {
 177         CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
 178 #ifdef HAVE_OPENSSL
 179         if (!CC->redirect_ssl) CC->kill_me = KILLME_NO_CRYPTO;          // kill session if no crypto
 180 #endif
 181         nntp_greeting();
 182 }
 183
 184
 185 // implements the STARTTLS command
 186 void nntp_starttls(void) {
 187         char ok_response[SIZ];
 188         char nosup_response[SIZ];
 189         char error_response[SIZ];
 190
 191         sprintf(ok_response, "382 Begin TLS negotiation now\r\n");
 192         sprintf(nosup_response, "502 Can not initiate TLS negotiation\r\n");
 193         sprintf(error_response, "580 Internal error\r\n");
 194         CtdlModuleStartCryptoMsgs(ok_response, nosup_response, error_response);
 195 }
 196
 197
 198 // Implements the CAPABILITY command
 199 void nntp_capabilities(void) {
 200         cprintf("101 Capability list:\r\n");
 201         cprintf("IMPLEMENTATION Citadel %d\r\n", REV_LEVEL);
 202         cprintf("VERSION 2\r\n");
 203         cprintf("READER\r\n");
 204         cprintf("MODE-READER\r\n");
 205         cprintf("LIST ACTIVE NEWSGROUPS\r\n");
 206         cprintf("OVER\r\n");
 207 #ifdef HAVE_OPENSSL
 208         cprintf("STARTTLS\r\n");
 209 #endif
 210         if (!CC->logged_in) {
 211                 cprintf("AUTHINFO USER\r\n");
 212         }
 213         cprintf(".\r\n");
 214 }
 215
 216
 217 // Implements the QUIT command
 218 void nntp_quit(void) {
 219         cprintf("221 Goodbye...\r\n");
 220         CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
 221 }
 222
 223
 224 // Implements the AUTHINFO USER command (RFC 4643)
 225 void nntp_authinfo_user(const char *username) {
 226         int a = CtdlLoginExistingUser(username);
 227         switch (a) {
 228         case login_already_logged_in:
 229                 cprintf("482 Already logged in\r\n");
 230                 return;
 231         case login_too_many_users:
 232                 cprintf("481 Too many users are already online (maximum is %d)\r\n", CtdlGetConfigInt("c_maxsessions"));
 233                 return;
 234         case login_ok:
 235                 cprintf("381 Password required for %s\r\n", CC->curr_user);
 236                 return;
 237         case login_not_found:
 238                 cprintf("481 %s not found\r\n", username);
 239                 return;
 240         default:
 241                 cprintf("502 Internal error\r\n");
 242         }
 243 }
 244
 245
 246 // Implements the AUTHINFO PASS command (RFC 4643)
 247 void nntp_authinfo_pass(const char *buf) {
 248         int a;
 249
 250         a = CtdlTryPassword(buf, strlen(buf));
 251
 252         switch (a) {
 253         case pass_already_logged_in:
 254                 cprintf("482 Already logged in\r\n");
 255                 return;
 256         case pass_no_user:
 257                 cprintf("482 Authentication commands issued out of sequence\r\n");
 258                 return;
 259         case pass_wrong_password:
 260                 cprintf("481 Authentication failed\r\n");
 261                 return;
 262         case pass_ok:
 263                 cprintf("281 Authentication accepted\r\n");
 264                 return;
 265         }
 266 }
 267
 268
 269 // Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
 270 void nntp_authinfo(const char *cmd) {
 271
 272         if (!strncasecmp(cmd, "authinfo user ", 14)) {
 273                 nntp_authinfo_user(&cmd[14]);
 274         }
 275
 276         else if (!strncasecmp(cmd, "authinfo pass ", 14)) {
 277                 nntp_authinfo_pass(&cmd[14]);
 278         }
 279
 280         else {
 281                 cprintf("502 command unavailable\r\n");
 282         }
 283 }
 284
 285
 286 // Utility function to fetch the current list of message numbers in a room
 287 struct nntp_msglist nntp_fetch_msglist(struct ctdlroom *qrbuf) {
 288         struct nntp_msglist nm;
 289         struct cdbdata *cdbfr;
 290
 291         nm.num_msgs = CtdlFetchMsgList(qrbuf->QRnumber, &nm.msgnums);
 292         if (nm.msgnums < 0) {
 293                 nm.num_msgs = 0;
 294                 nm.msgnums = NULL;
 295         }
 296         return(nm);
 297 }
 298
 299
 300 // Output a room name (newsgroup name) in formats required for LIST and NEWGROUPS command
 301 void output_roomname_in_list_format(struct ctdlroom *qrbuf, int which_format, char *wildmat_pattern) {
 302         char n_name[1024];
 303         struct nntp_msglist nm;
 304         long low_water_mark = 0;
 305         long high_water_mark = 0;
 306
 307         room_to_newsgroup(n_name, qrbuf->QRname, sizeof n_name);
 308
 309         if ((wildmat_pattern != NULL) && (!IsEmptyStr(wildmat_pattern))) {
 310                 if (!wildmat(n_name, wildmat_pattern)) {
 311                         return;
 312                 }
 313         }
 314
 315         nm = nntp_fetch_msglist(qrbuf);
 316         if ((nm.num_msgs > 0) && (nm.msgnums != NULL)) {
 317                 low_water_mark = nm.msgnums[0];
 318                 high_water_mark = nm.msgnums[nm.num_msgs - 1];
 319         }
 320
 321         // Only the mandatory formats are supported
 322         switch(which_format) {
 323         case NNTP_LIST_ACTIVE:
 324                 // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
 325                 cprintf("%s %ld %ld n\r\n", n_name, high_water_mark, low_water_mark);
 326                 break;
 327         case NNTP_LIST_NEWSGROUPS:
 328                 cprintf("%s %s\r\n", n_name, qrbuf->QRname);
 329                 break;
 330         }
 331
 332         if (nm.msgnums != NULL) {
 333                 free(nm.msgnums);
 334         }
 335 }
 336
 337
 338 // Called once per room by nntp_newgroups() to qualify and possibly output a single room
 339 void nntp_newgroups_backend(struct ctdlroom *qrbuf, void *data) {
 340         int ra;
 341         int view;
 342         time_t thetime = *(time_t *)data;
 343
 344         CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
 345
 346         // The "created after <date/time>" heuristics depend on the happy coincidence
 347         // that for a very long time we have used a unix timestamp as the room record's
 348         // generation number (QRgen).  When this module is merged into the master
 349         // source tree we should rename QRgen to QR_create_time or something like that.
 350         if (ra & UA_KNOWN) {
 351                 if (qrbuf->QRgen >= thetime) {
 352                         output_roomname_in_list_format(qrbuf, NNTP_LIST_ACTIVE, NULL);
 353                 }
 354         }
 355 }
 356
 357
 358 // Implements the NEWGROUPS command
 359 void nntp_newgroups(const char *cmd) {
 360         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 361
 362         char stringy_date[16];
 363         char stringy_time[16];
 364         char stringy_gmt[16];
 365         struct tm tm;
 366         time_t thetime;
 367
 368         extract_token(stringy_date, cmd, 1, ' ', sizeof stringy_date);
 369         extract_token(stringy_time, cmd, 2, ' ', sizeof stringy_time);
 370         extract_token(stringy_gmt, cmd, 3, ' ', sizeof stringy_gmt);
 371
 372         memset(&tm, 0, sizeof tm);
 373         if (strlen(stringy_date) == 6) {
 374                 sscanf(stringy_date, "%2d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
 375                 tm.tm_year += 100;
 376         }
 377         else {
 378                 sscanf(stringy_date, "%4d%2d%2d", &tm.tm_year, &tm.tm_mon, &tm.tm_mday);
 379                 tm.tm_year -= 1900;
 380         }
 381         tm.tm_mon -= 1;         // tm_mon is zero based (0=January)
 382         tm.tm_isdst = (-1);     // let the C library figure out whether DST is in effect
 383         sscanf(stringy_time, "%2d%2d%2d", &tm.tm_hour, &tm.tm_min ,&tm.tm_sec);
 384         thetime = mktime(&tm);
 385         if (!strcasecmp(stringy_gmt, "GMT")) {
 386                 tzset();
 387 #ifdef __FreeBSD__
 388                 thetime += &tm.tm_gmtoff;
 389 #else
 390                 thetime += timezone;
 391 #endif
 392         }
 393
 394         cprintf("231 list of new newsgroups follows\r\n");
 395         CtdlGetUser(&CC->user, CC->curr_user);
 396         CtdlForEachRoom(nntp_newgroups_backend, &thetime);
 397         cprintf(".\r\n");
 398 }
 399
 400
 401 // Called once per room by nntp_list() to qualify and possibly output a single room
 402 void nntp_list_backend(struct ctdlroom *qrbuf, void *data) {
 403         int ra;
 404         int view;
 405         struct nntp_list_data *nld = (struct nntp_list_data *)data;
 406
 407         CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
 408         if (ra & UA_KNOWN) {
 409                 output_roomname_in_list_format(qrbuf, nld->list_format, nld->wildmat_pattern);
 410         }
 411 }
 412
 413
 414 // Implements the LIST commands
 415 void nntp_list(const char *cmd) {
 416         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 417
 418         char list_format[64];
 419         char wildmat_pattern[1024];
 420         struct nntp_list_data nld;
 421
 422         extract_token(list_format, cmd, 1, ' ', sizeof list_format);
 423         extract_token(wildmat_pattern, cmd, 2, ' ', sizeof wildmat_pattern);
 424
 425         if (strlen(wildmat_pattern) > 0) {
 426                 nld.wildmat_pattern = wildmat_pattern;
 427         }
 428         else {
 429                 nld.wildmat_pattern = NULL;
 430         }
 431
 432         if ( (strlen(cmd) < 6) || (!strcasecmp(list_format, "ACTIVE")) ) {
 433                 nld.list_format = NNTP_LIST_ACTIVE;
 434         }
 435         else if (!strcasecmp(list_format, "NEWSGROUPS")) {
 436                 nld.list_format = NNTP_LIST_NEWSGROUPS;
 437         }
 438         else if (!strcasecmp(list_format, "OVERVIEW.FMT")) {
 439                 nld.list_format = NNTP_LIST_OVERVIEW_FMT;
 440         }
 441         else {
 442                 cprintf("501 syntax error , unsupported list format\r\n");
 443                 return;
 444         }
 445
 446         // OVERVIEW.FMT delivers a completely different type of data than all of the
 447         // other LIST commands.  It's a stupid place to put it.  But that's how it's
 448         // written into RFC3977, so we have to handle it here.
 449         if (nld.list_format == NNTP_LIST_OVERVIEW_FMT) {
 450                 cprintf("215 Order of fields in overview database.\r\n");
 451                 cprintf("Subject:\r\n");
 452                 cprintf("From:\r\n");
 453                 cprintf("Date:\r\n");
 454                 cprintf("Message-ID:\r\n");
 455                 cprintf("References:\r\n");
 456                 cprintf("Bytes:\r\n");
 457                 cprintf("Lines:\r\n");
 458                 cprintf(".\r\n");
 459                 return;
 460         }
 461
 462         cprintf("215 list of newsgroups follows\r\n");
 463         CtdlGetUser(&CC->user, CC->curr_user);
 464         CtdlForEachRoom(nntp_list_backend, &nld);
 465         cprintf(".\r\n");
 466 }
 467
 468
 469 // Implement HELP command.
 470 void nntp_help(void) {
 471         cprintf("100 This is the Citadel NNTP service.\r\n");
 472         cprintf("RTFM http://www.ietf.org/rfc/rfc3977.txt\r\n");
 473         cprintf(".\r\n");
 474 }
 475
 476
 477 // Implement DATE command.
 478 void nntp_date(void) {
 479         time_t now;
 480         struct tm nowLocal;
 481         struct tm nowUtc;
 482         char tsFromUtc[32];
 483
 484         now = time(NULL);
 485         localtime_r(&now, &nowLocal);
 486         gmtime_r(&now, &nowUtc);
 487
 488         strftime(tsFromUtc, sizeof(tsFromUtc), "%Y%m%d%H%M%S", &nowUtc);
 489
 490         cprintf("111 %s\r\n", tsFromUtc);
 491 }
 492
 493
 494 // back end for the LISTGROUP command , called for each message number
 495 void nntp_listgroup_backend(long msgnum, void *userdata) {
 496
 497         struct listgroup_range *lr = (struct listgroup_range *)userdata;
 498
 499         // check range if supplied
 500         if (msgnum < lr->lo) return;
 501         if ((lr->hi != 0) && (msgnum > lr->hi)) return;
 502
 503         cprintf("%ld\r\n", msgnum);
 504 }
 505
 506
 507 // Implements the GROUP and LISTGROUP commands
 508 void nntp_group(const char *cmd) {
 509         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 510
 511         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
 512         char verb[16];
 513         char requested_group[1024];
 514         char message_range[256];
 515         char range_lo[256];
 516         char range_hi[256];
 517         char requested_room[ROOMNAMELEN];
 518         char augmented_roomname[ROOMNAMELEN];
 519         int c = 0;
 520         int ok = 0;
 521         int ra = 0;
 522         struct ctdlroom QRscratch;
 523         int msgs, new;
 524         long oldest,newest;
 525         struct listgroup_range lr;
 526
 527         extract_token(verb, cmd, 0, ' ', sizeof verb);
 528         extract_token(requested_group, cmd, 1, ' ', sizeof requested_group);
 529         extract_token(message_range, cmd, 2, ' ', sizeof message_range);
 530         extract_token(range_lo, message_range, 0, '-', sizeof range_lo);
 531         extract_token(range_hi, message_range, 1, '-', sizeof range_hi);
 532         lr.lo = atoi(range_lo);
 533         lr.hi = atoi(range_hi);
 534
 535         // In LISTGROUP mode we can specify an empty name for 'currently selected'
 536         if ((!strcasecmp(verb, "LISTGROUP")) && (IsEmptyStr(requested_group))) {
 537                 room_to_newsgroup(requested_group, CC->room.QRname, sizeof requested_group);
 538         }
 539
 540         // First try a regular match
 541         newsgroup_to_room(requested_room, requested_group, sizeof requested_room);
 542         c = CtdlGetRoom(&QRscratch, requested_room);
 543
 544         // Then try a mailbox name match
 545         if (c != 0) {
 546                 CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, requested_room);
 547                 c = CtdlGetRoom(&QRscratch, augmented_roomname);
 548                 if (c == 0) {
 549                         safestrncpy(requested_room, augmented_roomname, sizeof(requested_room));
 550                 }
 551         }
 552
 553         // If the room exists, check security/access
 554         if (c == 0) {
 555                 // See if there is an existing user/room relationship
 556                 CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
 557
 558                 // normal clients have to pass through security
 559                 if (ra & UA_KNOWN) {
 560                         ok = 1;
 561                 }
 562         }
 563
 564         // Fail here if no such room
 565         if (!ok) {
 566                 cprintf("411 no such newsgroup\r\n");
 567                 return;
 568         }
 569
 570
 571         // CtdlUserGoto() formally takes us to the desired room, happily returning
 572         // the number of messages and number of new messages.
 573         memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
 574         CtdlUserGoto(NULL, 0, 0, &msgs, &new, &oldest, &newest);
 575         cprintf("211 %d %ld %ld %s\r\n", msgs, oldest, newest, requested_group);
 576
 577         // If this is a GROUP command, set the "current article number" to zero, and then stop here.
 578         if (!strcasecmp(verb, "GROUP")) {
 579                 nntpstate->current_article_number = oldest;
 580                 return;
 581         }
 582
 583         // If we get to this point we are running a LISTGROUP command.  Fetch those message numbers.
 584         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, nntp_listgroup_backend, &lr);
 585         cprintf(".\r\n");
 586 }
 587
 588
 589 // Implements the MODE command
 590 void nntp_mode(const char *cmd) {
 591
 592         char which_mode[16];
 593
 594         extract_token(which_mode, cmd, 1, ' ', sizeof which_mode);
 595
 596         if (!strcasecmp(which_mode, "reader")) {
 597                 // FIXME implement posting and change to 200
 598                 cprintf("201 Reader mode activated\r\n");
 599         }
 600         else {
 601                 cprintf("501 unknown mode\r\n");
 602         }
 603 }
 604
 605
 606 // Implements the ARTICLE, HEAD, BODY, and STAT commands.
 607 // (These commands all accept the same parameters; they differ only in how they output the retrieved message.)
 608 void nntp_article(const char *cmd) {
 609         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 610
 611         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
 612         char which_command[16];
 613         int acmd = 0;
 614         char requested_article[256];
 615         long requested_msgnum = 0;
 616         char *lb, *rb = NULL;
 617         int must_change_currently_selected_article = 0;
 618
 619         // We're going to store one of these values in the variable 'acmd' so that
 620         // we can quickly check later which version of the output we want.
 621         enum {
 622                 ARTICLE,
 623                 HEAD,
 624                 BODY,
 625                 STAT
 626         };
 627
 628         extract_token(which_command, cmd, 0, ' ', sizeof which_command);
 629
 630         if (!strcasecmp(which_command, "article")) {
 631                 acmd = ARTICLE;
 632         }
 633         else if (!strcasecmp(which_command, "head")) {
 634                 acmd = HEAD;
 635         }
 636         else if (!strcasecmp(which_command, "body")) {
 637                 acmd = BODY;
 638         }
 639         else if (!strcasecmp(which_command, "stat")) {
 640                 acmd = STAT;
 641         }
 642         else {
 643                 cprintf("500 I'm afraid I can't do that.\r\n");
 644                 return;
 645         }
 646
 647         // Which NNTP command was issued, determines whether we will fetch headers, body, or both.
 648         int                     headers_only = HEADERS_ALL;
 649         if (acmd == HEAD)       headers_only = HEADERS_FAST;
 650         else if (acmd == BODY)  headers_only = HEADERS_NONE;
 651         else if (acmd == STAT)  headers_only = HEADERS_FAST;
 652
 653         // now figure out what the client is asking for.
 654         extract_token(requested_article, cmd, 1, ' ', sizeof requested_article);
 655         lb = strchr(requested_article, '<');
 656         rb = strchr(requested_article, '>');
 657         requested_msgnum = atol(requested_article);
 658
 659         // If no article number or message-id is specified, the client wants the "currently selected article"
 660         if (IsEmptyStr(requested_article)) {
 661                 if (nntpstate->current_article_number < 1) {
 662                         cprintf("420 No current article selected\r\n");
 663                         return;
 664                 }
 665                 requested_msgnum = nntpstate->current_article_number;
 666                 must_change_currently_selected_article = 1;
 667                 // got it -- now fall through and keep going
 668         }
 669
 670         // If the requested article is numeric, it maps directly to a message number.  Good.
 671         else if (requested_msgnum > 0) {
 672                 must_change_currently_selected_article = 1;
 673                 // good -- fall through and keep going
 674         }
 675
 676         // If the requested article has angle brackets, the client wants a specific message-id.
 677         // We don't know how to do that yet.
 678         else if ( (lb != NULL) && (rb != NULL) && (lb < rb) ) {
 679                 must_change_currently_selected_article = 0;
 680                 cprintf("500 I don't know how to fetch by message-id yet.\r\n");        // FIXME
 681                 return;
 682         }
 683
 684         // Anything else is noncompliant gobbledygook and should die in a car fire.
 685         else {
 686                 must_change_currently_selected_article = 0;
 687                 cprintf("500 syntax error\r\n");
 688                 return;
 689         }
 690
 691         // At this point we know the message number of the "article" being requested.
 692         // We have an awesome API call that does all the heavy lifting for us.
 693         char *fetched_message_id = NULL;
 694         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 695         int fetch = CtdlOutputMsg(requested_msgnum,
 696                         MT_RFC822,              // output in RFC822 format ... sort of
 697                         headers_only,           // headers, body, or both?
 698                         0,                      // don't do Citadel protocol responses
 699                         1,                      // CRLF newlines
 700                         NULL,                   // teh whole thing, not just a section
 701                         0,                      // no flags yet ... maybe new ones for Path: etc ?
 702                         NULL,
 703                         NULL,
 704                         &fetched_message_id     // extract the message ID from the message as we go...
 705         );
 706         StrBuf *msgtext = CC->redirect_buffer;
 707         CC->redirect_buffer = NULL;
 708
 709         if (fetch != om_ok) {
 710                 cprintf("423 no article with that number\r\n");
 711                 FreeStrBuf(&msgtext);
 712                 return;
 713         }
 714
 715         // RFC3977 6.2.1.2 specifes conditions under which the "currently selected article"
 716         // MUST or MUST NOT be set to the message we just referenced.
 717         if (must_change_currently_selected_article) {
 718                 nntpstate->current_article_number = requested_msgnum;
 719         }
 720
 721         // Now give the client what it asked for.
 722         if (acmd == ARTICLE) {
 723                 cprintf("220 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
 724         }
 725         if (acmd == HEAD) {
 726                 cprintf("221 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
 727         }
 728         if (acmd == BODY) {
 729                 cprintf("222 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
 730         }
 731         if (acmd == STAT) {
 732                 cprintf("223 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
 733                 FreeStrBuf(&msgtext);
 734                 return;
 735         }
 736
 737         client_write(SKEY(msgtext));
 738         cprintf(".\r\n");                       // this protocol uses a dot terminator
 739         FreeStrBuf(&msgtext);
 740         if (fetched_message_id) free(fetched_message_id);
 741 }
 742
 743
 744 // Utility function for nntp_last_next() that turns a msgnum into a message ID.
 745 // The memory for the returned string is pwnz0red by the caller.
 746 char *message_id_from_msgnum(long msgnum) {
 747         char *fetched_message_id = NULL;
 748         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
 749         CtdlOutputMsg(msgnum,
 750                         MT_RFC822,              // output in RFC822 format ... sort of
 751                         HEADERS_FAST,           // headers, body, or both?
 752                         0,                      // don't do Citadel protocol responses
 753                         1,                      // CRLF newlines
 754                         NULL,                   // teh whole thing, not just a section
 755                         0,                      // no flags yet ... maybe new ones for Path: etc ?
 756                         NULL,
 757                         NULL,
 758                         &fetched_message_id     // extract the message ID from the message as we go...
 759         );
 760         StrBuf *msgtext = CC->redirect_buffer;
 761         CC->redirect_buffer = NULL;
 762
 763         FreeStrBuf(&msgtext);
 764         return(fetched_message_id);
 765 }
 766
 767
 768 // The LAST and NEXT commands are so similar that they are handled by a single function.
 769 void nntp_last_next(const char *cmd) {
 770         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 771
 772         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
 773         char which_command[16];
 774         int acmd = 0;
 775
 776         // We're going to store one of these values in the variable 'acmd' so that
 777         // we can quickly check later which version of the output we want.
 778         enum {
 779                 NNTP_LAST,
 780                 NNTP_NEXT
 781         };
 782
 783         extract_token(which_command, cmd, 0, ' ', sizeof which_command);
 784
 785         if (!strcasecmp(which_command, "last")) {
 786                 acmd = NNTP_LAST;
 787         }
 788         else if (!strcasecmp(which_command, "next")) {
 789                 acmd = NNTP_NEXT;
 790         }
 791         else {
 792                 cprintf("500 I'm afraid I can't do that.\r\n");
 793                 return;
 794         }
 795
 796         // ok, here we go ... fetch the msglist so we can figure out our place in the universe
 797         struct nntp_msglist nm;
 798         int i = 0;
 799         long selected_msgnum = 0;
 800         char *message_id = NULL;
 801
 802         nm = nntp_fetch_msglist(&CC->room);
 803         if ((nm.num_msgs < 0) || (nm.msgnums == NULL)) {
 804                 cprintf("500 something bad happened\r\n");
 805                 return;
 806         }
 807
 808         if ( (acmd == NNTP_LAST) && (nm.num_msgs == 0) ) {
 809                         cprintf("422 no previous article in this group\r\n");   // nothing here
 810         }
 811
 812         else if ( (acmd == NNTP_LAST) && (nntpstate->current_article_number <= nm.msgnums[0]) ) {
 813                         cprintf("422 no previous article in this group\r\n");   // already at the beginning
 814         }
 815
 816         else if (acmd == NNTP_LAST) {
 817                 for (i=0; ((i<nm.num_msgs)&&(selected_msgnum<=0)); ++i) {
 818                         if ( (nm.msgnums[i] >= nntpstate->current_article_number) && (i > 0) ) {
 819                                 selected_msgnum = nm.msgnums[i-1];
 820                         }
 821                 }
 822                 if (selected_msgnum > 0) {
 823                         nntpstate->current_article_number = selected_msgnum;
 824                         message_id = message_id_from_msgnum(nntpstate->current_article_number);
 825                         cprintf("223 %ld <%s>\r\n", nntpstate->current_article_number, message_id);
 826                         if (message_id) free(message_id);
 827                 }
 828                 else {
 829                         cprintf("422 no previous article in this group\r\n");
 830                 }
 831         }
 832
 833         else if ( (acmd == NNTP_NEXT) && (nm.num_msgs == 0) ) {
 834                         cprintf("421 no next article in this group\r\n");       // nothing here
 835         }
 836
 837         else if ( (acmd == NNTP_NEXT) && (nntpstate->current_article_number >= nm.msgnums[nm.num_msgs-1]) ) {
 838                         cprintf("421 no next article in this group\r\n");       // already at the end
 839         }
 840
 841         else if (acmd == NNTP_NEXT) {
 842                 for (i=0; ((i<nm.num_msgs)&&(selected_msgnum<=0)); ++i) {
 843                         if (nm.msgnums[i] > nntpstate->current_article_number) {
 844                                 selected_msgnum = nm.msgnums[i];
 845                         }
 846                 }
 847                 if (selected_msgnum > 0) {
 848                         nntpstate->current_article_number = selected_msgnum;
 849                         message_id = message_id_from_msgnum(nntpstate->current_article_number);
 850                         cprintf("223 %ld <%s>\r\n", nntpstate->current_article_number, message_id);
 851                         if (message_id) free(message_id);
 852                 }
 853                 else {
 854                         cprintf("421 no next article in this group\r\n");
 855                 }
 856         }
 857
 858         // should never get here
 859         else {
 860                 cprintf("500 internal error\r\n");
 861         }
 862
 863         if (nm.msgnums != NULL) {
 864                 free(nm.msgnums);
 865         }
 866
 867 }
 868
 869
 870 // back end for the XOVER command , called for each message number
 871 void nntp_xover_backend(long msgnum, void *userdata) {
 872
 873         struct listgroup_range *lr = (struct listgroup_range *)userdata;
 874
 875         // check range if supplied
 876         if (msgnum < lr->lo) return;
 877         if ((lr->hi != 0) && (msgnum > lr->hi)) return;
 878
 879         struct CtdlMessage *msg = CtdlFetchMessage(msgnum, 0);
 880         if (msg == NULL) {
 881                 return;
 882         }
 883
 884         // Teh RFC says we need:
 885         // -------------------------
 886         // Subject header content
 887         // From header content
 888         // Date header content
 889         // Message-ID header content
 890         // References header content
 891         // :bytes metadata item
 892         // :lines metadata item
 893
 894         time_t msgtime = atol(msg->cm_fields[eTimestamp]);
 895         char strtimebuf[26];
 896         ctime_r(&msgtime, strtimebuf);
 897
 898         // here we go -- print the line o'data
 899         cprintf("%ld\t%s\t%s <%s>\t%s\t%s\t%s\t100\t10\r\n",
 900                 msgnum,
 901                 msg->cm_fields[eMsgSubject],
 902                 msg->cm_fields[eAuthor],
 903                 msg->cm_fields[erFc822Addr],
 904                 strtimebuf,
 905                 msg->cm_fields[emessageId],
 906                 msg->cm_fields[eWeferences]
 907         );
 908
 909         CM_Free(msg);
 910 }
 911
 912
 913 // XOVER is used by some clients, even if we don't offer it
 914 void nntp_xover(const char *cmd) {
 915         if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
 916
 917         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
 918         char range[256];
 919         struct listgroup_range lr;
 920
 921         extract_token(range, cmd, 1, ' ', sizeof range);
 922         lr.lo = atol(range);
 923         if (lr.lo <= 0) {
 924                 lr.lo = nntpstate->current_article_number;
 925                 lr.hi = nntpstate->current_article_number;
 926         }
 927         else {
 928                 char *dash = strchr(range, '-');
 929                 if (dash != NULL) {
 930                         ++dash;
 931                         lr.hi = atol(dash);
 932                         if (lr.hi == 0) {
 933                                 lr.hi = LONG_MAX;
 934                         }
 935                         if (lr.hi < lr.lo) {
 936                                 lr.hi = lr.lo;
 937                         }
 938                 }
 939                 else {
 940                         lr.hi = lr.lo;
 941                 }
 942         }
 943
 944         cprintf("224 Overview information follows\r\n");
 945         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, nntp_xover_backend, &lr);
 946         cprintf(".\r\n");
 947 }
 948
 949
 950 // Main command loop for NNTP server sessions.
 951 void nntp_command_loop(void) {
 952         StrBuf *Cmd = NewStrBuf();
 953         char cmdname[16];
 954
 955         time(&CC->lastcmd);
 956         if (CtdlClientGetLine(Cmd) < 1) {
 957                 syslog(LOG_CRIT, "NNTP: client disconnected: ending session.\n");
 958                 CC->kill_me = KILLME_CLIENT_DISCONNECTED;
 959                 FreeStrBuf(&Cmd);
 960                 return;
 961         }
 962         syslog(LOG_DEBUG, "NNTP: %s\n", ((!strncasecmp(ChrPtr(Cmd), "AUTHINFO", 8)) ? "AUTHINFO ..." : ChrPtr(Cmd)));
 963         extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
 964
 965         // Rumpelstiltskin lookups are *awesome*
 966
 967         if (!strcasecmp(cmdname, "quit")) {
 968                 nntp_quit();
 969         }
 970
 971         else if (!strcasecmp(cmdname, "help")) {
 972                 nntp_help();
 973         }
 974
 975         else if (!strcasecmp(cmdname, "date")) {
 976                 nntp_date();
 977         }
 978
 979         else if (!strcasecmp(cmdname, "capabilities")) {
 980                 nntp_capabilities();
 981         }
 982
 983         else if (!strcasecmp(cmdname, "starttls")) {
 984                 nntp_starttls();
 985         }
 986
 987         else if (!strcasecmp(cmdname, "authinfo")) {
 988                 nntp_authinfo(ChrPtr(Cmd));
 989         }
 990
 991         else if (!strcasecmp(cmdname, "newgroups")) {
 992                 nntp_newgroups(ChrPtr(Cmd));
 993         }
 994
 995         else if (!strcasecmp(cmdname, "list")) {
 996                 nntp_list(ChrPtr(Cmd));
 997         }
 998
 999         else if (!strcasecmp(cmdname, "group")) {
1000                 nntp_group(ChrPtr(Cmd));
1001         }
1002
1003         else if (!strcasecmp(cmdname, "listgroup")) {
1004                 nntp_group(ChrPtr(Cmd));
1005         }
1006
1007         else if (!strcasecmp(cmdname, "mode")) {
1008                 nntp_mode(ChrPtr(Cmd));
1009         }
1010
1011         else if (
1012                         (!strcasecmp(cmdname, "article"))
1013                         || (!strcasecmp(cmdname, "head"))
1014                         || (!strcasecmp(cmdname, "body"))
1015                         || (!strcasecmp(cmdname, "stat"))
1016                 )
1017         {
1018                 nntp_article(ChrPtr(Cmd));
1019         }
1020
1021         else if (
1022                         (!strcasecmp(cmdname, "last"))
1023                         || (!strcasecmp(cmdname, "next"))
1024                 )
1025         {
1026                 nntp_last_next(ChrPtr(Cmd));
1027         }
1028
1029         else if (
1030                         (!strcasecmp(cmdname, "xover"))
1031                         || (!strcasecmp(cmdname, "over"))
1032                 )
1033         {
1034                 nntp_xover(ChrPtr(Cmd));
1035         }
1036
1037         else {
1038                 cprintf("500 I'm afraid I can't do that.\r\n");
1039         }
1040
1041         FreeStrBuf(&Cmd);
1042 }
1043
1044
1045 //      ****************************************************************************
1046 //                            MODULE INITIALIZATION STUFF
1047 //      ****************************************************************************
1048
1049
1050 // This cleanup function blows away the temporary memory used by the NNTP server.
1051 void nntp_cleanup_function(void) {
1052         // Don't do this stuff if this is not an NNTP session!
1053         if (CC->h_command_function != nntp_command_loop) return;
1054
1055         syslog(LOG_DEBUG, "Performing NNTP cleanup hook\n");
1056         citnntp *nntpstate = (citnntp *) CC->session_specific_data;
1057         if (nntpstate != NULL) {
1058                 free(nntpstate);
1059                 nntpstate = NULL;
1060         }
1061 }
1062
1063 const char *CitadelServiceNNTP="NNTP";
1064 const char *CitadelServiceNNTPS="NNTPS";
1065
1066
1067 // Initialization function, called from modules_init.c
1068 char *ctdl_module_init_nntp(void) {
1069         if (!threading) {
1070                 CtdlRegisterServiceHook(CtdlGetConfigInt("c_nntp_port"),
1071                                         NULL,
1072                                         nntp_greeting,
1073                                         nntp_command_loop,
1074                                         NULL,
1075                                         CitadelServiceNNTP);
1076
1077 #ifdef HAVE_OPENSSL
1078                 CtdlRegisterServiceHook(CtdlGetConfigInt("c_nntps_port"),
1079                                         NULL,
1080                                         nntps_greeting,
1081                                         nntp_command_loop,
1082                                         NULL,
1083                                         CitadelServiceNNTPS);
1084 #endif
1085
1086                 CtdlRegisterSessionHook(nntp_cleanup_function, EVT_STOP, PRIO_STOP + 250);
1087         }
1088
1089         // return our module name for the log
1090         return "nntp";
1091 }