-/*
- * NNTP server module FIXME THIS IS NOT FINISHED
- *
- * Copyright (c) 2014 by the citadel.org team
- *
- * This program is open source software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
+//
+// NNTP server module FIXME THIS IS NOT FINISHED
+//
+// Copyright (c) 2014 by the citadel.org team
+//
+// This program is open source software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License version 3.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
#include "sysdep.h"
#include <stdlib.h>
#include "locate_host.h"
#include "citadel_dirs.h"
#include "ctdl_module.h"
-
+#include "serv_nntp.h"
extern long timezone;
-/****************** BEGIN UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
+// ***************** BEGIN UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************
-/*
- * Tests whether the supplied string is a valid newsgroup name
- * Returns true (nonzero) or false (0)
- */
+//
+// Tests whether the supplied string is a valid newsgroup name
+// Returns true (nonzero) or false (0)
+//
int is_valid_newsgroup_name(char *name) {
char *ptr = name;
int has_a_letter = 0;
-/*
- * Convert a Citadel room name to a valid newsgroup name
- */
+//
+// Convert a Citadel room name to a valid newsgroup name
+//
void room_to_newsgroup(char *target, char *source, size_t target_size) {
if (!target) return;
}
-/*
- * Convert a newsgroup name to a Citadel room name.
- * This function recognizes names converted with room_to_newsgroup() and restores them with full fidelity.
- */
+//
+// Convert a newsgroup name to a Citadel room name.
+// This function recognizes names converted with room_to_newsgroup() and restores them with full fidelity.
+//
void newsgroup_to_room(char *target, char *source, size_t target_size) {
if (!target) return;
}
-/****************** END UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************/
+// ***************** END UTILITY FUNCTIONS THAT COULD BE MOVED ELSEWHERE LATER **************
-/*
- * Here's where our NNTP session begins its happy day.
- */
+//
+// Here's where our NNTP session begins its happy day.
+//
void nntp_greeting(void)
{
strcpy(CC->cs_clientname, "NNTP session");
return;
}
- /* Note: the FQDN *must* appear as the first thing after the 220 code.
- * Some clients (including citmail.c) depend on it being there.
- */
+ // Note: the FQDN *must* appear as the first thing after the 220 code.
+ // Some clients (including citmail.c) depend on it being there.
+ //
cprintf("200 %s NNTP Citadel server is not finished yet\r\n", config.c_fqdn);
}
-/*
- * NNTPS is just like NNTP, except it goes crypto right away.
- */
+//
+// NNTPS is just like NNTP, except it goes crypto right away.
+//
void nntps_greeting(void) {
CtdlModuleStartCryptoMsgs(NULL, NULL, NULL);
#ifdef HAVE_OPENSSL
-/*
- * implements the STARTTLS command
- */
+//
+// implements the STARTTLS command
+//
void nntp_starttls(void)
{
char ok_response[SIZ];
}
-void nntp_noop(void)
-{
- cprintf("250 NOOP\r\n");
-}
-
-
+//
+// Implements the CAPABILITY command
+//
void nntp_capabilities(void)
{
cprintf("101 Capability list:\r\n");
+ cprintf("IMPLEMENTATION Citadel v%d.%02d\r\n", (REV_LEVEL/100), (REV_LEVEL%100));
+ cprintf("VERSION 2\r\n");
+ cprintf("READER\r\n");
+ cprintf("MODE-READER\r\n");
+ cprintf("LIST ACTIVE NEWSGROUPS\r\n");
#ifdef HAVE_OPENSSL
cprintf("STARTTLS\r\n");
#endif
}
+//
+// Implements the QUIT command
+//
void nntp_quit(void)
{
cprintf("221 Goodbye...\r\n");
}
+//
+// Cleanup hook for this module
+//
void nntp_cleanup(void)
{
/* nothing here yet */
-/*
- * Implements the AUTHINFO USER command (RFC 4643)
- */
+//
+// Implements the AUTHINFO USER command (RFC 4643)
+//
void nntp_authinfo_user(const char *username)
{
int a = CtdlLoginExistingUser(NULL, username);
}
-/*
- * Implements the AUTHINFO PASS command (RFC 4643)
- */
+//
+// Implements the AUTHINFO PASS command (RFC 4643)
+//
void nntp_authinfo_pass(const char *buf)
{
int a;
-/*
- * Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
- */
+//
+// Implements the AUTHINFO extension (RFC 4643) in USER/PASS mode
+//
void nntp_authinfo(const char *cmd) {
if (!strncasecmp(cmd, "authinfo user ", 14)) {
}
-struct nntp_msglist {
- int num_msgs;
- long *msgnums;
-};
-
-
-/*
- * Utility function to fetch the current list of message numbers in a room
- */
+//
+// Utility function to fetch the current list of message numbers in a room
+//
struct nntp_msglist nntp_fetch_msglist(struct ctdlroom *qrbuf) {
struct nntp_msglist nm;
struct cdbdata *cdbfr;
+//
+// Various output formats for the LIST commands
+//
+enum {
+ NNTP_LIST_ACTIVE,
+ NNTP_LIST_ACTIVE_TIMES,
+ NNTP_LIST_DISTRIB_PATS,
+ NNTP_LIST_HEADERS,
+ NNTP_LIST_NEWSGROUPS,
+ NNTP_LIST_OVERVIEW_FMT
+};
-
-/* FIXME not finished need to add water marks
- */
-void output_roomname_in_list_active_format(struct ctdlroom *qrbuf) {
+//
+// Output a room name (newsgroup name) in formats required for LIST and NEWGROUPS command
+//
+void output_roomname_in_list_format(struct ctdlroom *qrbuf, int which_format, char *wildmat_pattern) {
char n_name[1024];
struct nntp_msglist nm;
long low_water_mark = 0;
long high_water_mark = 0;
room_to_newsgroup(n_name, qrbuf->QRname, sizeof n_name);
+
+ if ((wildmat_pattern != NULL) && (!IsEmptyStr(wildmat_pattern))) {
+ if (!wildmat(n_name, wildmat_pattern)) {
+ return;
+ }
+ }
+
nm = nntp_fetch_msglist(qrbuf);
if ((nm.num_msgs > 0) && (nm.msgnums != NULL)) {
low_water_mark = nm.msgnums[0];
high_water_mark = nm.msgnums[nm.num_msgs - 1];
}
- // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
- cprintf("%s %ld %ld n\r\n", n_name, low_water_mark, high_water_mark);
+ // Only the mandatory formats are supported
+ switch(which_format) {
+ case NNTP_LIST_ACTIVE:
+ // FIXME we have hardcoded "n" for "no posting allowed" -- fix when we add posting
+ cprintf("%s %ld %ld n\r\n", n_name, high_water_mark, low_water_mark);
+ break;
+ case NNTP_LIST_NEWSGROUPS:
+ cprintf("%s %s\r\n", n_name, qrbuf->QRname);
+ break;
+ }
+
if (nm.msgnums != NULL) {
free(nm.msgnums);
}
-/*
- */
+//
+// Called once per room by nntp_newgroups() to qualify and possibly output a single room
+//
void nntp_newgroups_backend(struct ctdlroom *qrbuf, void *data)
{
int ra;
if (ra & UA_KNOWN) {
if (qrbuf->QRgen >= thetime) {
- output_roomname_in_list_active_format(qrbuf);
+ output_roomname_in_list_format(qrbuf, NNTP_LIST_ACTIVE, NULL);
}
}
}
-/*
- * Implements the NEWGROUPS command
- */
+
+//
+// Implements the NEWGROUPS command
+//
void nntp_newgroups(const char *cmd) {
/*
* HACK: this works because the 5XX series error codes from citadel
}
-/*
- * Main command loop for NNTP server sessions.
- */
+//
+// Called once per room by nntp_list() to qualify and possibly output a single room
+//
+void nntp_list_backend(struct ctdlroom *qrbuf, void *data)
+{
+ int ra;
+ int view;
+ struct nntp_list_data *nld = (struct nntp_list_data *)data;
+
+ CtdlRoomAccess(qrbuf, &CC->user, &ra, &view);
+ if (ra & UA_KNOWN) {
+ output_roomname_in_list_format(qrbuf, nld->list_format, nld->wildmat_pattern);
+ }
+}
+
+
+//
+// Implements the LIST commands
+//
+void nntp_list(const char *cmd) {
+ //
+ // HACK: this works because the 5XX series error codes from citadel
+ // protocol will also be considered error codes by an NNTP client
+ //
+ if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
+
+ char list_format[64];
+ char wildmat_pattern[1024];
+ struct nntp_list_data nld;
+
+ extract_token(list_format, cmd, 1, ' ', sizeof list_format);
+ extract_token(wildmat_pattern, cmd, 2, ' ', sizeof wildmat_pattern);
+
+ if (strlen(wildmat_pattern) > 0) {
+ nld.wildmat_pattern = wildmat_pattern;
+ }
+ else {
+ nld.wildmat_pattern = NULL;
+ }
+
+ if ( (strlen(cmd) < 6) || (!strcasecmp(list_format, "ACTIVE")) ) {
+ nld.list_format = NNTP_LIST_ACTIVE;
+ }
+ else if (!strcasecmp(list_format, "NEWSGROUPS")) {
+ nld.list_format = NNTP_LIST_NEWSGROUPS;
+ }
+ else {
+ cprintf("501 syntax error , unsupported list format\r\n");
+ return;
+ }
+
+ cprintf("215 list of newsgroups follows\r\n");
+ CtdlGetUser(&CC->user, CC->curr_user);
+ CtdlForEachRoom(nntp_list_backend, &nld);
+ cprintf(".\r\n");
+}
+
+
+//
+// Implement HELP command.
+//
+void nntp_help(void) {
+ cprintf("100 This is the Citadel NNTP service.\r\n");
+ cprintf("RTFM http://www.ietf.org/rfc/rfc3977.txt\r\n");
+ cprintf(".\r\n");
+}
+
+
+//
+// back end for the LISTGROUP command , called for each message number
+//
+void nntp_listgroup_backend(long msgnum, void *userdata) {
+
+ struct listgroup_range *lr = (struct listgroup_range *)userdata;
+
+ // check range if supplied
+ if (msgnum < lr->lo) return;
+ if ((lr->hi != 0) && (msgnum > lr->hi)) return;
+
+ cprintf("%ld\r\n", msgnum);
+}
+
+
+//
+// Implements the GROUP and LISTGROUP commands
+//
+void nntp_group(const char *cmd) {
+ //
+ // HACK: this works because the 5XX series error codes from citadel
+ // protocol will also be considered error codes by an NNTP client
+ //
+ if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
+
+ char verb[16];
+ char requested_group[1024];
+ char message_range[256];
+ char range_lo[256];
+ char range_hi[256];
+ char requested_room[ROOMNAMELEN];
+ char augmented_roomname[ROOMNAMELEN];
+ int c = 0;
+ int ok = 0;
+ int ra = 0;
+ struct ctdlroom QRscratch;
+ int msgs, new;
+ long oldest,newest;
+ struct listgroup_range lr;
+
+ extract_token(verb, cmd, 0, ' ', sizeof verb);
+ extract_token(requested_group, cmd, 1, ' ', sizeof requested_group);
+ extract_token(message_range, cmd, 2, ' ', sizeof message_range);
+ extract_token(range_lo, message_range, 0, '-', sizeof range_lo);
+ extract_token(range_hi, message_range, 1, '-', sizeof range_hi);
+ lr.lo = atoi(range_lo);
+ lr.hi = atoi(range_hi);
+
+ /* In LISTGROUP mode we can specify an empty name for 'currently selected' */
+ if ((!strcasecmp(verb, "LISTGROUP")) && (IsEmptyStr(requested_group))) {
+ room_to_newsgroup(requested_group, CC->room.QRname, sizeof requested_group);
+ }
+
+ /* First try a regular match */
+ newsgroup_to_room(requested_room, requested_group, sizeof requested_room);
+ c = CtdlGetRoom(&QRscratch, requested_room);
+
+ /* Then try a mailbox name match */
+ if (c != 0) {
+ CtdlMailboxName(augmented_roomname, sizeof augmented_roomname, &CC->user, requested_room);
+ c = CtdlGetRoom(&QRscratch, augmented_roomname);
+ if (c == 0) {
+ safestrncpy(requested_room, augmented_roomname, sizeof(requested_room));
+ }
+ }
+
+ /* If the room exists, check security/access */
+ if (c == 0) {
+ /* See if there is an existing user/room relationship */
+ CtdlRoomAccess(&QRscratch, &CC->user, &ra, NULL);
+
+ /* normal clients have to pass through security */
+ if (ra & UA_KNOWN) {
+ ok = 1;
+ }
+ }
+
+ /* Fail here if no such room */
+ if (!ok) {
+ cprintf("411 no such newsgroup\r\n");
+ return;
+ }
+
+
+ /*
+ * CtdlUserGoto() formally takes us to the desired room, happily returning
+ * the number of messages and number of new messages.
+ */
+ memcpy(&CC->room, &QRscratch, sizeof(struct ctdlroom));
+ CtdlUserGoto(NULL, 0, 0, &msgs, &new, &oldest, &newest);
+ cprintf("211 %d %ld %ld %s\r\n", msgs, oldest, newest, requested_group);
+
+ // If this is a GROUP command, we can stop here.
+ if (!strcasecmp(verb, "GROUP")) {
+ return;
+ }
+
+ // If we get to this point we are running a LISTGROUP command. Fetch those message numbers.
+ CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, nntp_listgroup_backend, &lr);
+ cprintf(".\r\n");
+}
+
+
+//
+// Implements the MODE command
+//
+void nntp_mode(const char *cmd) {
+
+ char which_mode[16];
+
+ extract_token(which_mode, cmd, 1, ' ', sizeof which_mode);
+
+ if (!strcasecmp(which_mode, "reader")) {
+ cprintf("201 Reader mode FIXME implement posting and change to 200\r\n");
+ }
+ else {
+ cprintf("501 unknown mode\r\n");
+ }
+}
+
+
+
+//
+// Implements the ARTICLE, HEAD, BODY, and STAT commands.
+// (These commands all accept the same parameters; they differ only in how they output the retrieved message.)
+//
+void nntp_article(const char *cmd) {
+
+ // We're going to store one of these values in the variable 'acmd' so that
+ enum {
+ ARTICLE,
+ HEAD,
+ BODY,
+ STAT
+ };
+
+ char which_command[16];
+ int acmd = 0;
+ extract_token(which_command, cmd, 0, ' ', sizeof which_command);
+
+ if (!strcasecmp(which_command, "article")) {
+ acmd = ARTICLE;
+ }
+ else if (!strcasecmp(which_command, "head")) {
+ acmd = HEAD;
+ }
+ else if (!strcasecmp(which_command, "body")) {
+ acmd = BODY;
+ }
+ else if (!strcasecmp(which_command, "stat")) {
+ acmd = STAT;
+ }
+ else {
+ cprintf("500 I'm afraid I can't do that.\r\n");
+ return;
+ }
+
+ // Which NNTP command was issued, determines whether we will fetch headers, body, or both.
+ int headers_only = HEADERS_ALL;
+ if (acmd == HEAD) headers_only = HEADERS_FAST;
+ else if (acmd == BODY) headers_only = HEADERS_NONE;
+ else if (acmd == STAT) headers_only = HEADERS_FAST;
+
+ // now figure out what the client is asking for.
+ char requested_article[256];
+ long requested_msgnum = 0;
+ char *lb, *rb = NULL;
+ extract_token(requested_article, cmd, 1, ' ', sizeof requested_article);
+ lb = strchr(requested_article, '<');
+ rb = strchr(requested_article, '>');
+ requested_msgnum = atol(requested_article);
+
+ // If no article number or message-id is specified, the client wants the "next" article.
+ // We don't know how to do that yet.
+ if (IsEmptyStr(requested_article)) {
+ cprintf("500 FIXME I don't know how to fetch next yet.\r\n");
+ return;
+ }
+
+ // If the requested article is numeric, it maps directly to a message number. Good.
+ else if (requested_msgnum > 0) {
+ // good -- fall through and keep going
+ }
+
+ // If the requested article has angle brackets, the client wants a specific message-id.
+ // We don't know how to do that yet.
+ else if ( (lb != NULL) && (rb != NULL) && (lb < rb) ) {
+ cprintf("500 FIXME I don't know how to fetch by message-id yet.\r\n");
+ return;
+ }
+
+ // Anything else is noncompliant gobbledygook and should die in a car fire.
+ // Also, the weasel who is spreading untrue rumors about me at work should die in a slow and painful car fire.
+ else {
+ cprintf("500 syntax error\r\n");
+ return;
+ }
+
+ // At this point we know the message number of the "article" being requested.
+ // We have an awesome API call that does all the heavy lifting for us.
+ char *fetched_message_id = NULL;
+ CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
+ int fetch = CtdlOutputMsg(requested_msgnum,
+ MT_RFC822, // output in RFC822 format ... sort of
+ headers_only, // headers, body, or both?
+ 0, // don't do Citadel protocol responses
+ 1, // CRLF newlines
+ NULL, // teh whole thing, not just a section
+ 0, // no flags yet ... maybe new ones for Path: etc ?
+ NULL,
+ NULL,
+ &fetched_message_id // extract the message ID from the message as we go...
+ );
+ StrBuf *msgtext = CC->redirect_buffer;
+ CC->redirect_buffer = NULL;
+
+ if (fetch != om_ok) {
+ cprintf("423 no article with that number\r\n");
+ FreeStrBuf(&msgtext);
+ return;
+ }
+
+ if (acmd == ARTICLE) {
+ cprintf("220 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
+ }
+ if (acmd == HEAD) {
+ cprintf("221 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
+ }
+ if (acmd == BODY) {
+ cprintf("222 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
+ }
+ if (acmd == STAT) {
+ cprintf("223 %ld <%s>\r\n", requested_msgnum, fetched_message_id);
+ FreeStrBuf(&msgtext);
+ return;
+ }
+
+ client_write(SKEY(msgtext));
+ cprintf(".\r\n"); // this protocol uses a dot terminator
+ FreeStrBuf(&msgtext);
+ if (fetched_message_id) free(fetched_message_id);
+}
+
+
+//
+// Main command loop for NNTP server sessions.
+//
void nntp_command_loop(void)
{
StrBuf *Cmd = NewStrBuf();
FreeStrBuf(&Cmd);
return;
}
- syslog(LOG_DEBUG, "NNTP server: %s\n", ChrPtr(Cmd));
+ syslog(LOG_DEBUG, "NNTP: %s\n", ((!strncasecmp(ChrPtr(Cmd), "AUTHINFO", 8)) ? "AUTHINFO ..." : ChrPtr(Cmd)));
extract_token(cmdname, ChrPtr(Cmd), 0, ' ', sizeof cmdname);
- /*
- * Rumpelstiltskin lookups are awesome
- */
+ // Rumpelstiltskin lookups are *awesome*
if (!strcasecmp(cmdname, "quit")) {
nntp_quit();
}
+ else if (!strcasecmp(cmdname, "help")) {
+ nntp_help();
+ }
+
else if (!strcasecmp(cmdname, "capabilities")) {
nntp_capabilities();
}
nntp_starttls();
}
- else if (!strcasecmp(cmdname, "noop")) {
- nntp_noop();
- }
-
else if (!strcasecmp(cmdname, "authinfo")) {
nntp_authinfo(ChrPtr(Cmd));
}
nntp_newgroups(ChrPtr(Cmd));
}
+ else if (!strcasecmp(cmdname, "list")) {
+ nntp_list(ChrPtr(Cmd));
+ }
+
+ else if (!strcasecmp(cmdname, "group")) {
+ nntp_group(ChrPtr(Cmd));
+ }
+
+ else if (!strcasecmp(cmdname, "listgroup")) {
+ nntp_group(ChrPtr(Cmd));
+ }
+
+ else if (!strcasecmp(cmdname, "mode")) {
+ nntp_mode(ChrPtr(Cmd));
+ }
+
+ else if (
+ (!strcasecmp(cmdname, "article"))
+ || (!strcasecmp(cmdname, "head"))
+ || (!strcasecmp(cmdname, "body"))
+ || (!strcasecmp(cmdname, "stat"))
+ ) {
+ nntp_article(ChrPtr(Cmd));
+ }
+
else {
cprintf("500 I'm afraid I can't do that.\r\n");
}
}
-/*****************************************************************************/
-/* MODULE INITIALIZATION STUFF */
-/*****************************************************************************/
+// ****************************************************************************
+// MODULE INITIALIZATION STUFF
+// ****************************************************************************
-/*
- * This cleanup function blows away the temporary memory used by
- * the NNTP server.
- */
+//
+// This cleanup function blows away the temporary memory used by
+// the NNTP server.
+//
void nntp_cleanup_function(void)
{
/* Don't do this stuff if this is not an NNTP session! */
/* return our module name for the log */
return "nntp";
}
-