Python3 CGI 编程

什么是 CGI

CGI 目前由 NCSA 维护，NCSA 定义 CGI 如下：

CGI(Common Gateway Interface),通用网关接口,它是一段程序,运行在服务器上如：HTTP服务器，提供同客户端 HTML 页面的接口。

网页浏览

为了更好的了解 CGI 是如何工作的，我们可以从在网页上点击一个链接或 URL 的流程：

  • 1、使用你的浏览器访问 URL 并连接到 HTTP web 服务器。
  • 2、Web 服务器接收到请求信息后会解析 URL，并查找访问的文件在服务器上是否存在，如果存在返回文件的内容，否则返回错误信息。
  • 3、浏览器从服务器上接收信息，并显示接收的文件或者错误信息。

CGI 程序可以是 Python 脚本，PERL 脚本，SHELL 脚本，C 或者 C++ 程序等。

CGI 架构图

cgiarch

Web 服务器支持及配置

在你进行 CGI 编程前，确保您的 Web 服务器支持 CGI 及已经配置了 CGI 的处理程序。

Apache 支持 CGI 配置：

设置好 CGI 目录：

  1. ScriptAlias /cgi-bin/ /var/www/cgi-bin/

所有的 HTTP 服务器执行 CGI 程序都保存在一个预先配置的目录。这个目录被称为 CGI 目录，并按照惯例，它被命名为 /var/www/cgi-bin 目录。

CGI 文件的扩展名为 .cgi，Python 也可以使用 .py 扩展名。

默认情况下，Linux 服务器配置运行的 cgi-bin 目录中为 /var/www。

如果你想指定其他运行 CGI 脚本的目录，可以修改 httpd.conf 配置文件，如下所示：

  1. <Directory "/var/www/cgi-bin">
  2.    AllowOverride None
  3.    Options +ExecCGI
  4.    Order allow,deny
  5.    Allow from all
  6. </Directory>

在 AddHandler 中添加 .py 后缀，这样我们就可以访问 .py 结尾的 python 脚本文件：

  1. AddHandler cgi-script .cgi .pl .py

第一个CGI程序

我们使用 Python 创建第一个 CGI 程序，文件名为 hello.py，文件位于 /var/www/cgi-bin目录中，内容如下：

  1. #!/usr/bin/python3
  2. #coding=utf-8
  3. print ('<html>')
  4. print ('<head>')
  5. print ('<meta charset="utf-8">')
  6. print ('<title>Hello Word - 我的第一个 CGI 程序！</title>')
  7. print ('</head>')
  8. print ('<body>')
  9. print ('<h2>Hello Word! 我的第一CGI程序</h2>')
  10. print ('</body>')
  11. print ('</html>')

文件保存后修改 hello.py，修改文件权限为 755：

  1. chmod 755 hello.py

以上程序在浏览器访问显示结果如下：

3E82A06B-FE1F-49B9-969C-183FABD56363

这个的 hello.py 脚本是一个简单的 Python 脚本，脚本第一行的输出内容"Content-type:text/html"发送到浏览器并告知浏览器显示的内容类型为"text/html"。

用 print 输出一个空行用于告诉服务器结束头部信息。

HTTP头部

hello.py 文件内容中的" Content-type:text/html"即为 HTTP 头部的一部分，它会发送给浏览器告诉浏览器文件的内容类型。

HTTP 头部的格式如下：

  1. HTTP 字段名: 字段内容

例如：

  1. Content-type: text/html

以下表格介绍了 CGI 程序中 HTTP 头部经常使用的信息：

头描述
Content-type:请求的与实体对应的 MIME 信息。例如: Content-type:text/html
Expires: Date响应过期的日期和时间
Location: URL用来重定向接收方到非请求URL的位置来完成请求或标识新的资源
Last-modified: Date请求资源的最后修改时间
Content-length: N请求的内容长度
Set-Cookie: String设置 Http Cookie

CGI 环境变量

所有的 CGI 程序都接收以下的环境变量，这些变量在 CGI 程序中发挥了重要的作用：

