15.6 Java与CGI的沟通

Java程序可向一个服务器发出一个CGI请求,这与HTML表单页没什么两样。而且和HTML页一样,这个请求既可以设为GET(下载),亦可设为POST(上传)。除此以外,Java程序还可拦截CGI程序的输出,所以不必依赖程序来格式化一个新页,也不必在出错的时候强迫用户从一个页回转到另一个页。事实上,程序的外观可以做得跟以前的版本别无二致。

代码也要简单一些,毕竟用CGI也不是很难就能写出来(前提是真正地理解它)。所以在这一节里,我们准备办个CGI编程速成班。为解决常规问题,将用C++创建一些CGI工具,以便我们编写一个能解决所有问题的CGI程序。这样做的好处是移植能力特别强——即将看到的例子能在支持CGI的任何系统上运行,而且不存在防火墙的问题。

这个例子也阐示了如何在程序片(Applet)和CGI程序之间建立连接,以便将其方便地改编到自己的项目中。

15.6.1 CGI数据的编码

在这个版本中,我们将收集名字和电子函件地址,并用下述形式将其保存到文件中:

  1. First Last <email@domain.com>;

这对任何E-mail程序来说都是一种非常方便的格式。由于只需收集两个字段,而且CGI为字段中的编码采用了一种特殊的格式,所以这里没有简便的方法。如果自己动手编制一个原始的HTML页,并加入下述代码行,即可正确地理解这一点:

  1. <Form method="GET" ACTION="/cgi-bin/Listmgr2.exe">
  2. <P>Name: <INPUT TYPE = "text" NAME = "name"
  3. VALUE = "" size = "40"></p>
  4. <P>Email Address: <INPUT TYPE = "text"
  5. NAME = "email" VALUE = "" size = "40"></p>
  6. <p><input type = "submit" name = "submit" > </p>
  7. </Form>

上述代码创建了两个数据输入字段(区),名为nameemail。另外还有一个submit(提交)按钮,用于收集数据,并将其发给CGI程序。Listmgr2.exe是驻留在特殊程序目录中的一个可执行文件。在我们的Web服务器上,该目录一般都叫作cgi-bin(注释③)。如果在那个目录里找不到该程序,结果就无法出现。填好这个表单,然后按下提交按钮,即可在浏览器的URL地址窗口里看到象下面这样的内容:

  1. http://www.myhome.com/cgi-bin/Listmgr2.exe?name=First+Last&email=email@domain.com&submit=Submit

③:在Windows32平台下,可利用与Microsoft Office 97或其他产品配套提供的Microsoft Personal Web Server(微软个人Web服务器)进行测试。这是进行试验的最好方法,因为不必正式连入网络,可在本地环境中完成测试(速度也非常快)。如果使用的是不同的平台,或者没有Office 97或者FrontPage 98那样的产品,可到网上找一个免费的Web服务器供自己测试。

当然,上述URL实际显示时是不会拆行的。从中可稍微看出如何对数据编码并传给CGI。至少有一件事情能够肯定——空格是不允许的(因为它通常用于分隔命令行参数)。所有必需的空格都用“+”号替代,每个字段都包含了字段名(具体由HTML页决定),后面跟随一个=号以及正式的字段数据,最后用一个&结束。

到这时,大家也许会对+=以及&的使用产生疑惑。假如必须在字段里使用这些字符,那么该如何声明呢?例如,我们可能使用“John & MarshaSmith”这个名字,其中的&代表“And”。事实上,它会编码成下面这个样子:

  1. John+%26+Marsha+Smith

也就是说,特殊字符会转换成一个%,并在后面跟上它的十六进制ASCII编码。

幸运的是,Java有一个工具来帮助我们进行这种编码。这是URLEncoder类的一个静态方法,名为encode()。可用下述程序来试验这个方法:

  1. //: EncodeDemo.java
  2. // Demonstration of URLEncoder.encode()
  3. import java.net.*;
  4. public class EncodeDemo {
  5. public static void main(String[] args) {
  6. String s = "";
  7. for(int i = 0; i < args.length; i++)
  8. s += args[i] + " ";
  9. s = URLEncoder.encode(s.trim());
  10. System.out.println(s);
  11. }
  12. } ///:~

该程序将获取一些命令行参数,把它们合并成一个由多个词构成的字符串,各词之间用空格分隔(最后一个空格用String.trim()剔除了)。随后对它们进行编码,并打印出来。

为调用一个CGI程序,程序片要做的全部事情就是从自己的字段或其他地方收集数据,将所有数据都编码成正确的URL样式,然后汇编到单独一个字符串里。每个字段名后面都加上一个=符号,紧跟正式数据,再紧跟一个&。为构建完整的CGI命令,我们将这个字符串置于CGI程序的URL以及一个?后。这是调用所有CGI程序的标准方法。大家马上就会看到,用一个程序片能够很轻松地完成所有这些编码与合并。

15.6.2 程序片

