【Python进阶】04、CGI编程

你的名字 2022-10-02 10:53 194阅读 0赞

**一、CGI概述**

**1、CGI简介**

CGI(Common Gateway Interface) 是WWW技术中最重要的技术之一，有着不可替代的重要地位。CGI是外部应用程序（CGI程序）与Web服务器之间的接口标准，是在CGI程序和Web服务器之间传递信息的过程。CGI规范允许Web服务器执行外部程序，并将它们的输出发送给Web浏览器，CGI将Web的一组简单的静态超媒体文档变成一个完整的新的交互式媒体。

Common Gateway Interface，简称CGI。在物理上是一段程序，运行在服务器上，提供同客户端HTML页面的接口。这样说大概还不好理解。

那么我们看一个实际例子：

现在的个人主页上大部分都有一个留言本。留言本的工作是这样的：先由用户在客户端输入一些信息，如评论之类的东西。接着用户按一下“发布或提交”（到目前为止工作都在客户端），浏览器把这些信息传送到服务器的CGI目录下特定的CGI程序中，于是CGI程序在服务器上按照预定的方法进行处理。在本例中就是把用户提交的信息存入指定的文件中。然后CGI程序给客户端发送一个信息，表示请求的任务已经结束。此时用户在浏览器里将看到“留言结束”的字样。整个过程结束。

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

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

**2、功能**

绝大多数的CGI程序被用来解释处理来自表单的输入信息，并在服务器产生相应的处理，或将相应的信息反馈给浏览器。CGI程序使网页具有交互功能。

**3、处理步骤**

1.浏览器通过HTML表单或超链接请求指向一个CGI应用程序的URL。

2.服务器收发到请求。

3.服务器执行指定CGI应用程序。

4.CGI应用程序执行所需要的操作，通常是基于浏览者输入的内容。

5.CGI应用程序把结果格式化为网络服务器和浏览器能够理解的文档（通常是HTML网页）。

6.网络服务器把结果返回到浏览器中。

**4、网页浏览**

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

*  1、使用你的浏览器访问URL并连接到HTTP web 服务器。
 *  2、Web服务器接收到请求信息后会解析URL，并查找访问的文件在服务器上是否存在，如果存在返回文件的内容，否则返回错误信息。
 *  3、浏览器从服务器上接收信息，并显示接收的文件或者错误信息。
 *  CGI程序可以是Python脚本，PERL脚本，SHELL脚本，C或者C++程序等。asp,php,jsp

**二、python CGI编程**

**1、web服务器支持及配置**

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

Apache 支持CGI 配置：

设置好CGI目录：

[root@Node3 ~]# yum install httpd
    
    [root@Node3 ~]# cd /var/www/
    [root@Node3 www]# ls
    cgi-bin  error  html  icons

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

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

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

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

#
    ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
    
    #
    # "/var/www/cgi-bin" should be changed to whatever your ScriptAliased
    # CGI directory exists, if you have that configured.
    #
    <Directory "/var/www/cgi-bin">
        AllowOverride None
        Options None
        Order allow,deny
        Allow from all
    </Directory>
    
    #

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

AddHandler cgi-script .cgi .py

启动httpd服务：

# service httpd start

**2、第一个CGI程序**

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

[root@Node3 cgi-bin]# vim cgi.py 
    
    [root@Node3 cgi-bin]# cat cgi.py 
    #!/usr/local/bin/python2.7
    #coding=utf-8
    
    print "Content-type:text/html"
    print                           #空行，告诉服务器结束头部
    print '<html>'
    print '<head>'
    print '<meta charset="utf-8">'
    print '<title>Hello Word - 我的第一个CGI程序！</title>'
    print '</head>'
    print '<body>'
    print '<h2>我是来自magedu的第一个CGI程序</h2>'
    print '</body>'
    print '</html>'
    
    [root@Node3 cgi-bin]# chmod +x cgi.py

用浏览器访问：

[![wKiom1gkCNqwrBl0AABik\_IJ5tw816.png][wKiom1gkCNqwrBl0AABik_IJ5tw816.png]][wKiom1gkCNqwrBl0AABik_IJ5tw816.png]

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

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

**3、HTTP头部**

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

HTTP头部的格式如下：

HTTP 字段名: 字段内容

例如：

Content-type: text/html

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

<table> 
 <tbody style="border:0px;"> 
  <tr style="border:0px;"> 
   <th style="border-top-width:1px;color:rgb(255,255,255);vertical-align:top;width:197px;">头</th> 
   <th style="border-top-width:1px;color:rgb(255,255,255);vertical-align:top;">描述</th> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Content-type:</td> 
   <td style="font-size:1em;vertical-align:top;">请求的与实体对应的MIME信息。例如: Content-type:text/html</td> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Expires: Date</td> 
   <td style="font-size:1em;vertical-align:top;">响应过期的日期和时间</td> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Location: URL</td> 
   <td style="font-size:1em;vertical-align:top;">用来重定向接收方到非请求URL的位置来完成请求或标识新的资源</td> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Last-modified: Date</td> 
   <td style="font-size:1em;vertical-align:top;">请求资源的最后修改时间</td> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Content-length: N</td> 
   <td style="font-size:1em;vertical-align:top;">请求的内容长度</td> 
  </tr> 
  <tr style="border:0px;"> 
   <td style="font-size:1em;vertical-align:top;">Set-Cookie: String</td> 
   <td style="font-size:1em;vertical-align:top;">设置Http Cookie</td> 
  </tr> 
 </tbody> 