变量名描述
CONTENT_TYPE这个环境变量的值指示所传递来的信息的 MIME 类型。目前，环境变量 CONTENT_TYPE 一般都是：application/x-www-form-urlencoded,他表示数据来自于 HTML 表单。
CONTENT_LENGTH如果服务器与 CGI 程序信息的传递方式是 POST，这个环境变量即使从标准输入 STDIN 中可以读到的有效数据的字节数。这个环境变量在读取所输入的数据时必须使用。
HTTP_COOKIE客户机内的 COOKIE 内容。
HTTP_USER_AGENT提供包含了版本数或其他专有数据的客户浏览器信息。
PATH_INFO这个环境变量的值表示紧接在 CGI 程序名之后的其他路径信息。它常常作为 CGI 程序的参数出现。
QUERY_STRING如果服务器与 CGI 程序信息的传递方式是 GET，这个环境变量的值即使所传递的信息。这个信息经跟在 CGI 程序名的后面，两者中间用一个问号'?'分隔。
REMOTE_ADDR这个环境变量的值是发送请求的客户机的IP地址，例如上面的192.168.1.67。这个值总是存在的。而且它是 Web 客户机需要提供给Web服务器的唯一标识，可以在 CGI 程序中用它来区分不同的 Web 客户机。
REMOTE_HOST这个环境变量的值包含发送 CGI 请求的客户机的主机名。如果不支持你想查询，则无需定义此环境变量。
REQUEST_METHOD提供脚本被调用的方法。对于使用 HTTP/1.0 协议的脚本，仅 GET 和 POST 有意义。
SCRIPT_FILENAMECGI 脚本的完整路径
SCRIPT_NAMECGI 脚本的的名称
SERVER_NAME这是你的 WEB 服务器的主机名、别名或IP地址。
SERVER_SOFTWARE这个环境变量的值包含了调用 CGI 程序的 HTTP 服务器的名称和版本号。例如，上面的值为 Apache/2.2.14(Unix)

以下是一个简单的 CGI 脚本输出 CGI 的环境变量：

  1. #!/usr/bin/python3
  2. #coding=utf-8
  3. import os
  5. print ("Content-type: text/html")
  6. print ()
  7. print ("<meta charset=\"utf-8\">")
  8. print ("<b>环境变量</b><br>")
  9. print ("<ul>")
  10. for key in os.environ.keys():
  11.     print ("<li><span style='color:green'>%30s </span> : %s </li>" % (key,os.environ[key]))
  12. print ("</ul>")

将以上点保存为 test.py ,并修改文件权限为 755，执行结果如下：

Python3 CGI 编程 - 图3

GET 和 POST 方法

浏览器客户端通过两种方法向服务器传递信息，这两种方法就是 GET 方法和 POST 方法。

使用 GET 方法传输数据

GET 方法发送编码后的用户信息到服务端，数据信息包含在请求页面的 URL 上，以"?"号分割, 如下所示：

  1. http://www.test.com/cgi-bin/hello.py?key1=value1&key2=value2

有关 GET 请求的其他一些注释：

  • GET 请求可被缓存
  • GET 请求保留在浏览器历史记录中
  • GET 请求可被收藏为书签
  • GET 请求不应在处理敏感数据时使用
  • GET 请求有长度限制
  • GET 请求只应当用于取回数据

简单的 url 实例：GET 方法

以下是一个简单的 URL，使用 GET 方法向 hello_get.py 程序发送两个参数：

  1. /cgi-bin/test.py?name=python3教程&url=http://www.yousite.com

以下为 hello_get.py 文件的代码：

  1. #!/usr/bin/python3
  2. #coding=utf-8
  4. # CGI处理模块
  5. import cgi, cgitb 
  7. # 创建 FieldStorage 的实例化
  8. form = cgi.FieldStorage() 
  10. # 获取数据
  11. site_name = form.getvalue('name')
  12. site_url  = form.getvalue('url')
  14. print ("Content-type:text/html")
  15. print ()
  16. print ("<html>")
  17. print ("<head>")
  18. print ("<meta charset=\"utf-8\">")
  19. print ("<title>Python3 教程 CGI 测试实例</title>")
  20. print ("</head>")
  21. print ("<body>")
  22. print ("<h2>%s官网：%s</h2>" % (site_name, site_url))
  23. print ("</body>")
  24. print ("</html>")

文件保存后修改 hello_get.py，修改文件权限为 755：

  1. chmod 755 hello_get.py

浏览器请求输出结果：

Python3 CGI 编程 - 图4

简单的表单实例：GET 方法

以下是一个通过 HTML 的表单使用 GET 方法向服务器发送两个数据，提交的服务器脚本同样是 hello_get.py 文件，hello_get.html 代码如下：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3 教程</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/hello_get.py" method="get">
  9. 站点名称: <input type="text" name="name">  <br />
  11. 站点 URL: <input type="text" name="url" />
  12. <input type="submit" value="提交" />
  13. </form>
  14. </body>
  15. </html>

默认情况下 cgi-bin 目录只能存放脚本文件，我们将 hello_get.html 存储在 test 目录下，修改文件权限为 755：

  1. chmod 755 hello_get.html