程序片实际要比NameSender.java简单一些。这部分是由于很容易即可发出一个GET请求。此外,也不必等候回复信息。现在有两个字段,而非一个,但大家会发现许多程序片都是熟悉的,请比较NameSender.java

  1. //: NameSender2.java
  2. // An applet that sends an email address
  3. // via a CGI GET, using Java 1.02.
  4. import java.awt.*;
  5. import java.applet.*;
  6. import java.net.*;
  7. import java.io.*;
  8. public class NameSender2 extends Applet {
  9. final String CGIProgram = "Listmgr2.exe";
  10. Button send = new Button(
  11. "Add email address to mailing list");
  12. TextField name = new TextField(
  13. "type your name here", 40),
  14. email = new TextField(
  15. "type your email address here", 40);
  16. String str = new String();
  17. Label l = new Label(), l2 = new Label();
  18. int vcount = 0;
  19. public void init() {
  20. setLayout(new BorderLayout());
  21. Panel p = new Panel();
  22. p.setLayout(new GridLayout(3, 1));
  23. p.add(name);
  24. p.add(email);
  25. p.add(send);
  26. add("North", p);
  27. Panel labels = new Panel();
  28. labels.setLayout(new GridLayout(2, 1));
  29. labels.add(l);
  30. labels.add(l2);
  31. add("Center", labels);
  32. l.setText("Ready to send email address");
  33. }
  34. public boolean action (Event evt, Object arg) {
  35. if(evt.target.equals(send)) {
  36. l2.setText("");
  37. // Check for errors in data:
  38. if(name.getText().trim()
  39. .indexOf(' ') == -1) {
  40. l.setText(
  41. "Please give first and last name");
  42. l2.setText("");
  43. return true;
  44. }
  45. str = email.getText().trim();
  46. if(str.indexOf(' ') != -1) {
  47. l.setText(
  48. "Spaces not allowed in email name");
  49. l2.setText("");
  50. return true;
  51. }
  52. if(str.indexOf(',') != -1) {
  53. l.setText(
  54. "Commas not allowed in email name");
  55. return true;
  56. }
  57. if(str.indexOf('@') == -1) {
  58. l.setText("Email name must include '@'");
  59. l2.setText("");
  60. return true;
  61. }
  62. if(str.indexOf('@') == 0) {
  63. l.setText(
  64. "Name must preceed '@' in email name");
  65. l2.setText("");
  66. return true;
  67. }
  68. String end =
  69. str.substring(str.indexOf('@'));
  70. if(end.indexOf('.') == -1) {
  71. l.setText("Portion after '@' must " +
  72. "have an extension, such as '.com'");
  73. l2.setText("");
  74. return true;
  75. }
  76. // Build and encode the email data:
  77. String emailData =
  78. "name=" + URLEncoder.encode(
  79. name.getText().trim()) +
  80. "&email=" + URLEncoder.encode(
  81. email.getText().trim().toLowerCase()) +
  82. "&submit=Submit";
  83. // Send the name using CGI's GET process:
  84. try {
  85. l.setText("Sending...");
  86. URL u = new URL(
  87. getDocumentBase(), "cgi-bin/" +
  88. CGIProgram + "?" + emailData);
  89. l.setText("Sent: " + email.getText());
  90. send.setLabel("Re-send");
  91. l2.setText(
  92. "Waiting for reply " + ++vcount);
  93. DataInputStream server =
  94. new DataInputStream(u.openStream());
  95. String line;
  96. while((line = server.readLine()) != null)
  97. l2.setText(line);
  98. } catch(MalformedURLException e) {
  99. l.setText("Bad URl");
  100. } catch(IOException e) {
  101. l.setText("IO Exception");
  102. }
  103. }
  104. else return super.action(evt, arg);
  105. return true;
  106. }
  107. } ///:~

CGI程序(不久即可看到)的名字是Listmgr2.exe。许多Web服务器都在Unix机器上运行(Linux也越来越受到青睐)。根据传统,它们一般不为自己的可执行程序采用.exe扩展名。但在Unix操作系统中,可以把自己的程序称呼为自己希望的任何东西。若使用的是.exe扩展名,程序毋需任何修改即可通过Unix和Win32的运行测试。

