Cgicc类是主类。首先是一些常用的typedef
//! A vector of FormEntry objects
typedef STDNS vector<FormEntry>::iterator form_iterator;
//! A vector of \c const FormEntry objects
typedef STDNS vector<FormEntry>::const_iterator const_form_iterator;
//! A vector of FormFile objects
typedef STDNS vector<FormFile>::iterator file_iterator;
//! A vector of \c const FormFile objects
typedef STDNS vector<FormFile>::const_iterator const_file_iterator;
cigcc里面很多地方用到了STL的vector.STDNS就就是std::,因为整个文件的定义是在namespace cgicc里面,所以此处要声明std.。网页文件的元素很适合用vector来标示,迭代器也是直接使用vector的。
cgicc主要是用来存取form的元素信息的。
cigcc通常的用法是:
int
main(int argc, char **argv) {
try {
cgicc::Cgicc cgi;
// do something with cgi
}
catch(const exception& e) {
//handle the error
}
}
类的定义相关,简单的成员函数不再介绍,只在后面介绍具体的重要的成员函数。下面是类的私有数据与函数:private:
CgiEnvironment fEnvironment;
STDNS vector<FormEntry> fFormData;
STDNS vector<FormFile> fFormFiles;
// Convert query string into a list of FormEntries
void parseFormInput(const STDNS string& data);
// Parse a multipart/form-data header
MultipartHeader parseHeader(const STDNS string& data);
// Parse a (name=value) form entry
void parsePair(const STDNS string& data);
// Parse a MIME entry for ENCTYPE=""
void parseMIME(const STDNS string& data);
// Find elements in the list of entries
bool findEntries(const STDNS string& param,
bool byName,STDNS vector<FormEntry>& result) const;
};
构造函数:
Cgicc(reader_function_t stream_reader = NULL);
如果使用的是FastCGI(CGI的一个扩展版本)的话,会需要一个reader_function_t的参数,用来读取输入。如果忽略或者是NULL的话,
则使用标准输入
read_function_t也是一个typedef .定义在CgiEnvironment.h中
typedef size_t (* reader_function_t)(void *, size_t);
是一种函数指针类型。size_t 是Linux上常用的一种数据类型。一般为long unsigned int.这种函数类型接受两个参数,返回一个size_t.
实现:
CGICCNS Cgicc::Cgicc(reader_function_t stream_reader) //CGICCNS--->cgicc::
: fEnvironment(stream_reader) //fEnvironment是一个CgiEnvironment 实例。
{
#if DEBUG
#if HAVE_STRFTIME //是否有strftime这个函数,有的话就会有下面的调用。LINUX上一般都有。
time_t now;
tm *date;
char s[80];
now = time(0); //获取UNIX时间(秒数)。
date = localtime(&now); //转换成通常用的时间格式
strftime(s, 80, "%A, %B %d, %Y %I:%M:%S %p", date); //写入字符数组s中
LOG("Cgicc debugging log started on ") //LOG和下面的stringsAreEqual都是Cgiutils.h中定义的一些实用函数,见本文
LOGLN(s) //附录。
#else
LOGLN("Cgicc debugging log started.")
#endif /* HAVE_STRFTIME */
#endif /* DEBUG */
// this can be tweaked for performance
fFormData.reserve(40); //请求存储空间,最少能容纳40个元素,STL中的接口
fFormFiles.reserve(5); //同上。Cgicc提供了整个库最主要的也是最基本的接口,其中就包括存贮取得的信息。
if(stringsAreEqual(getEnvironment().getRequestMethod(), "post")) //具体函数见附录2.
parseFormInput(getEnvironment().getPostData());
else
parseFormInput(getEnvironment().getQueryString());
}
析构函数:
1 CGICCNS Cgicc::~Cgicc()
2 {
3 LOGLN("Cleaning up
")
4 LOGLN("Cgicc debugging log closed.")
5 }
同构造函数一样,若开启DEBUG宏,输出一些提示信息。否则什么也不做。
附录:
1.LOG。一个宏,牵扯到DEBUG这个宏,默认情况下DEBUG为0,此时LOG(S)和LOGIN(S)都为空。若DEBUG=1,则定义为:
extern STDNS ofstream gLogFile;
#define LOGLN(s) gLogFile << s << STDNS endl;
#define LOG(s) gLogFile << s;
所以此时上面的构造函数的输出为(标准输出):
Cgicc debugging log started on\n+一个时间2.stringsAreEqual比较两个字符串是否相等,忽视大小写。
bool
CGICCNS stringsAreEqual(const STDNS string& s1, //CGICCNS------>cgicc:: STDNS----->std::
const STDNS string& s2)
{
STDNS string::const_iterator p1 = s1.begin();
STDNS string::const_iterator p2 = s2.begin();
STDNS string::const_iterator l1 = s1.end();
STDNS string::const_iterator l2 = s2.end();
while(p1 != l1 && p2 != l2) {
if(toupper(*(p1++)) != toupper(*(p2++))) //忽略大小写
return false;
}
return (s2.size() == s1.size()) ? true : false;
}