Gif 演示如下所示：

Python3 CGI 编程 - 图5

使用 POST 方法传递数据

使用 POST 方法向服务器传递数据是更安全可靠的，像一些敏感信息如用户密码等需要使用 POST 传输数据。

以下同样是 hello_get.py ，它也可以处理浏览器提交的 POST 表单数据:

  1. #!/usr/bin/python3
  2. #coding=utf-8
  4. # CGI处理模块
  5. import cgi, cgitb 
  7. # 创建 FieldStorage 的实例化
  8. form = cgi.FieldStorage() 
  10. # 获取数据
  11. site_name = form.getvalue('name')
  12. site_url  = form.getvalue('url')
  14. print ("Content-type:text/html")
  15. print ()
  16. print ("<html>")
  17. print ("<head>")
  18. print ("<meta charset=\"utf-8\">")
  19. print ("<title>Python3 教程 CGI 测试实例</title>")
  20. print ("</head>")
  21. print ("<body>")
  22. print ("<h2>%s官网：%s</h2>" % (site_name, site_url))
  23. print ("</body>")
  24. print ("</html>")

以下为表单通过 POST 方法（method="post"）向服务器脚本 hello_get.py 提交数据:

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/hello_get.py" method="post">
  9. 站点名称: <input type="text" name="name">  <br />
  11. 站点 URL: <input type="text" name="url" />
  12. <input type="submit" value="提交" />
  13. </form>
  14. </body>
  15. </html>
  16. </form>

Gif 演示如下所示：

Python3 CGI 编程 - 图6

通过 CGI 程序传递 checkbox 数据

checkbox 用于提交一个或者多个选项数据，HTML 代码如下：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/checkbox.py" method="POST" target="_blank">
  9. <input type="checkbox" name="youj" value="on" /> Python3 教程
  10. <input type="checkbox" name="google" value="on" /> Google
  11. <input type="submit" value="选择站点" />
  12. </form>
  13. </body>
  14. </html>

以下为 checkbox.py 文件的代码：

  1. #!/usr/bin/python3
  3. # 引入 CGI 处理模块 
  4. import cgi, cgitb 
  6. # 创建 FieldStorage的实例 
  7. form = cgi.FieldStorage() 
  9. # 接收字段数据
  10. if form.getvalue('google'):
  11.    google_flag = "是"
  12. else:
  13.    google_flag = "否"
  15. if form.getvalue('youj'):
  16.    youj_flag = "是"
  17. else:
  18.    youj_flag = "否"
  20. print ("Content-type:text/html")
  21. print ()
  22. print ("<html>")
  23. print ("<head>")
  24. print ("<meta charset=\"utf-8\">")
  25. print ("<title>Python3 教程 CGI 测试实例</title>")
  26. print ("</head>")
  27. print ("<body>")
  28. print ("<h2> Python3 教程是否选择了 : %s</h2>" % youj_flag)
  29. print ("<h2> Google 是否选择了 : %s</h2>" % google_flag)
  30. print ("</body>")
  31. print ("</html>")

修改 checkbox.py 权限：

  1. chmod 755 checkbox.py

浏览器访问 Gif 演示图：

Python3 CGI 编程 - 图7

通过 CGI 程序传递 Radio 数据

Radio 只向服务器传递一个数据，HTML 代码如下：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3 教程</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/radiobutton.py" method="post" target="_blank">
  9. <input type="radio" name="site" value="youj" /> Python3 教程
  10. <input type="radio" name="site" value="google" /> Google
  11. <input type="submit" value="提交" />
  12. </form>
  13. </body>
  14. </html>

radiobutton.py 脚本代码如下：

  1. #!/usr/bin/python3
  3. # 引入 CGI 处理模块 
  4. import cgi, cgitb 
  6. # 创建 FieldStorage的实例 
  7. form = cgi.FieldStorage() 
  9. # 接收字段数据
  10. if form.getvalue('site'):
  11.    site = form.getvalue('site')
  12. else:
  13.    site = "提交数据为空"
  15. print ("Content-type:text/html")
  16. print ()
  17. print ("<html>")
  18. print ("<head>")
  19. print ("<meta charset=\"utf-8\">")
  20. print ("<title>Python3 教程 CGI 测试实例</title>")
  21. print ("</head>")
  22. print ("<body>")
  23. print ("<h2> 选中的网站是 %s</h2>" % site)
  24. print ("</body>")
  25. print ("</html>")

修改 radiobutton.py 权限：

  1. chmod 755 radiobutton.py

浏览器访问 Gif 演示图：

Python3 CGI 编程 - 图8

