RServer Class Reference

Provides an interface to access news on a remote site. More...

#include <NServer.h>

Inheritance diagram for RServer:

List of all members.

Public Member Functions
	RServer (MPList *serverlist)
virtual	~RServer ()
void	setserverlist (MPList *serverlist)
MPList *	getserverlist (void)
virtual ActiveDB *	active ()
virtual GroupInfo *	groupinfo (const char *name)
virtual Newsgroup *	getgroup (const char *name)
virtual int	post (Article *article)
virtual void	listgroup (const char *gname, char *lstgrp, unsigned int f, unsigned int l)
virtual void	overviewdb (Newsgroup *ng, unsigned int fst, unsigned int lst)
virtual void	article (const char *gname, unsigned int nb, Article *artr)
virtual void	article (const char *id, Article *art)
Protected Member Functions
	RServer ()
void	init (MPList *serverlist)
void	connect ()
void	disconnect ()
	Disconnect from the current news server.
std::string	issue (const char *command, const char *expresp=NULL)
void	setserver (MPListEntry *server)
int	is_connected ()
void	selectgroup (const char *name, int force=0)
Protected Attributes
MPList *	_ServerList
MPListEntry *	_CurrentServer
GroupInfo	_CurrentGroup
sstream *	_pServerStream
Private Member Functions
void	post (MPListEntry *srvr, Article *article)

---

Detailed Description

Provides an interface to access news on a remote site.

Author:

Thomas Gschwind

Definition at line 205 of file NServer.h.

---

Constructor & Destructor Documentation

RServer::RServer (   )  [inline, protected]

Definition at line 243 of file NServer.h. References _CurrentServer, _pServerStream, and _ServerList. :NServer() { _ServerList = NULL; _CurrentServer = NULL; _pServerStream = NULL; } void init(MPList * serverlist);

RServer::RServer (  MPList *  serverlist  )

Initialize the new RServer class. Sets up the server list and the default number of retries. Parameters: serverlist  list of news server and their newsgroups Definition at line 197 of file NServer.cc. References init(), Logger::p(), slog, and VERB. { VERB(slog.p(Logger::Debug) << "RServer::RServer/1\n"); init(serverlist); }

RServer::~RServer (   )  [virtual]

Definition at line 203 of file NServer.cc. References Logger::p(), setserverlist(), slog, and VERB. { VERB(slog.p(Logger::Debug) << "RServer::~RServer()\n"); setserverlist(NULL); }

---

Member Function Documentation

ActiveDB * RServer::active (   )  [virtual]

Retrieves the active database from the news servers and returns a pointer to it. If an error occurs while retrieving the database from a server, the active database will not be retrieved from this server. Note: The offline stuff does not belong to the RServer. Thus it should be moved into the CServer. Setting up all of this filter expressions can be done at the server-list's creation time. However, at the moment this is neglectable. The active database is retrieved rather seldom and takes a long time nevertheless. Returns: Pointer to the active database. Implements NServer. Reimplemented in CServer. Definition at line 575 of file NServer.cc. References _CurrentServer, _pServerStream, _ServerList, ASSERT, connect(), Logger::Error, ERROR_LOCATION, issue(), MAXGROUPNAMELEN, MPListEntry::nntpflags, Logger::p(), Logger::print(), ActiveDB::read(), MPListEntry::read, setserver(), slog, and VERB. Referenced by CServer::active(). { VERB(slog.p(Logger::Debug) << "RServer::active()\n"); unsigned int i, flags; char cgroup[MAXGROUPNAMELEN + 1], *cgp, buf[1024]; const char *sp; char c; ASSERT(if (!_ServerList) { throw AssertionError ("RServer::active: _ServerList is a null-pointer", ERROR_LOCATION);} ); for (i = 0; i < _ServerList->entries.size(); i++) { if (!_ServerList->entries[i].hostname[0]) continue; // Connect to ith news server try { setserver(&(_ServerList->entries[i])); if (_CurrentServer-> flags & (MPListEntry::F_OFFLINE | MPListEntry:: F_SEMIOFFLINE)) continue; flags = ((_CurrentServer-> nntpflags & MPListEntry::F_POST) || !(_CurrentServer-> flags & MPListEntry:: F_SETPOSTFLAG)) ? 0 : ActiveDB:: F_STORE_READONLY; connect(); if (_CurrentServer-> nntpflags & MPListEntry:: F_LIST_ACTIVE_WILDMAT) { try { sp = _CurrentServer->read; do { // Extract a newsgroup-expression cgp = cgroup; while ((c = *sp++) != ',' && c) *cgp++ = c; *cgp = '\0'; sprintf(buf, "list active %s\r\n", cgroup); issue(buf, "215"); // read active database and filter unwanted groups _ActiveDB-> read(*_pServerStream, _ServerList-> makeFilter(i, cgroup), flags); } while (c); } catch(ResponseError & re) { slog.p(Logger::Notice) << "list active [wildmat] failed for " << _ServerList->entries[i]. hostname << ":" << _ServerList->entries[i]. servicename << "\n"; _CurrentServer->nntpflags &= ~MPListEntry:: F_LIST_ACTIVE_WILDMAT; } } if (! (_CurrentServer-> nntpflags & MPListEntry:: F_LIST_ACTIVE_WILDMAT)) { issue("list active\r\n", "215"); _ActiveDB->read(*_pServerStream, _ServerList->makeFilter(i, "*"), flags); } } catch(ResponseError & re) { slog.p(Logger::Error) << "retrieval of activedb failed for " << _ServerList->entries[i].hostname << ":" << _ServerList->entries[i].servicename << "\n"; } catch(SystemError & se) { slog.p(Logger::Warning) << "connection to " << _ServerList->entries[i].hostname << ":" << _ServerList->entries[i]. servicename << " failed\n"; } catch(Error & e) { slog.p(Logger::Alert) << "UNEXPECTED EXCEPTION WHILE RETRIEVING ACTIVEDB FROM " << _ServerList->entries[i]. hostname << ":" << _ServerList->entries[i]. servicename << "\nPLEASE REPORT TO h.straub@aon.at\n"; e.print(); } } return _ActiveDB; }