</table>

**4、CGI环境变量**

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

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

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

**[![wKiom1gkEWGTmImHAAFGa4ozMTg725.png][]][wKiom1gkEWGTmImHAAFGa4ozMTg725.png]**

**5、GET和POST方法**

浏览器客户端通过 GET 方法和 POST 方法向服务器传递信息。

### 使用GET方法传输数据 ###

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

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

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

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

使用GET方法向cgi\_get.py程序发送两个参数：

[root@Node3 cgi-bin]# cat cgi_get.py
    #!/usr/bin/python
    # -*- coding: UTF-8 -*-
    
    # filename：test.py
    
    # CGI处理模块
    import cgi, cgitb 
    
    # 创建 FieldStorage 的实例化
    form = cgi.FieldStorage() 
    
    # 获取数据
    site_name = form.getvalue('name')
    site_url  = form.getvalue('url')
    
    print "Content-type:text/html"
    print
    print "<html>"
    print "<head>"
    print "<meta charset=\"utf-8\">"
    print "<title> CGI 测试 </title>"
    print "</head>"
    print "<body>"
    print "<h2>%s：%s</h2>" % (site_name, site_url)
    print "</body>"
    print "</html>"

用浏览器访问：

[![wKioL1gkF2Txct3IAABXKRr61xo665.png][]][wKioL1gkF2Txct3IAABXKRr61xo665.png]

[![wKiom1gkGEzCOsYwAABss0d5ExE004.png][]][wKiom1gkGEzCOsYwAABss0d5ExE004.png]

**6、简单的表单实例：GET方法**

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

[root@Node3 html]# cat cgi_get.html 
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="utf-8">
    <title>菜鸟教程(runoob.com)</title>
    </head>
    <body>
    <form action="/cgi-bin/cgi_get.py" method="get">
    站点名称: <input type="text" name="name">  <br />
    
    站点 URL: <input type="text" name="url" />
    <input type="submit" value="提交" />
    </form>
    </body>
    </html>

默认情况下 cgi-bin 目录只能存放脚本文件，我们将 cgi\_get.html 存储在 test 目录下：

[root@Node3 cgi-bin]# mv cgi_get.html /var/www/html/
    [root@Node3 cgi-bin]# ls /var/www/html/
    cgi_get.html

用浏览器访问：

![wKiom1gkIBKAfBXLAABFIJC7tos219.png][]

[![wKioL1gkIBGCY0P6AABiDbW3pFg288.png][]][wKioL1gkIBGCY0P6AABiDbW3pFg288.png]

[![wKioL1gkIBKQtT9QAACGovC0V8M284.png][]][wKioL1gkIBKQtT9QAACGovC0V8M284.png]

**7、使用POST方法传递数据**

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

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

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

[root@Node3 html]# cat cgi_post.html
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="utf-8">
    <title>菜鸟教程(runoob.com)</title>
    </head>
    <body>
    <form action="/cgi-bin/cgi_get.py" method="post">
    站点名称: <input type="text" name="name">  <br />
    
    站点 URL: <input type="text" name="url" />
    <input type="submit" value="提交" />
    </form>
    </body>
    </html>

用浏览器访问：

[![wKiom1gkJZLDwzazAABgEp9Bro0852.png][]][wKiom1gkJZLDwzazAABgEp9Bro0852.png]

前面2张图和GET是一样的，第3张图可以看到，POST方法不会在浏览器中显示参数。

转载于:https://blog.51cto.com/xiexiaojun/1871502

[wKiom1gkCNqwrBl0AABik_IJ5tw816.png]: /images/20220112/d60616cd4e2a484986d726ca8e6ffa7b.png
[wKiom1gkEWGTmImHAAFGa4ozMTg725.png]: https://s1.51cto.com/wyfs02/M00/8A/06/wKiom1gkEWGTmImHAAFGa4ozMTg725.png
[wKioL1gkF2Txct3IAABXKRr61xo665.png]: /images/20220112/8b11bd004e594a12a595339ceed8a255.png
[wKiom1gkGEzCOsYwAABss0d5ExE004.png]: /images/20220112/41351f99b8524eeb81ddc0457d27118a.png
[wKiom1gkIBKAfBXLAABFIJC7tos219.png]: /images/20220112/7bc78a1103c446a7b2e28919bf9fe674.png
[wKioL1gkIBGCY0P6AABiDbW3pFg288.png]: /images/20220112/d2d00a49cf4742139167a89c61a158ea.png
[wKioL1gkIBKQtT9QAACGovC0V8M284.png]: /images/20220112/1252204b21d84ae2a29933472d9beb7b.png
[wKiom1gkJZLDwzazAABgEp9Bro0852.png]: /images/20220112/5c17fe20e2214d1ca9193744e5a77c80.png