通过 CGI 程序传递 Textarea 数据

Textarea 向服务器传递多行数据，HTML 代码如下：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3 教程</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/textarea.py" method="post" target="_blank">
  9. <textarea name="textcontent" cols="40" rows="4">
  10. 在这里输入内容...
  11. </textarea>
  12. <input type="submit" value="提交" />
  13. </form>
  14. </body>
  15. </html>

textarea.py 脚本代码如下：

  1. #!/usr/bin/python3
  3. # 引入 CGI 处理模块 
  4. import cgi, cgitb 
  6. # 创建 FieldStorage的实例 
  7. form = cgi.FieldStorage() 
  9. # 接收字段数据
  10. if form.getvalue('textcontent'):
  11.    text_content = form.getvalue('textcontent')
  12. else:
  13.    text_content = "没有内容"
  15. print ("Content-type:text/html")
  16. print ()
  17. print ("<html>")
  18. print ("<head>")
  19. print ("<meta charset=\"utf-8\">")
  20. print ("<title>Python3 教程 CGI 测试实例</title>")
  21. print ("</head>")
  22. print ("<body>")
  23. print ("<h2> 输入的内容是：%s</h2>" % text_content)
  24. print ("</body>")
  25. print ("</html>")

修改 textarea.py 权限：

  1. chmod 755 textarea.py

浏览器访问 Gif 演示图：

Python3 CGI 编程 - 图9

通过 CGI 程序传递下拉数据。

HTML 下拉框代码如下：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Python3 教程</title>
  6. </head>
  7. <body>
  8. <form action="/cgi-bin/dropdown.py" method="post" target="_blank">
  9. <select name="dropdown">
  10. <option value="youj" selected>Python3 教程</option>
  11. <option value="google">Google</option>
  12. </select>
  13. <input type="submit" value="提交"/>
  14. </form>
  15. </body>
  16. </html>

dropdown.py 脚本代码如下所示：

  1. #!/usr/bin/python3
  3. # 引入 CGI 处理模块 
  4. import cgi, cgitb 
  6. # 创建 FieldStorage的实例 
  7. form = cgi.FieldStorage() 
  9. # 接收字段数据
  10. if form.getvalue('dropdown'):
  11.    dropdown_value = form.getvalue('dropdown')
  12. else:
  13.    dropdown_value = "没有内容"
  15. print ("Content-type:text/html")
  16. print ()
  17. print ("<html>")
  18. print ("<head>")
  19. print ("<meta charset=\"utf-8\">")
  20. print ("<title>Python3 教程 CGI 测试实例</title>")
  21. print ("</head>")
  22. print ("<body>")
  23. print ("<h2> 选中的选项是：%s</h2>" % dropdown_value)
  24. print ("</body>")
  25. print ("</html>")

修改 dropdown.py 权限：

  1. chmod 755 dropdown.py

浏览器访问 Gif 演示图：

Python3 CGI 编程 - 图10

CGI 中使用 Cookie

在 http 协议一个很大的缺点就是不对用户身份的进行判断，这样给编程人员带来很大的不便，而 cookie 功能的出现弥补了这个不足。

cookie 就是在客户访问脚本的同时，通过客户的浏览器，在客户硬盘上写入纪录数据 ，当下次客户访问脚本时取回数据信息，从而达到身份判别的功能，cookie 常用在身份校验中。

cookie 的语法

http cookie 的发送是通过 http 头部来实现的，他早于文件的传递，头部s et-cookie 的语法如下：

  1. Set-cookie:name=name;expires=date;path=path;domain=domain;secure
  • name=name: 需要设置cookie的值(name不能使用";"和","号),有多个name值时用 ";" 分隔，例如：name1=name1;name2=name2;name3=name3。
  • expires=date: cookie的有效期限,格式： expires="Wdy,DD-Mon-YYYY HH:MM:SS"
  • path=path: 设置 cookie 支持的路径,如果path是一个路径，则 cookie 对这个目录下的所有文件及子目录生效，例如： path="/cgi-bin/"，如果path是一个文件，则cookie指对这个文件生效，例如：path="/cgi-bin/cookie.cgi"。
  • domain=domain: 对 cookie 生效的域名，例如：domain="www.baidu.como"
  • secure: 如果给出此标志，表示cookie只能通过SSL协议的https服务器来传递。
  • cookie的接收是通过设置环境变量 HTTP_COOKIE 来实现的，CGI 程序可以通过检索该变量获取 cookie 信息。

Cookie 设置