void RServer::article (  const char *  id, Article *  art )  [virtual]

Return a given article of a given newsgroup Note: Article nbr: 220 success 412 no group sel 420 no art sel 423 art nbr not found in grp 430 no such art found Returns: Pointer to an article, this has to be freed by the user. Exceptions: SystemError  If the connection to the news server fails. NoNewsServerError  If no news server is configured for this group. NoSuchGroupError  If the group does not exist. NoSuchArticleError  If the requested article does not exist. ResponseError  If the news server replies an invalid response code. Bug: Description and Code (Parameters) not synchronized. Todo: Synchronize Description and Code (Parameters). Reimplemented in CServer. Definition at line 834 of file NServer.cc. References _CurrentServer, _pServerStream, _ServerList, connect(), MPList::entries, ERROR_LOCATION, issue(), Logger::p(), Article::read(), Article::setnbr(), setserver(), slog, and VERB. { VERB(slog.p(Logger::Debug) << "RServer::article(" << id << ")\n"); char buf[1024]; const char *p; string resp; sprintf(buf, "article %s\r\n", id); if (_CurrentServer) { resp = issue(buf, NULL); p = resp.c_str(); if (strncmp(p, "220", 3) == 0) { art->read(*_pServerStream); art->setnbr(-1); return; } // 412 cannot happen since we specified the article id // 420 -"- since we specified the article id // 423 -"- since we specified the article id, not the art nbr if (strncmp(p, "430", 3) != 0) { slog.p(Logger::Notice) << "illegal response code to <artcile <id>> request\n" << p; } } // check whether the article can be found at one of the other // news servers MPListEntry *cs = _CurrentServer; for (unsigned int i = 0; i < _ServerList->entries.size(); i++) { if (cs == &(_ServerList->entries[i]) || !_ServerList->entries[i].hostname[0]) continue; setserver(&(_ServerList->entries[i])); connect(); resp = issue(buf, NULL); p = resp.c_str(); if (strncmp(p, "220", 3) == 0) { art->read(*_pServerStream); art->setnbr(-1); return; } if (strncmp(p, "430", 3) != 0) { slog.p(Logger::Notice) << "illegal response code to <artcile <id>> request\n" << p; } } throw NoSuchArticleError(resp, ERROR_LOCATION); }

void RServer::article (  const char *  gname, unsigned int  nb, Article *  artr )  [virtual]

Return a given article of a given newsgroup Note: Article nbr: 220 success 412 no group sel 420 no art sel 423 art nbr not found in grp 430 no such art found Parameters: gname  Name of the newsgroup. nb  Number of the article. Returns: Pointer to an article, this has to be freed by the user. Exceptions: SystemError  If the connection to the news server fails. NoNewsServerError  If no news server is configured for this group. NoSuchGroupError  If the group does not exist. NoSuchArticleError  If the requested article does not exist. ResponseError  If the news server replies an invalid response code. Bug: Description and Code (Parameters) not synchronized. Todo: Synchronize Description and Code (Parameters). Reimplemented in CServer. Definition at line 809 of file NServer.cc. References _pServerStream, ERROR_LOCATION, issue(), Logger::p(), Article::read(), selectgroup(), Article::setnbr(), slog, and VERB. Referenced by CServer::article(), RNewsgroup::getarticle(), RNewsgroup::printarticle(), and CNewsgroup::retrievearticle(). { VERB(slog.p(Logger::Debug) << "RServer::article(" << nbr << ")\n"); char buf[513]; const char *p; string resp; selectgroup(gname); sprintf(buf, "article %u\r\n", nbr); resp = issue(buf, NULL); p = resp.c_str(); if (strncmp(p, "220", 3) != 0) { // 412 cannot happen since we have already selected the newsgroup // 420 -"- since we specified the article nbr // 430 -"- since we specified the article nbr, not the art-id if (strncmp(p, "423", 3) == 0) throw NoSuchArticleError(resp, ERROR_LOCATION); string c(buf), e("220"); throw ResponseError(c, e, resp); } art->read(*_pServerStream); art->setnbr(nbr); }

void RServer::connect (   )  [protected]

Connect to the news server. Stores whether posting is allowed in _CurrentServer->flags. Exceptions: SystemError  ... Thrown, if a system error (eg. cannot connect) occurs after _Retries successive connection-failures. ResponseError  ... Thrown, if the news server returns a response code different from the allowed connection setup return codes. 200 ... reading and posting allowed 201 ... reading allowed NoNewsServerError  If no news server is configured for this group (in theory, this should be impossible) NoSuchGroupError  If the group does not exist Todo: RECONNECT/RETRY (see source code) Definition at line 233 of file NServer.cc. References _CurrentGroup, _CurrentServer, _pServerStream, MPListEntry::bindFrom, sstream::connectTo(), ERROR_LOCATION, MPListEntry::hostname, is_connected(), issue(), GroupInfo::name(), nlreadline(), MPListEntry::nntpflags, Logger::p(), MPListEntry::passwd, OverviewFmt::readxoin(), MPListEntry::retries, RSERVER_CONNECT_CHECK_CONNECTION, selectgroup(), MPListEntry::servicename, slog, MPListEntry::user, and VERB. Referenced by active(), CServer::article(), article(), issue(), and post(). { VERB(slog.p(Logger::Debug) << "RServer::connect()\n"); if (is_connected()) return; string grt, resp; char buf[1024]; int i = _CurrentServer->retries; _pServerStream = new sstream; for (;;) { // Open connection if (strcmp(_CurrentServer->bindFrom, "") == 0) { slog. p(Logger:: Debug) << "RServer::connect: Connecting to " << _CurrentServer-> hostname << " from DEFAULT interface to servicename " << _CurrentServer->servicename << "\n"; _pServerStream->connectTo(_CurrentServer->hostname, _CurrentServer-> servicename); } else { slog. p(Logger:: Debug) << "RServer::connect: Connecting to " << _CurrentServer-> hostname << " from interface " << _CurrentServer-> bindFrom << " to servicename " << _CurrentServer->servicename << "\n"; _pServerStream->connectTo(_CurrentServer->hostname, _CurrentServer-> servicename, _CurrentServer-> bindFrom); } if (!_pServerStream->good()) { delete _pServerStream; _pServerStream = NULL; throw SystemError ("RServer::connect: cannot connect to news server", errno, ERROR_LOCATION); } _pServerStream->unsetf(ios::skipws); //FIXME! repl nlreadline by nntpreadline that transparently //FIXME! provides auth? use a authenticator callback class, that //FIXME! supplies all the negotiation between client/server. Will //FIXME! get a server and a client handle as well as server and //FIXME! groupname to send correct passwd to correct server/group //FIXME! RECONNECT/RETRY? HOW IMPLEMENT? What happens if module //FIXME! cannot handle this?!? nlreadline(*_pServerStream, grt, 0); slog.p(Logger::Info) << grt << "\n"; RSERVER_CONNECT_CHECK_CONNECTION ("Connection to %s:%s failed"); if (grt[0] != '2' || grt[1] != '0' || (grt[2] != '0' && grt[2] != '1')) { string c("_connect_"), e("20[01]"); delete _pServerStream; _pServerStream = NULL; throw ResponseError(c, e, grt); } if (_CurrentServer->user[0]) { sprintf(buf, "authinfo user %s\r\n", _CurrentServer->user); resp = issue(buf, NULL); if (resp[0] == '3') { sprintf(buf, "authinfo pass %s\r\n", _CurrentServer->passwd); resp = issue(buf, NULL); } if (resp[0] != '2') { string c("_authenticate_"), e("[23].."); delete _pServerStream; _pServerStream = NULL; throw ResponseError(c, e, resp); } } if (_CurrentServer->nntpflags & MPListEntry::F_MODE_READER) { // mode reader resp = issue("mode reader\r\n", NULL); RSERVER_CONNECT_CHECK_CONNECTION ("Cannot read data from %s:%s"); if (resp[0] != '2' || resp[1] != '0' || (resp[2] != '0' && resp[2] != '1')) { slog. p(Logger:: Warning) << "mode reader failed, ignored\n"; _CurrentServer->nntpflags &= ~MPListEntry::F_MODE_READER; } grt = resp; } if (grt[2] == '1') { _CurrentServer->nntpflags &= ~MPListEntry::F_POST; } if (_CurrentServer-> nntpflags & MPListEntry::F_LIST_OVERVIEW_FMT) { resp = issue("list overview.fmt\r\n", "215"); _OverviewFormat->readxoin(*_pServerStream); if (resp[0] != '2' || resp[1] != '1' || resp[2] != '5') { slog. p(Logger:: Warning) << "list overview.fmt failed, ignored\n"; _CurrentServer->nntpflags &= ~MPListEntry::F_LIST_OVERVIEW_FMT; goto rserver__connect_no_list_overview_fmt; } } else { rserver__connect_no_list_overview_fmt: #ifdef HAVE_SSTREAM istringstream standardOverviewFmt #else istrstream standardOverviewFmt #endif ("Subject:\nFrom:\nDate:\nMessage-ID:\nReferences:\nBytes:\nLines:\n"); _OverviewFormat->readxoin(standardOverviewFmt); } if (_CurrentGroup.name()[0] != '\0') { selectgroup(_CurrentGroup.name(), 1); } return; } }

void RServer::disconnect (   )  [protected]

Disconnect from the current news server. Definition at line 373 of file NServer.cc. References _pServerStream, Logger::p(), slog, and VERB. Referenced by issue(), post(), setserver(), and setserverlist(). { VERB(slog.p(Logger::Debug) << "RServer::disconnect()\n"); if (_pServerStream != NULL) { *_pServerStream << "quit\r\n"; // Who is interested in this return code? delete _pServerStream; _pServerStream = NULL; } }

Newsgroup * RServer::getgroup (  const char *  name  )  [virtual]

Return the newsgroup with name >name<. If the newsgroup does not exist, NULL will be returned. Parameters: name  Name of the newsgroup. Returns: Pointer to a Newsgroup structure. Free it by calling the freegroup method. The newsgroup must destructed by the same Server-instance it was constructed from. Exceptions: NoNewsServerError  If no news server is configured for this group. NoSuchGroupError  If the group does not exist. ResponseError  If the news server replies an invalid response code. SystemError  ... if the connection to the news server fails. Implements NServer. Reimplemented in CServer. Definition at line 707 of file NServer.cc. References _CurrentGroup, GroupInfo::first(), GroupInfo::last(), selectgroup(), RNewsgroup::setsize(), slog, and VERB. { VERB(slog. p(Logger::Debug) << "RServer::getgroup(" << name << ")\n"); selectgroup(name); RNewsgroup *grp = new RNewsgroup(this, _OverviewFormat, name); grp->setsize(_CurrentGroup.first(), _CurrentGroup.last()); return grp; }

MPList* RServer::getserverlist (  void   )  [inline]

Return the currently installed list of news servers. Returns: The server-list. Definition at line 336 of file NServer.h. References _ServerList. { return _ServerList; }

GroupInfo * RServer::groupinfo (  const char *  name  )  [virtual]

Returns the GroupInfo object of a given newsgroup. Parameters: name  The name of newsgroup. Returns: Returns informations of the newsgroup in a statically allocated GroupInfo structure. Exceptions: SystemError  If the connection to the news server fails NoSuchGroupError  If the group does not exist, or no news server has been configured for this group. ResponseError  If the news server replies an invalid response code. Implements NServer. Reimplemented in CServer. Definition at line 685 of file NServer.cc. References _CurrentGroup, ASSERT, ERROR_LOCATION, ActiveDB::get(), selectgroup(), slog, and VERB. Referenced by CNewsgroup::sUpdateGroupInfo(). { VERB(slog. p(Logger::Debug) << "RServer::groupinfo(" << name << ")\n"); static GroupInfo agroup; ASSERT(if (strlen(name) > 510) { throw AssertionError ("RServer::groupinfo: name of newsgroup too long\n", ERROR_LOCATION);} ); // If the newsgroup cannot be found within the active database // reload the database from the news server and try again. if (_ActiveDB->get(name, &agroup) < 0) { selectgroup(name, 1); agroup = _CurrentGroup; } return &agroup; }

void RServer::init (  MPList *  serverlist  )  [protected]

Definition at line 209 of file NServer.cc. References _CurrentServer, _ServerList, Logger::p(), slog, and VERB. Referenced by CServer::CServer(), and RServer(). { VERB(slog.p(Logger::Debug) << "RServer::init/1\n"); _ServerList = serverlist; _CurrentServer = NULL; if (!_OverviewFormat) _OverviewFormat = new OverviewFmt(); if (!_ActiveDB) _ActiveDB = NULL; }

int RServer::is_connected (   )  [inline, protected]

Definition at line 296 of file NServer.h. References _pServerStream. Referenced by connect(), and issue(). { return (_pServerStream != NULL) ? 1 : 0; }

string RServer::issue (  const char *  command, const char *  expresp = NULL )  [protected]

Send a command to the remote news server and return its response. Parameters: command  Command that should be sent to the news server expresp  ... Expected response code. If omitted, any response code will do. Should be checked by the caller in this case. Returns: static string holding the news server's response. Exceptions: SystemError  If the connection fails ResponseError  If the server returns an illegal response code NoNewsServerError  ... if no news server is configured for the current group. NoSuchGroupError  If the group does not exist. Definition at line 384 of file NServer.cc. References _CurrentServer, _pServerStream, connect(), disconnect(), ERROR_LOCATION, is_connected(), nlreadline(), Logger::p(), MPListEntry::retries, and slog. Referenced by active(), CServer::article(), article(), connect(), listgroup(), overviewdb(), post(), and selectgroup(). { string req, resp; int rs; int i = _CurrentServer->retries + 1; req = "issue "; req.append(command, strlen(command) - 2); req.append("\n"); slog.p(Logger::Info) << "RServer::issue: " << req.c_str(); if (!is_connected()) connect(); // Send command for (;;) { try { *_pServerStream << command << flush; } catch(...) { slog. p(Logger:: Error) << "RServer::issue: error in command sending, good: " << _pServerStream->good() << "\n"; } try { rs = nlreadline(*_pServerStream, resp, 0); } catch(...) { slog. p(Logger:: Error) << "RServer::issue: error in command readline\n"; } // If the remote server closed the connection (400), reconnect if (!_pServerStream->good()) { slog. p(Logger:: Warning) << "RServer::issue: no connection to news server\n"; } else if (strncmp(resp.c_str(), "400", 3) == 0 || strncmp(resp.c_str(), "503", 3) == 0) { slog. p(Logger:: Warning) << "RServer::issue: server closed connection---reconnecting\n"; } /* else if(strncmp(resp.c_str(),"480",3)==0) { slog.p(Logger::Warning) << "server requests authentication\n"; req="authinfo user "; req.append(_CurrentServer->Username); slog.p(Logger::Debug) << req.c_str(); req.append("\r\n"); _ServerStream << req; rs=nlreadline(_ServerStream,resp,0); } */ else { break; } // If we have lost the connection to the news server, we try // to reconnect to the server and reissue the command. for (;;) { i--; if (i == 0) throw SystemError ("maximum number of retries reached", -1, ERROR_LOCATION); disconnect(); try { connect(); break; } catch(SystemError & se) { } } } // Check the response code if ((rs < 3) || (expresp && strncmp(expresp, resp.data(), strlen(expresp)))) { string c(command), e(expresp); throw ResponseError(c, e, resp); } return resp; }

void RServer::listgroup (  const char *  gname, char *  lstgrp, unsigned int  f, unsigned int  l )  [virtual]

Return a list of article available in a newsgroup. Parameters: gname  Name of the newsgroup. lstgrp  Pointer to a preallocated array, where the list is stored. lstgrpsz  Size of the array above. Exceptions: SystemError  If the connection to the news server fails. NoNewsServerError  If no news server is configured for this group. NoSuchGroupError  If the group does not exist. ResponseError  If the news server replies an invalid response code. Reimplemented in CServer. Definition at line 718 of file NServer.cc. References _pServerStream, ERROR_LOCATION, issue(), nlreadline(), NNTP_ISCODE, selectgroup(), slog, and VERB. Referenced by CServer::listgroup(), and CNewsgroup::listgroup(). { VERB(slog. p(Logger:: Debug) << "RServer::listgroup(" << gname << ",...)\n"); const char *p; unsigned int i; string resp, line; selectgroup(gname); resp = issue("listgroup\r\n", NULL); p = resp.c_str(); if (!NNTP_ISCODE(p, "211")) { string c("listgroup\r\n"), e("211"); throw ResponseError(c, e, resp); } for (;;) { nlreadline(*_pServerStream, line); if (line == ".\r\n") break; if (!_pServerStream->good()) throw SystemError("error while reading from server", errno, ERROR_LOCATION); i = atoi(line.data()); if (f <= i && i <= l) lstgrp[i - f] = 1; } }

void RServer::overviewdb (  Newsgroup *  ng, unsigned int  fst, unsigned int  lst )  [virtual]

Return the overviewdatabase of the newsgroup >ng<. This function should not be called by the user. Instead it should be called via a Newsgroup object. Parameters: name  Name of the newsgroup. Exceptions: SystemError  If the connection to the news server fails. NoNewsServerError  If no news server is configured for this group. NoSuchGroupError  If the group does not exist. ResponseError  If the news server replies an invalid response code. NotAllowedError  If retrieving the overviewdb is prohibited. NSError  If news server does not implement over and xover. Reimplemented in CServer. Definition at line 750 of file NServer.cc. References _CurrentServer, _pServerStream, ASSERT, ERROR_LOCATION, issue(), NNTP_ISCODE, MPListEntry::nntpflags, Logger::p(), selectgroup(), slog, and VERB. Referenced by CServer::overviewdb(), RNewsgroup::setsize(), and CNewsgroup::sUpdateOverview(). { VERB(slog.p(Logger::Debug) << "RServer::overviewdb(*ng," << fst << "-" << lst << ")\n"); ASSERT(if (!ng) { throw AssertionError ("RServer::overviewdb: ng parameter is a null-pointer", ERROR_LOCATION);} ); char buf[513]; string resp; const char *p; const char *fmt = "over %d-%d\r\n"; selectgroup(ng->name()); for (;;) { if (!(_CurrentServer->nntpflags & MPListEntry::F_OVER)) fmt = "xover %d-%d\r\n"; if (!(_CurrentServer->nntpflags & MPListEntry::F_XOVER)) { slog. p(Logger:: Critical) << "remote news server neither implements OVER nor XOVER\n"; throw NSError ("news server neither implements OVER nor XOVER", ERROR_LOCATION); } sprintf(buf, fmt, fst, lst); resp = issue(buf, NULL); p = resp.c_str(); if (NNTP_ISCODE(p, "224")) { ng->readoverdb(*_pServerStream); return; } if (NNTP_ISCODE(p, "502")) { throw NotAllowedError(resp, ERROR_LOCATION); } if (NNTP_ISCODE(p, "412")) { slog. p(Logger:: Warning) << "newsgroup disappeared while working on it\n"; throw NoSuchGroupError("no such group", ERROR_LOCATION); } if (NNTP_ISCODE(p, "420")) throw ResponseError(buf, "224", resp); if (fmt[0] == 'o') _CurrentServer->nntpflags &= ~MPListEntry::F_OVER; else _CurrentServer->nntpflags &= ~MPListEntry::F_XOVER; } }

int RServer::post (  Article *  article  )  [virtual]

Post an article. Todo: A per server result code should be returned. We should use the path field here, or introduce a new field that shows the cache-posting-chain (see SourceCode). Parameters: article  The article to be posted Returns: 0 if the article has been posted successfully -1 spooling of article is necessary -2 article could be posted to some of the news servers Exceptions: InvalidArticleError  If the article is not correctly formated. Implements NServer. Reimplemented in CServer. Definition at line 976 of file NServer.cc. References _ServerList, MPList::entries, ERROR_LOCATION, MPListEntry::flags, Article::getfield(), Article::has_field(), newsgroups, nntp_hostname, nntp_posting_host, Logger::p(), post(), MPList::postserver(), Article::setfield(), slog, TOBASE36, and VERB. { VERB(slog.p(Logger::Debug) << "RServer::post(Article)\n"); // do some sanity checks string newsgroups; try { if (!article->has_field("from:")) throw InvalidArticleError("no from field", ERROR_LOCATION); if (!article->has_field("subject:")) throw InvalidArticleError("no subject field", ERROR_LOCATION); newsgroups = article->getfield("newsgroups:"); } catch(NoSuchFieldError & n) { throw InvalidArticleError("no newsgroups field", ERROR_LOCATION); } static int pc = 1; const char *p, *q; string cgroup; char buf[MAXHOSTNAMELEN + 256]; char msgid[MAXHOSTNAMELEN + 256]; MPListEntry **mpe; MPListEntry *c; int sc = 0, i; //FIXME! We should use the path field here, or introduce a //FIXME! new field that shows the cache-posting-chain if (nntp_posting_host[0]) { sprintf(buf, "X-NNTP-Posting-Host: %s\r\n", nntp_posting_host); article->setfield("X-NNTP-Posting-Host:", buf); } if (!article->has_field("message-id:")) { struct timeval tv; int j; char mid[768]; char *p; p = mid; gettimeofday(&tv, NULL); TOBASE36(i, tv.tv_sec, p); *p++ = '$'; j = getpid(); TOBASE36(i, j, p); *p++ = '$'; TOBASE36(i, pc, p); *p++ = '@'; strcpy(p, nntp_hostname); pc++; sprintf(msgid, "Message-ID: <newscache$%s>\r\n", mid); article->setfield("Message-ID:", msgid); } if ((mpe = (MPListEntry **) malloc(_ServerList->entries.size() * sizeof(MPListEntry *))) == NULL) { throw SystemError("cannot allocate buffer for post servers", errno, ERROR_LOCATION); } q = newsgroups.c_str(); while (isspace(*q) || *q == ',') q++; do { p = q; while (*q && *q != ',' && !isspace(*q)) q++; cgroup.assign(p, q - p); c = _ServerList->postserver(cgroup.c_str()); if (c) { i = 0; while (i < sc && c != mpe[i]) i++; if (i == sc) { mpe[sc] = c; sc++; } } else { slog.p(Logger::Info) << "posting to unknown newsgroup: " << cgroup << "\n"; } while (isspace(*q) || *q == ',') q++; } while (*q); if (!sc) { slog.p(Logger::Info) << "no news server configured for " << msgid << "\n"; free(mpe); throw InvalidArticleError("no valid newsgroup", ERROR_LOCATION); } int posts = 0, spool = 0, err = 0; i = 0; // Error classification: // * Duplicate Articles ... Since we use our hostname and people should // be forbidden to use wrong hostnames, we assume that a duplicate // article means that the article arrived already somehow on that // server. // * NotAllowed ... user wants to post to a private newsgroup // * PostingFailed ... user submitted badly formatted article // * Response, System ... problem on remote site occurred // //FIX! If this library should be used for other purposes than just //FIX! for NewsCache, errors should be resolved using a callback //FIX! class! do { try { if (mpe[i]->flags & MPListEntry::F_OFFLINE) { ++spool; } else { post(mpe[i], article); ++posts; } } catch(DuplicateArticleError & dae) { ++posts; } catch(NotAllowedError & nae) { err |= 1; } catch(PostingFailedError & pfe) { err |= 2; } catch(ResponseError & re) { ++spool; } catch(SystemError & se) { ++spool; } catch(Error & e) { err |= 4; } ++i; } while (i < sc); free(mpe); if (!err) return spool ? -1 : 0; if (err && !posts) { throw InvalidArticleError ("illegaly formatted article or no post permission", ERROR_LOCATION); } // Hm, on some news servers posting succeeded on others not. // What should we do now? Spool it to the error-log? //FIXME! Report posting as OK and send mail to posting indicating the //FIXME! failure. return -2; }

void RServer::post (  MPListEntry *  srvr, Article *  article )  [private]

Note: The news server, where the article should be posted, should be taken from the article's newsgroup field. An article posted to comp.os.linux should be posted to the news server from where we receive this newsgroup. POST: 240 post ok 340 send art 440 not allowed 441 post failed Parameters: srvr  News server the article should be posted to. article  The article to be posted. Exceptions: SystemError  If the connection to the news server fails. ResponseError  If the news server replies an invalid response code. NotAllowedError  If posting is prohibited. NoNewsServerError  If no news server is configured for this group (in theory, this should be impossible). DuplicateArticleError  The message id exists already on the news server. PostingFailedError  The server returned 441 ... NoSuchGroupError  If the group does not exist (no group selected). Semantically Impossible Exceptions. Definition at line 887 of file NServer.cc. References _CurrentServer, _pServerStream, connect(), disconnect(), ERROR_LOCATION, Article::getfield(), MPListEntry::hostname, issue(), nlreadline(), Logger::p(), MPListEntry::retries, MPListEntry::servicename, setserver(), slog, and VERB. Referenced by CServer::post(), post(), and CServer::postspooled(). { string resp; const char *p; char buf[513]; VERB(slog.p(Logger::Debug) << "RServer::post({" << srvr->hostname << "," << srvr->servicename << "}\n"); setserver(srvr); // clears current group selection connect(); // Before posting an article, we should check whether the article // exists already on the upstream news server. (Since the post // command does not indicate duplicates, we have to check this // manually beforehand. try { resp = article->getfield("message-id:"); sprintf(buf, "stat %s\r\n", resp.c_str()); resp = issue(buf, NULL); p = resp.c_str(); if (strncmp(p, "223", 3) == 0) throw DuplicateArticleError("Response 223", ERROR_LOCATION); else if (strncmp(p, "430", 3) != 0) { string c(buf), e("223|430"); throw ResponseError(c, e, resp); } } catch(NoSuchFieldError e) { VERB(slog. p(Logger:: Debug) << "RServer::post message-id not found\n"); } for (int i = _CurrentServer->retries + 1;;) { resp = issue("post\r\n", NULL); p = resp.c_str(); if (strncmp(p, "340", 3) != 0) { if (strncmp(p, "440", 3) == 0) throw NotAllowedError(resp, ERROR_LOCATION); throw ResponseError("post\r\n", "[34]40", resp); } *_pServerStream << *article << ".\r\n" << flush; nlreadline(*_pServerStream, resp); if (_pServerStream->good()) break; // If we have lost the connection to the news server, we try // to reconnect to the server and reissue the command. slog. p(Logger:: Warning) << "lost connection to news server unexpectedly\n"; for (;;) { i--; if (i == 0) throw SystemError ("maximum number of retries reached while trying to post an article", -1, ERROR_LOCATION); disconnect(); try { connect(); break; } catch(SystemError & se) { } } } p = resp.c_str(); if (strncmp("240", p, 3) != 0) { if (strncmp("440", p, 3) == 0) throw NotAllowedError(resp, ERROR_LOCATION); if (strncmp("441", p, 3) == 0) throw PostingFailedError(resp, ERROR_LOCATION); throw ResponseError("post\r\n", "[23]40,44[01]", resp); } }

void RServer::selectgroup (  const char *  name, int  force = 0 )  [protected]

Select a newsgroup on the remote news server. Remarks: group: 211 nflsg selected 411 no group Parameters: name  Name of the newsgroup Exceptions: SystemError  If the connection to the news server fails NoSuchGroupError  ... if the group does not exist, or no news server has been configured for this group. ResponseError  If the news server replies an invalid response code Definition at line 489 of file NServer.cc. References _CurrentGroup, _ServerList, ASSERT, Logger::Error, ERROR_LOCATION, ActiveDB::get(), issue(), GroupInfo::name(), NNTP_ISCODE, Logger::p(), MPList::server(), ActiveDB::set(), GroupInfo::set(), setserver(), slog, and VERB. Referenced by article(), connect(), getgroup(), CServer::groupinfo(), groupinfo(), listgroup(), and overviewdb(). { VERB(slog. p(Logger::Debug) << "RServer::selectgroup(" << name << ")\n"); ASSERT(if (strlen(name) > 512) { throw AssertionError ("RServer::selectgroup: name of newsgroup too long\n", ERROR_LOCATION);} ); if (!force && strcmp(_CurrentGroup.name(), name) == 0) return; char buf[MAXPATHLEN]; const char *ep, *p; int nbr, fst, lst; MPListEntry *mpe; string resp; // Find the server responsible for this newsgroup if ((mpe = _ServerList->server(name)) == NULL) { throw NoSuchGroupError("no such group", ERROR_LOCATION); } setserver(mpe); sprintf(buf, "group %s\r\n", name); resp = issue(buf, NULL); p = resp.c_str(); if (!NNTP_ISCODE(p, "211")) { if (NNTP_ISCODE(p, "411")) throw NoSuchGroupError("no such group", ERROR_LOCATION); string c(buf), e("211"); throw ResponseError(c, e, resp); } p += 3; nbr = strtol(p, (char **) &p, 10); fst = strtol(p, (char **) &p, 10); lst = strtol(p, (char **) &ep, 10); if (ep == resp) { //THROW!?! _Response_should_be_ // 211 $n $f $l $g selected // $n Nbr. of articles in group // $f Nbr. of first article // $l Nbr. of last article // $g Name of newsgroup slog.p(Logger::Error) << "response from news server not in >>211 n f l g ...<< format\n"; // If we cannot parse the response code, use the first/last number // and number of articles from the active database if (_ActiveDB->get(name, &_CurrentGroup) < 0) { // If the above call fails, _ActiveDB will be updated with a // probably inconsistent posting flag ('y') _CurrentGroup.set(name, 0, 0, 0); _ActiveDB->set(_CurrentGroup); } } else { _ActiveDB->get(name, &_CurrentGroup); // If the above call fails, _ActiveDB will be updated with a // probably inconsistent posting flag ('y') _CurrentGroup.set(name, fst, lst, nbr); _ActiveDB->set(_CurrentGroup); } }

void RServer::setserver (  MPListEntry *  server  )  [protected]

Disconnect from the current news server and set a new news server as the current one, if the new one is different to the current. Parameters: server  A multiplexinglist entry pointing to the new news server. This parameter must not be freed as long as RServer uses this news server, since only the pointer is stored. As soon as RServer connects to this news server, it will store whether posting is allowed in server->flags. Definition at line 475 of file NServer.cc. References _CurrentGroup, _CurrentServer, disconnect(), MPListEntry::hostname, GroupInfo::init(), Logger::p(), MPListEntry::servicename, slog, and VERB. Referenced by active(), CServer::article(), article(), post(), and selectgroup(). { VERB(slog.p(Logger::Debug) << "RServer::setserver({" << server->hostname << "," << server->servicename << "})\n"); if (_CurrentServer == server) return; if (_CurrentServer) disconnect(); _CurrentGroup.init(); _CurrentServer = server; }

void RServer::setserverlist (  MPList *  serverlist  )

Delete all previously allocated data and install a new list of news servers and newsgroups. Parameters: serverlist  The list of news servers. This parameter must not be freed as long as RServer uses this server-list, since only the pointer is stored. Definition at line 559 of file NServer.cc. References _CurrentGroup, _CurrentServer, _ServerList, disconnect(), GroupInfo::init(), Logger::p(), slog, and VERB. Referenced by ~RServer(). { VERB(slog.p(Logger::Debug) << "RServer::setserverlist()\n"); // Disconnect disconnect(); // Clean up _CurrentGroup.init(); if (_ActiveDB) { delete _ActiveDB; _ActiveDB = NULL; } _CurrentServer = NULL; _ServerList = serverlist; }

---

Member Data Documentation

GroupInfo RServer::_CurrentGroup [protected]

Definition at line 239 of file NServer.h. Referenced by connect(), getgroup(), groupinfo(), selectgroup(), setserver(), and setserverlist().

MPListEntry* RServer::_CurrentServer [protected]

Definition at line 238 of file NServer.h. Referenced by active(), article(), connect(), init(), issue(), overviewdb(), post(), RServer(), setserver(), and setserverlist().

sstream* RServer::_pServerStream [protected]

Definition at line 241 of file NServer.h. Referenced by active(), article(), connect(), disconnect(), is_connected(), issue(), listgroup(), overviewdb(), post(), and RServer().

MPList* RServer::_ServerList [protected]

Definition at line 237 of file NServer.h. Referenced by active(), article(), getserverlist(), init(), post(), RServer(), selectgroup(), and setserverlist().

---

The documentation for this class was generated from the following files:

• NServer.h
• NServer.cc

---