NVNewsgroup Class Reference

#include <NVNewsgroup.h>

Inheritance diagram for NVNewsgroup:

List of all members.

Public Member Functions
	NVNewsgroup (OverviewFmt *fmt, const char *spooldir, const char *name)
virtual void	getsize (unsigned int *f, unsigned int *l)
virtual void	setsize (unsigned int f, unsigned int l)
virtual unsigned int	firstnbr ()
virtual unsigned int	lastnbr ()
virtual int	hasrecord (unsigned int i)
virtual Article *	getarticle (unsigned int nbr)
virtual void	freearticle (Article *artp)
virtual void	setarticle (Article *art)
virtual void	printarticle (std::ostream &os, unsigned int nbr)
virtual void	prefetchGroup (int lockgrp=1)
virtual void	prefetchOverview (void)
virtual const char *	getover (unsigned int nbr)
virtual void	setover (const string &over)
virtual void	printover (std::ostream &os, unsigned int nbr)
virtual void	readoverdb (std::istream &is)
virtual void	printoverdb (std::ostream &os, unsigned int f=0, unsigned int l=UINT_MAX)
virtual void	printheaderdb (std::ostream &os, const char *header, unsigned int f=0, unsigned int l=UINT_MAX)
virtual void	printlistgroup (std::ostream &os)
Protected Types
enum	{ hasarticle = 0x1, overview = 0x2, article = 0x3, bigarticle = 0x4 }
Protected Member Functions
void	sprintover (std::ostream &os, unsigned int nbr)
Protected Attributes
char	_SpoolDirectory [MAXPATHLEN]

---

Detailed Description

Author:

Thomas Gschwind

Bug:

Documentation is missing.

Definition at line 31 of file NVNewsgroup.h.

---

Member Enumeration Documentation

anonymous enum [protected]

Enumeration values: hasarticle  overview  article  bigarticle  Definition at line 35 of file NVNewsgroup.h. { hasarticle = 0x1, overview = 0x2, article = 0x3, bigarticle = 0x4 };

---

Constructor & Destructor Documentation

NVNewsgroup::NVNewsgroup (  OverviewFmt *  fmt, const char *  spooldir, const char *  name )  [inline]

Definition at line 44 of file NVNewsgroup.h. References group2dir(), mkpdir(), and NVcontainer::open(). :Newsgroup(fmt, name), NVArray() { char fn[MAXPATHLEN]; sprintf(_SpoolDirectory, "%s/%s", spooldir, group2dir(name)); mkpdir(_SpoolDirectory, 0755); sprintf(fn, "%s/.db", _SpoolDirectory); NVArray::open(fn); }

---

Member Function Documentation

virtual unsigned int NVNewsgroup::firstnbr (   )  [inline, virtual]

Implements Newsgroup. Definition at line 62 of file NVNewsgroup.h. Referenced by clean(). { return arrfst; }

virtual void NVNewsgroup::freearticle (  Article *  artp  )  [inline, virtual]

Implements Newsgroup. Definition at line 73 of file NVNewsgroup.h. { delete artp; }

Article * NVNewsgroup::getarticle (  unsigned int  nbr  )  [virtual]