和往常一样,程序片设置了自己的用户界面(这次是两个输入字段,不是一个)。唯一显著的区别是在action()方法内产生的。该方法的作用是对按钮按下事件进行控制。名字检查过以后,大家会发现下述代码行:

  1. String emailData =
  2. "name=" + URLEncoder.encode(
  3. name.getText().trim()) +
  4. "&email=" + URLEncoder.encode(
  5. email.getText().trim().toLowerCase()) +
  6. "&submit=Submit";
  7. // Send the name using CGI's GET process:
  8. try {
  9. l.setText("Sending...");
  10. URL u = new URL(
  11. getDocumentBase(), "cgi-bin/" +
  12. CGIProgram + "?" + emailData);
  13. l.setText("Sent: " + email.getText());
  14. send.setLabel("Re-send");
  15. l2.setText(
  16. "Waiting for reply " + ++vcount);
  17. DataInputStream server =
  18. new DataInputStream(u.openStream());
  19. String line;
  20. while((line = server.readLine()) != null)
  21. l2.setText(line);
  22. // ...

nameemail数据都是它们对应的文字框里提取出来,而且两端多余的空格都用trim()剔去了。为了进入列表,email名字被强制换成小写形式,以便能够准确地对比(防止基于大小写形式的错误判断)。来自每个字段的数据都编码为URL形式,随后采用与HTML页中一样的方式汇编GET字符串(这样一来,我们可将Java程序片与现有的任何CGI程序结合使用,以满足常规的HTML GET请求)。

到这时,一些Java的魔力已经开始发挥作用了:如果想同任何URL连接,只需创建一个URL对象,并将地址传递给构造器即可。构造器会负责建立同服务器的连接(对Web服务器来说,所有连接行动都是根据作为URL使用的字符串来判断的)。就目前这种情况来说,URL指向的是当前Web站点的cgi-bin目录(当前Web站点的基础地址是用getDocumentBase()设定的)。一旦Web服务器在URL中看到了一个cgi-bin,会接着希望在它后面跟随了cgi-bin目录内的某个程序的名字,那是我们要运行的目标程序。程序名后面是一个问号以及CGI程序会在QUERY_STRING环境变量中查找的一个参数字符串(马上就要学到)。

我们发出任何形式的请求后,一般都会得到一个回应的HTML页。但若使用Java的URL对象,我们可以拦截自CGI程序传回的任何东西,只需从URL对象里取得一个InputStream(输入数据流)即可。这是用URL对象的openStream()方法实现,它要封装到一个DataInputStream里。随后就可以读取数据行,若readLine()返回一个null(空值),就表明CGI程序已结束了它的输出。 我们即将看到的CGI程序返回的仅仅是一行,它是用于标志成功与否(以及失败的具体原因)的一个字符串。这一行会被捕获并置放第二个Label字段里,使用户看到具体发生了什么事情。

(1) 从程序片里显示一个Web页

程序亦可将CGI程序的结果作为一个Web页显示出来,就象它们在普通HTML模式中运行那样。可用下述代码做到这一点:

  1. getAppletContext().showDocument(u);

其中,u代表URL对象。这是将我们重新定向于另一个Web页的一个简单例子。那个页凑巧是一个CGI程序的输出,但可以非常方便地进入一个原始的HTML页,所以可以构建这个程序片,令其产生一个由密码保护的网关,通过它进入自己Web站点的特殊部分:

  1. //: ShowHTML.java
  2. import java.awt.*;
  3. import java.applet.*;
  4. import java.net.*;
  5. import java.io.*;
  6. public class ShowHTML extends Applet {
  7. static final String CGIProgram = "MyCGIProgram";
  8. Button send = new Button("Go");
  9. Label l = new Label();
  10. public void init() {
  11. add(send);
  12. add(l);
  13. }
  14. public boolean action (Event evt, Object arg) {
  15. if(evt.target.equals(send)) {
  16. try {
  17. // This could be an HTML page instead of
  18. // a CGI program. Notice that this CGI
  19. // program doesn't use arguments, but
  20. // you can add them in the usual way.
  21. URL u = new URL(
  22. getDocumentBase(),
  23. "cgi-bin/" + CGIProgram);
  24. // Display the output of the URL using
  25. // the Web browser, as an ordinary page:
  26. getAppletContext().showDocument(u);
  27. } catch(Exception e) {
  28. l.setText(e.toString());
  29. }
  30. }
  31. else return super.action(evt, arg);
  32. return true;
  33. }
  34. } ///:~

URL类的最大的特点就是有效地保护了我们的安全。可以同一个Web服务器建立连接,毋需知道幕后的任何东西。

15.6.3 用C++写的CGI程序

经过前面的学习,大家应该能够根据例子用ANSI C为自己的服务器写出CGI程序。之所以选用ANSI C,是因为它几乎随处可见,是最流行的C语言标准。当然,现在的C++也非常流行了,特别是采用GNU C++编译器(g++)形式的那一些(注释④)。可从网上许多地方免费下载g++,而且可选用几乎所有平台的版本(通常与Linux那样的操作系统配套提供,且已预先安装好)。正如大家即将看到的那样,从CGI程序可获得面向对象程序设计的许多好处。

④:GNU的全称是“Gnu’s Not Unix”。这最早是由“自由软件基金会”(FSF)负责开发的一个项目,致力于用一个免费的版本取代原有的Unix操作系统。现在的Linux似乎正在做前人没有做到的事情。但GNU工具在Linux的开发中扮演了至关重要的角色。事实上,Linux的整套软件包附带了数量非常多的GNU组件。

为避免第一次就提出过多的新概念,这个程序并未打算成为一个“纯”C++程序;有些代码是用普通C写成的——尽管还可选用C++的一些替用形式。但这并不是个突出的问题,因为该程序用C++制作最大的好处就是能够创建类。在解析CGI信息的时候,由于我们最关心的是字段的“名称/值”对,所以要用一个类(Pair)来代表单个名称/值对;另一个类(CGI_vector)则将CGI字符串自动解析到它会容纳的Pair对象里(作为一个vector),这样即可在有空的时候把每个Pair(对)都取出来。

这个程序同时也非常有趣,因为它演示了C++与Java相比的许多优缺点。大家会看到一些相似的东西;比如class关键字。访问控制使用的是完全相同的关键字publicprivate,但用法却有所不同。它们控制的是一个块,而非单个方法或字段(也就是说,如果指定private:,后续的每个定义都具有private属性,直到我们再指定public:为止)。另外在创建一个类的时候,所有定义都自动默认为private

在这儿使用C++的一个原因是要利用C++“标准模板库”(STL)提供的便利。至少,STL包含了一个vector类。这是一个C++模板,可在编译期间进行配置,令其只容纳一种特定类型的对象(这里是Pair对象)。和Java的Vector不同,如果我们试图将除Pair对象之外的任何东西置入vector,C++的vector模板都会造成一个编译期错误;而Java的Vector能够照单全收。而且从vector里取出什么东西的时候,它会自动成为一个Pair对象,毋需进行转换处理。所以检查在编译期进行,这使程序显得更为“健壮”。此外,程序的运行速度也可以加快,因为没有必要进行运行期间的转换。vector也会重载operator[],所以可以利用非常方便的语法来提取Pair对象。vector模板将在CGI_vector创建时使用;在那时,大家就可以体会到如此简短的一个定义居然蕴藏有那么巨大的能量。

若提到缺点,就一定不要忘记Pair在下列代码中定义时的复杂程度。与我们在Java代码中看到的相比,Pair的方法定义要多得多。这是由于C++的程序员必须提前知道如何用副本构造器控制复制过程,而且要用重载的operator=完成赋值。正如第12章解释的那样,我们有时也要在Java中考虑同样的事情。但在C++中,几乎一刻都不能放松对这些问题的关注。

这个项目首先创建一个可以重复使用的部分,由C++头文件中的PairCGI_vector构成。从技术角度看,确实不应把这些东西都塞到一个头文件里。但就目前的例子来说,这样做不会造成任何方面的损害,而且更具有Java风格,所以大家阅读理解代码时要显得轻松一些:

  1. //: CGITools.h
  2. // Automatically extracts and decodes data
  3. // from CGI GETs and POSTs. Tested with GNU C++
  4. // (available for most server machines).
  5. #include <string.h>
  6. #include <vector> // STL vector
  7. using namespace std;
  8. // A class to hold a single name-value pair from
  9. // a CGI query. CGI_vector holds Pair objects and
  10. // returns them from its operator[].
  11. class Pair {
  12. char* nm;
  13. char* val;
  14. public:
  15. Pair() { nm = val = 0; }
  16. Pair(char* name, char* value) {
  17. // Creates new memory:
  18. nm = decodeURLString(name);
  19. val = decodeURLString(value);
  20. }
  21. const char* name() const { return nm; }
  22. const char* value() const { return val; }
  23. // Test for "emptiness"
  24. bool empty() const {
  25. return (nm == 0) || (val == 0);
  26. }
  27. // Automatic type conversion for boolean test:
  28. operator bool() const {
  29. return (nm != 0) && (val != 0);
  30. }
  31. // The following constructors & destructor are
  32. // necessary for bookkeeping in C++.
  33. // Copy-constructor:
  34. Pair(const Pair& p) {
  35. if(p.nm == 0 || p.val == 0) {
  36. nm = val = 0;
  37. } else {
  38. // Create storage & copy rhs values:
  39. nm = new char[strlen(p.nm) + 1];
  40. strcpy(nm, p.nm);
  41. val = new char[strlen(p.val) + 1];
  42. strcpy(val, p.val);
  43. }
  44. }
  45. // Assignment operator:
  46. Pair& operator=(const Pair& p) {
  47. // Clean up old lvalues:
  48. delete nm;
  49. delete val;
  50. if(p.nm == 0 || p.val == 0) {
  51. nm = val = 0;
  52. } else {
  53. // Create storage & copy rhs values:
  54. nm = new char[strlen(p.nm) + 1];
  55. strcpy(nm, p.nm);
  56. val = new char[strlen(p.val) + 1];
  57. strcpy(val, p.val);
  58. }
  59. return *this;
  60. }
  61. ~Pair() { // Destructor
  62. delete nm; // 0 value OK
  63. delete val;
  64. }
  65. // If you use this method outide this class,
  66. // you're responsible for calling 'delete' on
  67. // the pointer that's returned:
  68. static char*
  69. decodeURLString(const char* URLstr) {
  70. int len = strlen(URLstr);
  71. char* result = new char[len + 1];
  72. memset(result, len + 1, 0);
  73. for(int i = 0, j = 0; i <= len; i++, j++) {
  74. if(URLstr[i] == '+')
  75. result[j] = ' ';
  76. else if(URLstr[i] == '%') {
  77. result[j] =
  78. translateHex(URLstr[i + 1]) * 16 +
  79. translateHex(URLstr[i + 2]);
  80. i += 2; // Move past hex code
  81. } else // An ordinary character
  82. result[j] = URLstr[i];
  83. }
  84. return result;
  85. }
  86. // Translate a single hex character; used by
  87. // decodeURLString():
  88. static char translateHex(char hex) {
  89. if(hex >= 'A')
  90. return (hex & 0xdf) - 'A' + 10;
  91. else
  92. return hex - '0';
  93. }
  94. };
  95. // Parses any CGI query and turns it
  96. // into an STL vector of Pair objects:
  97. class CGI_vector : public vector<Pair> {
  98. char* qry;
  99. const char* start; // Save starting position
  100. // Prevent assignment and copy-construction:
  101. void operator=(CGI_vector&);
  102. CGI_vector(CGI_vector&);
  103. public:
  104. // const fields must be initialized in the C++
  105. // "Constructor initializer list":
  106. CGI_vector(char* query) :
  107. start(new char[strlen(query) + 1]) {
  108. qry = (char*)start; // Cast to non-const
  109. strcpy(qry, query);
  110. Pair p;
  111. while((p = nextPair()) != 0)
  112. push_back(p);
  113. }
  114. // Destructor:
  115. ~CGI_vector() { delete start; }
  116. private:
  117. // Produces name-value pairs from the query
  118. // string. Returns an empty Pair when there's
  119. // no more query string left:
  120. Pair nextPair() {
  121. char* name = qry;
  122. if(name == 0 || *name == '\0')
  123. return Pair(); // End, return null Pair
  124. char* value = strchr(name, '=');
  125. if(value == 0)
  126. return Pair(); // Error, return null Pair
  127. // Null-terminate name, move value to start
  128. // of its set of characters:
  129. *value = '\0';
  130. value++;
  131. // Look for end of value, marked by '&':
  132. qry = strchr(value, '&');
  133. if(qry == 0) qry = ""; // Last pair found
  134. else {
  135. *qry = '\0'; // Terminate value string
  136. qry++; // Move to next pair
  137. }
  138. return Pair(name, value);
  139. }
  140. }; ///:~

#include语句后,可看到有一行是:

  1. using namespace std;

C++中的“命名空间”(Namespace)解决了由Java的package负责的一个问题:将库名隐藏起来。std命名空间引用的是标准C++库,而vector就在这个库中,所以这一行是必需的。

Pair类表面看异常简单,只是容纳了两个(private)字符指针而已——一个用于名字,另一个用于值。默认构造器将这两个指针简单地设为零。这是由于在C++中,对象的内存不会自动置零。第二个构造器调用方法decodeURLString(),在新分配的堆内存中生成一个解码过后的字符串。这个内存区域必须由对象负责管理及清除,这与“析构器”中见到的相同。name()value()方法为相关的字段产生只读指针。利用empty()方法,我们查询Pair对象它的某个字段是否为空;返回的结果是一个bool——C++内建的基本布尔数据类型。operator bool()使用的是C++“运算符重载”的一种特殊形式。它允许我们控制自动类型转换。如果有一个名为pPair对象,而且在一个本来希望是布尔结果的表达式中使用,比如if(p){//...,那么编译器能辨别出它有一个Pair,而且需要的是个布尔值,所以自动调用operator bool(),进行必要的转换。

接下来的三个方法属于常规编码,在C++中创建类时必须用到它们。根据C++类采用的所谓“经典形式”,我们必须定义必要的“原始”构造器,以及一个副本构造器和赋值运算符——operator=(以及析构器,用于清除内存)。之所以要作这样的定义,是由于编译器会“默默”地调用它们。在对象传入、传出一个函数的时候,需要调用副本构造器;而在分配对象时,需要调用赋值运算符。只有真正掌握了副本构造器和赋值运算符的工作原理,才能在C++里写出真正“健壮”的类,但这需要需要一个比较艰苦的过程(注释⑤)。

⑤:我的《Thinking in C++》(Prentice-Hall,1995)用了一整章的地方来讨论这个主题。若需更多的帮助,请务必看看那一章。

只要将一个对象按值传入或传出函数,就会自动调用副本构造器Pair(const Pair&)。也就是说,对于准备为其制作一个完整副本的那个对象,我们不准备在函数框架中传递它的地址。这并不是Java提供的一个选项,由于我们只能传递引用,所以在Java里没有所谓的副本构造器(如果想制作一个本地副本,可以“克隆”那个对象——使用clone(),参见第12章)。类似地,如果在Java里分配一个引用,它会简单地复制。但C++中的赋值意味着整个对象都会复制。在副本构造器中,我们创建新的存储空间,并复制原始数据。但对于赋值运算符,我们必须在分配新存储空间之前释放老存储空间。我们要见到的也许是C++类最复杂的一种情况,但那正是Java的支持者们论证Java比C++简单得多的有力证据。在Java中,我们可以自由传递引用,善后工作则由垃圾收集器负责,所以可以轻松许多。

但事情并没有完。Pair类为nmval使用的是char*,最复杂的情况主要是围绕指针展开的。如果用较时髦的C++ string类来代替 char* ,事情就要变得简单得多(当然,并不是所有编译器都提供了对string的支持)。那么,Pair的第一部分看起来就象下面这样:

  1. class Pair {
  2. string nm;
  3. string val;
  4. public:
  5. Pair() { }
  6. Pair(char* name, char* value) {
  7. nm = decodeURLString(name);
  8. val = decodeURLString(value);
  9. }
  10. const char* name() const { return nm.c_str(); }
  11. const char* value() const {
  12. return val.c_str();
  13. }
  14. // Test for "emptiness"
  15. bool empty() const {
  16. return (nm.length() == 0)
  17. || (val.length() == 0);
  18. }
  19. // Automatic type conversion for boolean test:
  20. operator bool() const {
  21. return (nm.length() != 0)
  22. && (val.length() != 0);
  23. }

(此外,对这个类decodeURLString()会返回一个string,而不是一个char*)。我们不必定义副本构造器、operator=或者析构器,因为编译器已帮我们做了,而且做得非常好。但即使有些事情是自动进行的,C++程序员也必须了解副本构建以及赋值的细节。

Pair类剩下的部分由两个方法构成:decodeURLString()以及一个“帮助器”方法translateHex()——将由decodeURLString()使用。注意translateHex()并不能防范用户的恶意输入,比如%1H。分配好足够的存储空间后(必须由析构器释放),decodeURLString()就会其中遍历,将所有+都换成一个空格;将所有十六进制代码(以一个%打头)换成对应的字符。

CGI_vector用于解析和容纳整个CGI GET命令。它是从STLvector里继承的,后者例示为容纳Pair。C++中的继承是用一个冒号表示,在Java中则要用extends。此外,继承默认为private属性,所以几乎肯定需要用到public关键字,就象这样做的那样。大家也会发现CGI_vector有一个副本构造器以及一个operator=,但它们都声明成private。这样做是为了防止编译器同步两个函数(如果不自己声明它们,两者就会同步)。但这同时也禁止了客户程序员按值或者通过赋值传递一个CGI_vector

CGI_vector的工作是获取QUERY_STRING,并把它解析成“名称/值”对,这需要在Pair的帮助下完成。它首先将字符串复制到本地分配的内存,并用常数指针start跟踪起始地址(稍后会在析构器中用于释放内存)。随后,它用自己的nextPair()方法将字符串解析成原始的“名称/值”对,各个对之间用一个=&符号分隔。这些对由nextPair()传递给Pair构造器,所以nextPair()返回的是一个Pair对象。随后用push_back()将该对象加入vectornextPair()遍历完整个QUERY_STRING后,会返回一个零值。

现在基本工具已定义好,它们可以简单地在一个CGI程序中使用,就象下面这样:

  1. //: Listmgr2.cpp
  2. // CGI version of Listmgr.c in C++, which
  3. // extracts its input via the GET submission
  4. // from the associated applet. Also works as
  5. // an ordinary CGI program with HTML forms.
  6. #include <stdio.h>
  7. #include "CGITools.h"
  8. const char* dataFile = "list2.txt";
  9. const char* notify = "Bruce@EckelObjects.com";
  10. #undef DEBUG
  11. // Similar code as before, except that it looks
  12. // for the email name inside of '<>':
  13. int inList(FILE* list, const char* emailName) {
  14. const int BSIZE = 255;
  15. char lbuf[BSIZE];
  16. char emname[BSIZE];
  17. // Put the email name in '<>' so there's no
  18. // possibility of a match within another name:
  19. sprintf(emname, "<%s>", emailName);
  20. // Go to the beginning of the list:
  21. fseek(list, 0, SEEK_SET);
  22. // Read each line in the list:
  23. while(fgets(lbuf, BSIZE, list)) {
  24. // Strip off the newline:
  25. char * newline = strchr(lbuf, '\n');
  26. if(newline != 0)
  27. *newline = '\0';
  28. if(strstr(lbuf, emname) != 0)
  29. return 1;
  30. }
  31. return 0;
  32. }
  33. void main() {
  34. // You MUST print this out, otherwise the
  35. // server will not send the response:
  36. printf("Content-type: text/plain\n\n");
  37. FILE* list = fopen(dataFile, "a+t");
  38. if(list == 0) {
  39. printf("error: could not open database. ");
  40. printf("Notify %s", notify);
  41. return;
  42. }
  43. // For a CGI "GET," the server puts the data
  44. // in the environment variable QUERY_STRING:
  45. CGI_vector query(getenv("QUERY_STRING"));
  46. #if defined(DEBUG)
  47. // Test: dump all names and values
  48. for(int i = 0; i < query.size(); i++) {
  49. printf("query[%d].name() = [%s], ",
  50. i, query[i].name());
  51. printf("query[%d].value() = [%s]\n",
  52. i, query[i].value());
  53. }
  54. #endif(DEBUG)
  55. Pair name = query[0];
  56. Pair email = query[1];
  57. if(name.empty() || email.empty()) {
  58. printf("error: null name or email");
  59. return;
  60. }
  61. if(inList(list, email.value())) {
  62. printf("Already in list: %s", email.value());
  63. return;
  64. }
  65. // It's not in the list, add it:
  66. fseek(list, 0, SEEK_END);
  67. fprintf(list, "%s <%s>;\n",
  68. name.value(), email.value());
  69. fflush(list);
  70. fclose(list);
  71. printf("%s <%s> added to list\n",
  72. name.value(), email.value());
  73. } ///:~

alreadyInList()函数与前一个版本几乎是完全相同的,只是它假定所有电子函件地址都在一个<>内。

在使用GET方法时(通过在FORM引导命令的METHOD标记内部设置,但这在这里由数据发送的方式控制),Web服务器会收集位于?后面的所有信息,并把它们置入环境变量QUERY_STRING(查询字符串)里。所以为了读取那些信息,必须获得QUERY_STRING的值,这是用标准的C库函数getenv()完成的。在main()中,注意对QUERY_STRING的解析有多么容易:只需把它传递给用于CGI_vector对象的构造器(名为query),剩下的所有工作都会自动进行。从这时开始,我们就可以从query中取出名称和值,把它们当作数组看待(这是由于operator[]vector里已经重载了)。在调试代码中,大家可看到这一切是如何运作的;调试代码封装在预处理器引导命令#if defined(DEBUG)#endif(DEBUG)之间。

现在,我们迫切需要掌握一些与CGI有关的东西。CGI程序用两个方式之一传递它们的输入:在GET执行期间通过QUERY_STRING传递(目前用的这种方式),或者在POST期间通过标准输入。但CGI程序通过标准输出发送自己的输出,这通常是用C程序的printf()命令实现的。那么这个输出到哪里去了呢?它回到了Web服务器,由服务器决定该如何处理它。服务器作出决定的依据是content-type(内容类型)头数据。这意味着假如content-type头不是它看到的第一件东西,就不知道该如何处理收到的数据。因此,我们无论如何也要使所有CGI程序都从content-type头开始输出。

在目前这种情况下,我们希望服务器将所有信息都直接反馈回客户程序(亦即我们的程序片,它们正在等候给自己的回复)。信息应该原封不动,所以content-type设为text/plain(纯文本)。一旦服务器看到这个头,就会将所有字符串都直接发还给客户。所以每个字符串(三个用于出错条件,一个用于成功的加入)都会返回程序片。

我们用相同的代码添加电子函件名称(用户的姓名)。但在CGI脚本的情况下,并不存在无限循环——程序只是简单地响应,然后就中断。每次有一个CGI请求抵达时,程序都会启动,对那个请求作出反应,然后自行关闭。所以CPU不可能陷入空等待的尴尬境地,只有启动程序和打开文件时才存在性能上的隐患。Web服务器对CGI请求进行控制时,它的开销会将这种隐患减轻到最低程度。

这种设计的另一个好处是由于PairCGI_vector都得到了定义,大多数工作都帮我们自动完成了,所以只需修改main()即可轻松创建自己的CGI程序。尽管小服务程序(Servlet)最终会变得越来越流行,但为了创建快速的CGI程序,C++仍然显得非常方便。

15.6.4 POST的概念

在许多应用程序中使用GET都没有问题。但是,GET要求通过一个环境变量将自己的数据传递给CGI程序。但假如GET字符串过长,有些Web服务器可能用光自己的环境空间(若字符串长度超过200字符,就应开始关心这方面的问题)。CGI为此提供了一个解决方案:POST。通过POST,数据可以编码,并按与GET相同的方法连结起来。但POST利用标准输入将编码过后的查询字符串传递给CGI程序。我们要做的全部事情就是判断查询字符串的长度,而这个长度已在环境变量CONTENT_LENGTH中保存好了。一旦知道了长度,就可自由分配存储空间,并从标准输入中读入指定数量的字符。

对一个用来控制POST的CGI程序,由CGITools.h提供的PairCGI_vector均可不加丝毫改变地使用。下面这段程序揭示了写这样的一个CGI程序有多么简单。这个例子将采用“纯”C++,所以studio.h库被iostream(IO数据流)代替。对于iostream,我们可以使用两个预先定义好的对象:cin,用于同标准输入连接;以及cout,用于同标准输出连接。有几个办法可从cin中读入数据以及向cout中写入。但下面这个程序准备采用标准方法:用<<将信息发给cout,并用一个成员函数(此时是read())从cin中读入数据:

  1. //: POSTtest.cpp
  2. // CGI_vector works as easily with POST as it
  3. // does with GET. Written in "pure" C++.
  4. #include <iostream.h>
  5. #include "CGITools.h"
  6. void main() {
  7. cout << "Content-type: text/plain\n" << endl;
  8. // For a CGI "POST," the server puts the length
  9. // of the content string in the environment
  10. // variable CONTENT_LENGTH:
  11. char* clen = getenv("CONTENT_LENGTH");
  12. if(clen == 0) {
  13. cout << "Zero CONTENT_LENGTH" << endl;
  14. return;
  15. }
  16. int len = atoi(clen);
  17. char* query_str = new char[len + 1];
  18. cin.read(query_str, len);
  19. query_str[len] = '\0';
  20. CGI_vector query(query_str);
  21. // Test: dump all names and values
  22. for(int i = 0; i < query.size(); i++)
  23. cout << "query[" << i << "].name() = [" <<
  24. query[i].name() << "], " <<
  25. "query[" << i << "].value() = [" <<
  26. query[i].value() << "]" << endl;
  27. delete query_str; // Release storage
  28. } ///:~

getenv()函数返回指向一个字符串的指针,那个字符串指示着内容的长度。若指针为零,表明CONTENT_LENGTH环境变量尚未设置,所以肯定某个地方出了问题。否则就必须用ANSI C库函数atoi()将字符串转换成一个整数。这个长度将与new一起运用,分配足够的存储空间,以便容纳查询字符串(另加它的空中止符)。随后为cin()调用read()read()函数需要取得指向目标缓冲区的一个指针以及要读入的字节数。随后用空字符(null)中止query_str,指出已经抵达字符串的末尾,这就叫作“空中止”。

到这个时候,我们得到的查询字符串与GET查询字符串已经没有什么区别,所以把它传递给用于CGI_vector的构造器。随后便和前例一样,我们可以自由·内不同的字段。

为测试这个程序,必须把它编译到主机Web服务器的cgi-bin目录下。然后就可以写一个简单的HTML页进行测试,就象下面这样:

  1. <HTML>
  2. <HEAD>
  3. <META CONTENT="text/html">
  4. <TITLE>A test of standard HTML POST</TITLE>
  5. </HEAD>
  6. Test, uses standard html POST
  7. <Form method="POST" ACTION="/cgi-bin/POSTtest">
  8. <P>Field1: <INPUT TYPE = "text" NAME = "Field1"
  9. VALUE = "" size = "40"></p>
  10. <P>Field2: <INPUT TYPE = "text" NAME = "Field2"
  11. VALUE = "" size = "40"></p>
  12. <P>Field3: <INPUT TYPE = "text" NAME = "Field3"
  13. VALUE = "" size = "40"></p>
  14. <P>Field4: <INPUT TYPE = "text" NAME = "Field4"
  15. VALUE = "" size = "40"></p>
  16. <P>Field5: <INPUT TYPE = "text" NAME = "Field5"
  17. VALUE = "" size = "40"></p>
  18. <P>Field6: <INPUT TYPE = "text" NAME = "Field6"
  19. VALUE = "" size = "40"></p>
  20. <p><input type = "submit" name = "submit" > </p>
  21. </Form>
  22. </HTML>

填好这个表单并提交出去以后,会得到一个简单的文本页,其中包含了解析出来的结果。从中可知道CGI程序是否在正常工作。

当然,用一个程序片来提交数据显得更有趣一些。然而,POST数据的提交属于一个不同的过程。在用常规方式调用了CGI程序以后,必须另行建立与服务器的一个连接,以便将查询字符串反馈给它。服务器随后会进行一番处理,再通过标准输入将查询字符串反馈回CGI程序。

为建立与服务器的一个直接连接,必须取得自己创建的URL,然后调用openConnection()创建一个URLConnection。但是,由于URLConnection一般不允许我们把数据发给它,所以必须很可笑地调用setDoOutput(true)函数,同时调用的还包括setDoInput(true)以及setAllowUserInteraction(false)——注释⑥。最后,可调用getOutputStream()来创建一个OutputStream(输出数据流),并把它封装到一个DataOutputStream里,以便能按传统方式同它通信。下面列出的便是一个用于完成上述工作的程序片,必须在从它的各个字段里收集了数据之后再执行它:

  1. //: POSTtest.java
  2. // An applet that sends its data via a CGI POST
  3. import java.awt.*;
  4. import java.applet.*;
  5. import java.net.*;
  6. import java.io.*;
  7. public class POSTtest extends Applet {
  8. final static int SIZE = 10;
  9. Button submit = new Button("Submit");
  10. TextField[] t = new TextField[SIZE];
  11. String query = "";
  12. Label l = new Label();
  13. TextArea ta = new TextArea(15, 60);
  14. public void init() {
  15. Panel p = new Panel();
  16. p.setLayout(new GridLayout(t.length + 2, 2));
  17. for(int i = 0; i < t.length; i++) {
  18. p.add(new Label(
  19. "Field " + i + " ", Label.RIGHT));
  20. p.add(t[i] = new TextField(30));
  21. }
  22. p.add(l);
  23. p.add(submit);
  24. add("North", p);
  25. add("South", ta);
  26. }
  27. public boolean action (Event evt, Object arg) {
  28. if(evt.target.equals(submit)) {
  29. query = "";
  30. ta.setText("");
  31. // Encode the query from the field data:
  32. for(int i = 0; i < t.length; i++)
  33. query += "Field" + i + "=" +
  34. URLEncoder.encode(
  35. t[i].getText().trim()) +
  36. "&";
  37. query += "submit=Submit";
  38. // Send the name using CGI's POST process:
  39. try {
  40. URL u = new URL(
  41. getDocumentBase(), "cgi-bin/POSTtest");
  42. URLConnection urlc = u.openConnection();
  43. urlc.setDoOutput(true);
  44. urlc.setDoInput(true);
  45. urlc.setAllowUserInteraction(false);
  46. DataOutputStream server =
  47. new DataOutputStream(
  48. urlc.getOutputStream());
  49. // Send the data
  50. server.writeBytes(query);
  51. server.close();
  52. // Read and display the response. You
  53. // cannot use
  54. // getAppletContext().showDocument(u);
  55. // to display the results as a Web page!
  56. DataInputStream in =
  57. new DataInputStream(
  58. urlc.getInputStream());
  59. String s;
  60. while((s = in.readLine()) != null) {
  61. ta.appendText(s + "\n");
  62. }
  63. in.close();
  64. }
  65. catch (Exception e) {
  66. l.setText(e.toString());
  67. }
  68. }
  69. else return super.action(evt, arg);
  70. return true;
  71. }
  72. } ///:~

⑥:我不得不说自己并没有真正理解这儿都发生了什么事情,这些概念都是从Elliotte Rusty Harold编著的《Java Network Programming》里得来的,该书由O’Reilly于1997年出版。他在书中提到了Java连网函数库中出现的许多令人迷惑的Bug。所以一旦涉足这些领域,事情就不是编写代码,然后让它自己运行那么简单。一定要警惕潜在的陷阱!

信息发送到服务器后,我们调用getInputStream(),并把返回值封装到一个DataInputStream里,以便自己能读取结果。要注意的一件事情是结果以文本行的形式显示在一个TextArea(文本区域)中。为什么不简单地使用getAppletContext().showDocument(u)呢?事实上,这正是那些陷阱中的一个。上述代码可以很好地工作,但假如试图换用showDocument(),几乎一切都会停止运行。也就是说,showDocument()确实可以运行,但从POSTtest得到的返回结果是Zero CONTENT_LENGTH(内容长度为零)。所以不知道为什么原因,showDocument()阻止了POST查询向CGI程序的传递。我很难判断这到底是一个在以后版本里会修复的Bug,还是由于我的理解不够(我看过的书对此讲得都很模糊)。但无论在哪种情况下,只要能坚持在文本区域里观看自CGI程序返回的内容,上述程序片运行时就没有问题。