Cookie 的设置非常简单，cookie 会在 http 头部单独发送。以下实例在 cookie 中设置了name 和 expires：

  1. #!/usr/bin/python3
  2. # 
  3. print ('Content-Type: text/html')
  4. print ('Set-Cookie: name="Python3教程";expires=Wed, 28 Aug 2016 18:30:00 GMT')
  5. print ()
  6. print ("""
  7. <html>
  8.   <head>
  9.     <meta charset="utf-8">
  10.     <title>Python3 教程</title>
  11.   </head>
  12.     <body>
  13.         <h1>Cookie set OK!</h1>
  14.     </body>
  15. </html>
  16. """)

将以上代码保存到 cookie_set.py，并修改 cookie_set.py 权限：

  1. chmod 755 cookie_set.py

以上实例使用了 Set-Cookie 头信息来设置 Cookie 信息，可选项中设置了 Cookie 的其他属性，如过期时间 Expires，域名 Domain，路径 Path。这些信息设置在 "Content-type:text/html"之前。

检索Cookie信息

Cookie 信息检索页非常简单，Cookie 信息存储在 CGI 的环境变量 HTTP_COOKIE 中，存储格式如下：

  1. key1=value1;key2=value2;key3=value3....

以下是一个简单的 CGI 检索 cookie 信息的程序：

  1. #!/usr/bin/python3
  3. # 导入模块
  4. import os
  5. import Cookie
  7. print ("Content-type: text/html")
  8. print ()
  10. print ("""
  11. <html>
  12. <head>
  13. <meta charset="utf-8">
  14. <title>python3 教程</title>
  15. </head>
  16. <body>
  17. <h1>读取cookie信息</h1>
  18. """)
  20. if 'HTTP_COOKIE' in os.environ:
  21.     cookie_string=os.environ.get('HTTP_COOKIE')
  22.     c=Cookie.SimpleCookie()
  23.     c.load(cookie_string)
  25.     try:
  26.         data=c['name'].value
  27.         print ("cookie data: "+data+"<br>")
  28.     except KeyError:
  29.         print ("cookie 没有设置或者已过去<br>")
  30. print ("""
  31. </body>
  32. </html>
  33. """)

将以上代码保存到 cookie_get.py，并修改 cookie_get.py 权限：

  1. chmod 755 cookie_get.py

以上 cookie 设置颜色 Gif 如下所示：

Python3 CGI 编程 - 图11

文件上传实例

HTML 设置上传文件的表单需要设置 enctype 属性为 multipart/form-data，代码如下所示：

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>python3 教程</title>
  6. </head>
  7. <body>
  8.  <form enctype="multipart/form-data" 
  9.                      action="/cgi-bin/save_file.py" method="post">
  10.    <p>选中文件: <input type="file" name="filename" /></p>
  11.    <p><input type="submit" value="上传" /></p>
  12.    </form>
  13. </body>
  14. </html>

save_file.py 脚本文件代码如下：

  1. #!/usr/bin/python3
  3. import cgi, os
  4. import cgitb; cgitb.enable()
  6. form = cgi.FieldStorage()
  8. # 获取文件名
  9. fileitem = form['filename']
  11. # 检测文件是否上传
  12. if fileitem.filename:
  13.    # 设置文件路径 
  14.    fn = os.path.basename(fileitem.filename)
  15.    open('/tmp/' + fn, 'wb').write(fileitem.file.read())
  17.    message = '文件 "' + fn + '" 上传成功'
  19. else:
  20.    message = '文件没有上传'
  22. print ("""\
  23. Content-Type: text/html\n
  24. <html>
  25. <head>
  26. <meta charset="utf-8">
  27. <title>python3 教程</title>
  28. </head>
  29. <body>
  30.    <p>%s</p>
  31. </body>
  32. </html>
  33. """ % (message,))

将以上代码保存到 save_file.py，并修改 save_file.py 权限：

  1. chmod 755 save_file.py

以上 cookie 设置颜色 Gif 如下所示：

Python3 CGI 编程 - 图12

如果你使用的系统是 Unix/Linux，你必须替换文件分隔符，在 window 下只需要使用open() 语句即可：

  1. fn = os.path.basename(fileitem.filename.replace("\\", "/" ))

文件下载对话框

我们先在当前目录下创建 foo.txt 文件，用于程序的下载。

文件下载通过设置 HTTP 头信息来实现，功能代码如下：

  1. #!/usr/bin/python3
  3. # HTTP 头部
  4. print ("Content-Disposition: attachment; filename=\"foo.txt\"")
  5. print ()
  6. # 打开文件
  7. fo = open("foo.txt", "rb")
  9. str = fo.read();
  10. print (str)
  12. # 关闭文件
  13. fo.close()