Implements Newsgroup. Definition at line 153 of file NVNewsgroup.cc. References article, bigarticle, NVArray::getsize(), NVcontainer::lock(), Article::read(), Newsgroup::retrievearticle(), setarticle(), NVArray::sget(), slog, and VERB. { VERB(slog. p(Logger:: Debug) << "NVNewsgroup::getarticle(" << nbr << ")\n"); char *data; size_t szdata; unsigned long f, l; Article *art = NULL; NVArray::lock(NVcontainer::ShrdLock); NVArray::getsize(&f, &l); if (nbr >= f && nbr <= l) { NVArray::sget(nbr, &data, &szdata); if (data) { if (*data == article) { // szdata ... Size of article including type and the trailing \0 art = new Article(nbr, data + sizeof(char), szdata - sizeof(char) - 1); } else if (*data == bigarticle) { char fn[MAXPATHLEN]; ifstream fs; sprintf(fn, "%s/.art%u", _SpoolDirectory, nbr); fs.open(fn); if (!fs.good() && errno == ENOENT) { if ((art = retrievearticle(nbr)) != NULL) setarticle(art); } else { art = new Article(nbr); art->read(fs); } fs.close(); } else { // Article not available if ((art = retrievearticle(nbr)) != NULL) setarticle(art); } } else { // Article not available if ((art = retrievearticle(nbr)) != NULL) setarticle(art); } } NVArray::lock(NVcontainer::UnLock); return art; }

const char * NVNewsgroup::getover (  unsigned int  nbr  )  [virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 319 of file NVNewsgroup.cc. References article, bigarticle, OverviewFmt::convert(), NVArray::getsize(), NVcontainer::lock(), NVArray::sget(), slog, and VERB. Referenced by CNewsgroup::getover(). { // VERB(slog.p(Logger::Debug) << "NVNewsgroup::getover(over)\n"); char *data; size_t szdata; unsigned long f, l; static string over; over = ""; NVArray::lock(NVcontainer::ShrdLock); NVArray::getsize(&f, &l); if (f <= nbr && nbr <= l) { NVArray::sget(nbr, &data, &szdata); if (data) { if (*data == article) { Article *art; //FIX! This is inefficient! //FIX! The article is copied and all the overview data is copied //FIX! again. We should allow Articles to use externally provided //FIX! memory (eg. memory from the NVNewsgroup). // szdata ... Size of article+1 including the trailing \0 art = new Article(nbr, data + sizeof(char), szdata - sizeof(char) - 1); _OverviewFormat->convert(*art, over); delete art; } else if (*data == bigarticle || *data == overview) { over = data + sizeof(char); } else { // Impossible VERB(slog. p(Logger:: Critical) << "NVNewsgroup::getover. Oops, reached ?dead? code 936!!!\n"); } } } NVArray::lock(NVcontainer::UnLock); return over.c_str(); }

virtual void NVNewsgroup::getsize (  unsigned int *  f, unsigned int *  l )  [inline, virtual]

Implements Newsgroup. Definition at line 57 of file NVNewsgroup.h. Referenced by CNewsgroup::sUpdateGroupInfo(). { *f = arrfst; *l = arrlst; }

virtual int NVNewsgroup::hasrecord (  unsigned int  i  )  [inline, virtual]

Implements Newsgroup. Definition at line 68 of file NVNewsgroup.h. References NVArray::has_element(). { return NVArray::has_element(i); }

virtual unsigned int NVNewsgroup::lastnbr (   )  [inline, virtual]

Implements Newsgroup. Definition at line 65 of file NVNewsgroup.h. Referenced by clean(). { return arrlst; }

virtual void NVNewsgroup::prefetchGroup (  int  lockgrp = 1  )  [inline, virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 78 of file NVNewsgroup.h. { }

virtual void NVNewsgroup::prefetchOverview (  void   )  [inline, virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 80 of file NVNewsgroup.h. { }

void NVNewsgroup::printarticle (  std::ostream &  os, unsigned int  nbr )  [virtual]

Implements Newsgroup. Definition at line 281 of file NVNewsgroup.cc. References article, bigarticle, NVArray::getsize(), NVcontainer::lock(), Article::read(), Newsgroup::retrievearticle(), setarticle(), and NVArray::sget(). { char *data; size_t szdata; unsigned long f, l; NVArray::lock(NVcontainer::ShrdLock); NVArray::getsize(&f, &l); if (nbr >= f && nbr <= l) { NVArray::sget(nbr, &data, &szdata); if (data) { if (*data == article) { os << data + sizeof(char); } else if (*data == bigarticle) { Article art(nbr); char fn[MAXPATHLEN]; ifstream fs; sprintf(fn, "%s/.art%u", _SpoolDirectory, nbr); fs.open(fn); art.read(fs); fs.close(); os << art; } else { // Article not available Article *art; if ((art = retrievearticle(nbr)) != NULL) setarticle(art); os << *art; delete art; } } } NVArray::lock(NVcontainer::UnLock); }

void NVNewsgroup::printheaderdb (  std::ostream &  os, const char *  header, unsigned int  f = 0, unsigned int  l = UINT_MAX )  [virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 436 of file NVNewsgroup.cc. References article, bigarticle, OverviewFmt::getfield(), Article::getfield(), NVArray::getsize(), NVcontainer::lock(), and NVArray::sget(). Referenced by CNewsgroup::printheaderdb(). { char *data, xheader[512], *p; string fld; const char *q; size_t szdata; unsigned long gf, i, gl; p = xheader; q = header; while ((*p++ = *q++)); *(p - 1) = ':'; *p = '\0'; NVArray::lock(NVcontainer::ShrdLock); NVArray::getsize(&gf, &gl); if (f < gf) f = gf; if (l > gl) l = gl; for (i = f; i <= l; i++) { NVArray::sget(i, &data, &szdata); if (data) { if (*data == article) { Article *art; //FIX! This is inefficient! //FIX! The article is copied and all the overview data is copied //FIX! again. We should allow Articles to use externally provided //FIX! memory (eg. memory from the NVNewsgroup). // szdata ... Size of article including the trailing \0 plus // 1char (= InformationTag of NVNewsgroup) art = new Article(i, data + sizeof(char), szdata - sizeof(char)); try { fld = art->getfield(xheader, 0); os << i << " " << fld << "\r\n"; } catch(NoSuchFieldError & nfe) { os << i << " (none)\r\n"; } delete art; } else if (*data == bigarticle || *data == overview) { const char *over = data + sizeof(char); try { fld = _OverviewFormat->getfield(over, xheader, 0); os << i << " " << fld << "\r\n"; } catch(NoSuchFieldError & nfe) { os << i << " (none)\r\n"; } } } /* if(data) */ } NVArray::lock(NVcontainer::UnLock); }

void NVNewsgroup::printlistgroup (  std::ostream &  os  )  [virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 496 of file NVNewsgroup.cc. References NVcontainer::lock(), NVArray::shas_element(), slog, and VERB. Referenced by CNewsgroup::printlistgroup(). { VERB(slog. p(Logger::Debug) << "NVNewsgroup::printlistgroup(&os)\n"); unsigned int i; lock(NVcontainer::ShrdLock); for (i = arrfst; i <= arrlst; i++) { if (shas_element(i)) os << i << "\r\n"; } lock(NVcontainer::UnLock); }

virtual void NVNewsgroup::printover (  std::ostream &  os, unsigned int  nbr )  [inline, virtual]

Reimplemented from Newsgroup. Reimplemented in CNewsgroup. Definition at line 85 of file NVNewsgroup.h. References NVcontainer::lock(), and sprintover(). Referenced by CNewsgroup::printover(). { NVArray::lock(NVcontainer::ShrdLock); sprintover(os, nbr); NVArray::lock(NVcontainer::UnLock); }

void NVNewsgroup::printoverdb (  std::ostream &  os, unsigned int  f = 0, unsigned int  l = UINT_MAX )  [virtual]

Reimplemented from Newsgroup. Reimplemented in CNewsgroup. Definition at line 421 of file NVNewsgroup.cc. References NVcontainer::lock(), Logger::p(), slog, sprintover(), and VERB. Referenced by CNewsgroup::printoverdb(). { VERB(slog.p(Logger::Debug) << "NVNewsgroup::printoverdb(os," << f << "," << l << ")\n"); unsigned int i; lock(NVcontainer::ShrdLock); if (f < arrfst) f = arrfst; if (arrlst < l) l = arrlst; for (i = f; i <= l; i++) sprintover(os, i); lock(NVcontainer::UnLock); }

void NVNewsgroup::readoverdb (  std::istream &  is  )  [virtual]

Implements Newsgroup. Definition at line 395 of file NVNewsgroup.cc. References OverviewFmt::convert(), OverviewFmt::dotrans, NVcontainer::lock(), nlreadline(), Logger::p(), NVcontainer::setmtime(), setover(), slog, and VERB. { VERB(slog.p(Logger::Debug) << "NVNewsgroup::readoverdb(&is)\n"); string line1, line2; time_t now; lock(NVcontainer::ExclLock); for (;;) { nlreadline(is, line1, 0); if (line1 == "." || is.eof()) break; if (_OverviewFormat->dotrans) { // Convert Record _OverviewFormat->convert(line1, line2); setover(line2); } else { setover(line1); } } time(&now); setmtime(now); lock(NVcontainer::UnLock); }

void NVNewsgroup::setarticle (  Article *  art  )  [virtual]

Implements Newsgroup. Definition at line 203 of file NVNewsgroup.cc. References article, ASSERT2, bigarticle, Article::c_str(), OverviewFmt::convert(), Article::getnbr(), NVArray::getsize(), Article::length(), NVcontainer::lock(), NVcontainer::nvalloc(), NVcontainer::nvfree(), nvoff_t, Logger::p(), NVArray::sget(), slog, and VERB. Referenced by getarticle(), CNewsgroup::prefetchGroup(), and printarticle(). { unsigned long f, l; unsigned int nbr; VERB(char buf[1024]; sprintf(buf, "NVNewsgroup::setarticle(*art(nbr=%d))\n", art->getnbr()); slog.p(Logger::Debug) << buf); ASSERT2(testdb()); nbr = art->getnbr(); NVArray::lock(NVcontainer::ExclLock); NVArray::getsize(&f, &l); if (f <= nbr && nbr <= l) { char *data; size_t szdata; unsigned long i; i = nbr - arrfst; NVArray::sget(nbr, &data, &szdata); if (art->length() <= 15360) { // Article smaller/equal 15k => Store article in NewsgroupDB nvoff_t x; if (data) { nvfree(arrtab[i]); } szdata = art->length() + 1 + sizeof(char); x = nvalloc(szdata + sizeof(unsigned long)); arrtab[i] = x; data = mem_p + x; *((unsigned long *) data) = szdata; data += sizeof(unsigned long); *data = article; // VERB(sprintf(buf,"NVN::setarticle: Before memcpy arrtab=%p data=%p\n",arrtab,data); // slog.p(Logger::Debug) << buf); ASSERT2(testdb()); memcpy(data + sizeof(char), art->c_str(), art->length() + 1); } else if (art->length() > 15360) { // Article bigger 15k => Store externally if (data && *data != overview && *data != bigarticle) { nvfree(arrtab[i]); data = NULL; } if (!data) { string over; nvoff_t x; _OverviewFormat->convert(*art, over); szdata = over.length() + 1 + sizeof(char); x = nvalloc(szdata + sizeof(unsigned long)); arrtab[i] = x; data = mem_p + x; *((unsigned long *) (data)) = szdata; data += sizeof(unsigned long); memcpy(data + sizeof(char), over.c_str(), over.length() + 1); } *data = bigarticle; char fn[MAXPATHLEN]; ofstream fs; sprintf(fn, "%s/.art%u", _SpoolDirectory, nbr); fs.open(fn); fs << *art; fs.close(); *data = bigarticle; } else { VERB(slog. p(Logger:: Debug) << "NVNewsgroup::setarticle: Tried to store an existing article\n"); } } /* if(f<=nbr<=l) */ lock(NVcontainer::UnLock); ASSERT2(testdb()); }

void NVNewsgroup::setover (  const string &  over  )  [virtual]

Implements Newsgroup. Definition at line 362 of file NVNewsgroup.cc. References ASSERT2, NVArray::getsize(), NVcontainer::lock(), NVcontainer::nvalloc(), nvoff_t, and NVArray::sget(). Referenced by readoverdb(). { // VERB(slog.p(Logger::Notice) << "NVNewsgroup::setover(over)\n"); unsigned long f, l, nbr; nbr = atoi((const char *) over.c_str()); NVArray::lock(NVcontainer::ExclLock); NVArray::getsize(&f, &l); if (f <= nbr && nbr <= l) { char *data; size_t szdata; unsigned long i; i = nbr - arrfst; NVArray::sget(nbr, &data, &szdata); if (!data) { szdata = over.length() + 1 + sizeof(char); nvoff_t x = nvalloc(szdata + sizeof(unsigned long)); arrtab[i] = x; data = mem_p + x; *((unsigned long *) (data)) = szdata; data += sizeof(unsigned long); memcpy(data + sizeof(char), over.c_str(), over.length() + 1); *data = overview; } } NVArray::lock(NVcontainer::UnLock); ASSERT2(testdb()); }

void NVNewsgroup::setsize (  unsigned int  f, unsigned int  l )  [virtual]

Implements Newsgroup. Reimplemented in CNewsgroup. Definition at line 90 of file NVNewsgroup.cc. References bigarticle, NVcontainer::lock(), NVcontainer::nvfree(), slog, NVArray::ssetsize(), and VERB. Referenced by CServer::getgroup(), and CNewsgroup::setsize(). { VERB(slog. p(Logger:: Debug) << "NVNewsgroup::setsize(" << f << "," << l << ")\n"); char fn[MAXPATHLEN]; long n1, n2, i; lock(NVcontainer::ShrdLock); if (f != arrfst || l != arrlst) { lock(NVcontainer::ExclLock); if (arrfst <= arrlst) { // free all those elements from arrfst -> f i = 0; n1 = f - arrfst; n2 = arrlst - arrfst + 1; if (n2 < n1) n1 = n2; while ((long) i < n1) { if (arrtab[i]) { if (* (mem_p + arrtab[i] + sizeof(long)) == bigarticle) { // Remove article from disk sprintf(fn, "%s/.art%lu", _SpoolDirectory, arrfst + i); unlink(fn); } nvfree(arrtab[i]); } i++; } // free all those elements from l -> arrlst i = l - arrfst + 1; if (i < 0) i = 0; n1 = arrlst - arrfst + 1; while ((long) i < n1) { if (arrtab[i]) { if (* (mem_p + arrtab[i] + sizeof(long)) == bigarticle) { // Remove article from disk sprintf(fn, "%s/.art%lu", _SpoolDirectory, arrfst + i); unlink(fn); } nvfree(arrtab[i]); } i++; } } // resize array NVArray::ssetsize(f, l); lock(NVcontainer::UnLock); } lock(NVcontainer::UnLock); }

void NVNewsgroup::sprintover (  std::ostream &  os, unsigned int  nbr )  [protected]

Definition at line 52 of file NVNewsgroup.cc. References article, bigarticle, OverviewFmt::convert(), NVArray::getsize(), NVArray::sget(), slog, and VERB. Referenced by printover(), and printoverdb(). { char *data; size_t szdata; unsigned long f, l; string over; NVArray::getsize(&f, &l); if (f <= nbr && nbr <= l) { NVArray::sget(nbr, &data, &szdata); if (data) { if (*data == article) { Article *art; //FIX! This is inefficient! //FIX! The article is copied and all the overview data is copied //FIX! again. We should allow Articles to use externally provided //FIX! memory (eg. memory from the NVNewsgroup). // szdata ... Size of article+1 including the trailing \0 art = new Article(nbr, data + sizeof(char), szdata - sizeof(char) - 1); _OverviewFormat->convert(*art, over); os << over << "\r\n"; delete art; } else if (*data == bigarticle || *data == overview) { os << data + sizeof(char) << "\r\n"; } else { // Oops, inconsistent VERB(slog. p(Logger:: Alert) << "NVN::sprintover(...): inconsistent newsgroup database!\n"); } } } }

---

Member Data Documentation

char NVNewsgroup::_SpoolDirectory[MAXPATHLEN] [protected]

Definition at line 42 of file NVNewsgroup.h.

---

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

• NVNewsgroup.h
• NVNewsgroup.cc

---