ArtSpooler Class Reference

ArtSpooler manages the Spool Directory. More...

#include <ArtSpooler.h>

List of all members.

Public Member Functions
	ArtSpooler (const string &spoolDir)
	~ArtSpooler ()
void	spoolArt (Article &a)
Article *	getSpooledArt (void)
void	storeBadArt (Article &a)
Private Member Functions
string	createID (void)
string	extractID (Article &a)
int	storeArticle (const string &path, Article &a)
Private Attributes
string	spoolDir
string	artSpool
string	badArticles
ObjLock *	pLock

---

Detailed Description

ArtSpooler manages the Spool Directory.

Author:

Herbert Straub

Date:

2003

ArtSpooler manages the Spool Directory with the Articles. It uses the Parameter spoolDir to determine the Path to the Spool. ArtSpooler creates the following subdirectories:

• .artSpool (Directory)
• .badArcticles (Directory),
• .resourceSpooler.lock (LockFile).

Definition at line 39 of file ArtSpooler.h.

---

Constructor & Destructor Documentation

ArtSpooler::ArtSpooler (  const string &  spoolDir  )

If the spool directory doesn't exists, the contstructor creates it. It uses ObjLock to manage the access to the Spool. Parameters: spool  Spool Directory Exceptions: Error  Todo: Das ist ein Testpunkt Definition at line 39 of file ArtSpooler.cc. References artSpool, badArticles, ERROR_LOCATION, mkpdir(), Logger::p(), pLock, slog, and VERB. { VERB(slog.p(Logger::Debug) << "ArtSpooler::ArtSpooler (" << spoolDir << ")\n"); string tmp; this->spoolDir = spoolDir; if (mkpdir(spoolDir.c_str(), 0700) == -1) { string errtxt("Error creating spoolDirectory"); errtxt += spoolDir; throw(Error(errtxt.c_str(), ERROR_LOCATION)); } artSpool = spoolDir + "/.artSpool"; if (mkpdir(artSpool.c_str(), 0700) == -1) { string errtxt("Error creating spoolDirectory"); errtxt += artSpool; throw(Error(errtxt.c_str(), ERROR_LOCATION)); } badArticles = spoolDir + "/.badArticles"; if (mkpdir(badArticles.c_str(), 0700) == -1) { string errtxt("Error creating spoolDirectory"); errtxt += artSpool; throw(Error(errtxt.c_str(), ERROR_LOCATION)); } tmp = spoolDir + "/.resourceSpooler.lock"; pLock = new ObjLock(tmp); }

ArtSpooler::~ArtSpooler (   )

Definition at line 68 of file ArtSpooler.cc. References Logger::p(), pLock, slog, and VERB. { VERB(slog.p(Logger::Debug) << "ArtSpooler::~ArtSpooler ()\n"); delete pLock; }

---

Member Function Documentation

string ArtSpooler::createID (  void   )  [private]

Create a unique ID Returns: The ID String Definition at line 156 of file ArtSpooler.cc. Referenced by storeArticle(). { #ifdef HAVE_SSTREAM stringstream sb; #else strstream sb; #endif pid_t pid; struct timeval t; pid = getpid(); gettimeofday(&t, NULL); sb << (int) pid << (int) t.tv_sec << (int) t.tv_usec; return sb.rdbuf()->str(); }

string ArtSpooler::extractID (  Article &  a  )  [private]

Extract ID from article message id Returns: The ID String Definition at line 172 of file ArtSpooler.cc. References Article::getfield(). { string ID = a.getfield("message-id"); ID.replace(0, 3, ""); ID.replace(ID.length() - 1, 1, ""); return ID; }

Article * ArtSpooler::getSpooledArt (  void   )

Get one article from the Spool (don't forget delete). It returns NULL, if no article is available. A exclusive lock is used. Returns: A pointer to the article or NULL. Definition at line 126 of file ArtSpooler.cc. References artSpool, ObjLock::lockExBlk(), Logger::p(), pLock, Article::read(), slog, ObjLock::unlock(), and VERB. Referenced by main(), and CServer::postspooled(). { VERB(slog.p(Logger::Debug) << "ArtSpooler::getSpooledArt ()\n"); string an; Article *pa = NULL; ifstream is; struct dirent *d; DIR *dir; pLock->lockExBlk(); dir = opendir(artSpool.c_str()); for (d = readdir(dir); d != NULL; d = readdir(dir)) { if (strncmp("art_", d->d_name, 4) == 0) { an = artSpool + "/" + d->d_name; pa = new Article(); is.open(an.c_str()); // FIXME: check status pa->read(is); is.close(); unlink(an.c_str()); // FIXME: check status break; } } closedir(dir); pLock->unlock(); return pa; }

void ArtSpooler::spoolArt (  Article &  a  )

Add this article to the spool. The naming convention for articles in the spool: art_nr.txt. nr is a number. A shared Lock is used. Parameters: a  Article Exceptions: Error  Definition at line 75 of file ArtSpooler.cc. References artSpool, ERROR_LOCATION, ObjLock::lockExBlk(), pLock, slog, storeArticle(), ObjLock::unlock(), and VERB. Referenced by main(), and CServer::spoolarticle(). { VERB(slog. p(Logger::Debug) << "ArtSpooler::spoolArt (Article &)\n"); int s; pLock->lockExBlk(); s = storeArticle(artSpool, a); pLock->unlock(); if (s != 0) { throw(Error("spoolArt: duplicateArt", ERROR_LOCATION)); } }

int ArtSpooler::storeArticle (  const string &  path, Article &  a )  [private]

store Article in path return 0 success, 1 duplicated Definition at line 105 of file ArtSpooler.cc. References createID(). Referenced by spoolArt(), and storeBadArt(). { ofstream os; string fn, id; struct stat st; int s; id = createID();; fn = path + "/art_" + id; s = lstat(fn.c_str(), &st); if (s == -1) { os.open(fn.c_str()); os << a; os.close(); s = 0; } else { s = 1; } return (s); }

void ArtSpooler::storeBadArt (  Article &  a  )

Store the article in the "Bad Article Store". Bad articles (ex. POST error) can be stored with this method. A operator intervention is required to manage this store. Parameters: a  Article Definition at line 91 of file ArtSpooler.cc. References badArticles, ERROR_LOCATION, ObjLock::lockExBlk(), pLock, slog, storeArticle(), ObjLock::unlock(), and VERB. Referenced by main(), and CServer::postspooled(). { VERB(slog. p(Logger::Debug) << "ArtSpooler::storeBadArt (Article &)\n"); int s; pLock->lockExBlk(); s = storeArticle(badArticles, a); pLock->unlock(); if (s != 0) { throw(Error("storeBadArt: duplicateArt", ERROR_LOCATION)); } }

---

Member Data Documentation

string ArtSpooler::artSpool [private]

Definition at line 100 of file ArtSpooler.h. Referenced by ArtSpooler(), getSpooledArt(), and spoolArt().

string ArtSpooler::badArticles [private]

Definition at line 101 of file ArtSpooler.h. Referenced by ArtSpooler(), and storeBadArt().

ObjLock* ArtSpooler::pLock [private]

Definition at line 102 of file ArtSpooler.h. Referenced by ArtSpooler(), getSpooledArt(), spoolArt(), storeBadArt(), and ~ArtSpooler().

string ArtSpooler::spoolDir [private]

Definition at line 99 of file ArtSpooler.h.

---

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

• ArtSpooler.h
• ArtSpooler.cc

---