cgi 通用网关接口

前驱知识

网关协议学习:CGI、FastCGI、WSGI

简单点说:

  • web服务器接受请求,启动CGICGI接受请求,处理,返回给服务器;服务器返回给用户
  • cgi效率不高,每次都要fork一个新进程出来
  • WCGIPython架设的一个桥,连接了服务器和web框架,相当将cgi的连接功能独立了出来,并把处理功能留给了web框架

简介

CGI脚本由HTTP服务器启动,通常用来处理用户通过<FROM>提交的数据。

通常,CGI脚本位于服务器的专门的cgi-bin目录下。HTTP服务器在脚本的shell环境中放置了请求相关的信息,比如客户端的hostname,请求的url,请求的字符串以及其他东西。服务器执行脚本,并把输出返回给客户端。

脚本的输入也和客户端相连,有时表单数据是通过这种方式读取的。其他时候,表单数据是通过URLquery字符串传递的。这个模块用于处理不同的情况,提供一个简单的接口。同时提供了一些功能,帮助调试脚本。最近添加的功能是通过表单上传文件。

CGI脚本的输出由两部分组成,由一个空行分割。第一部分包含一些头部,告诉客户接下来返回的是什么数据。大概是这样:

print("Content-Type: text/html")    # 接下来返回的是html
print() # 空白行,头部结束

第二部分,一般来说是HTML。客户端软件可以展示这些页面,图片什么的。

使用cgi模块

当你写一个新的脚本时,添加下面这两行:

import cgitb
cigtb.enable()

这将会激活一个异常处理器,如果发生了错误,它就会把错误返回给浏览器。如果你不想让用户看到,也可以指定输出目录。

import cgitb
cgitb.enable(display=0, logdir='/path/to/logdir')

补充:

POST请求提交数据有两种方式application/x-www-form-urlencodedmultipart/form-data。前者形如MyVariableOne=ValueOne&MyVariableTwo=ValueTwo,使用%HH的形式编码非ascii码,不接受重复键值。后者接受重复键值、二进制文件等。参考资料

可以通过FieldStorage类获取提交的表单数据,如果含有非asciii码,使用encoding参数,由于它会消耗标准数据,所以应该只被实例化1次。

FieldStorage实例与python的字典相似。可以使用in检测内容,keys, len接口也都可以使用。FieldStorage的每个值也是一个FieldStorage或者MiniFieldStorage实例。

由于表单可能存在重复的项目名,你可以使用getlist()方法。getlist(key_name)方法会返回所有keykey_name的值。

如果上传的表单中存在文件,你可以调用read()函数或者readline()函数。

如果是通过application/x-www-form-urlencoded发送的数据,则没有list, file, filename接口。

高级接口

前面介绍了,如果使用FieldStorage类从数据读取CGI。这一节,讲述以西而更可读和符合直觉的高级接口。但,前面讲的技术还是有用的,比如高效处理文件上传。

该接口包含两个方法。使用这戏方法你可以以更一般的方式处理数据,不用担心是否有几个值公用一个名字。

form = cgi.FieldStorage()

item = form.getvalue("item")
if isinstance(item, list):
# handle the list
pass
else:
# handle the single value
pass

进行类型检查是必须的,因为会有好事的用户,输入重复的键名。

你可以使用高级接口提供的getfirst()getlist()方法。

函数

大部分函数,如cgi.parsecgi.parse_qscgi.parse_qsl,已经被移植到urllib.parsecgi.escape被移植到html.escape

安全问题

原则:如果你启动了一个外部程序函数,永远不要把用户的输入直接传入shell。即使要传入也要确保只含有字母和数字、横杠、下划线和点。

Unix系统上安装CGI脚本

阅读你的HTTP服务器的文档,找到你的CGI脚本的安装位置,一般是在服务器目录的cgi-bin目录下。

确保你的脚本可被其他程序读和执行;在Unix文件模式下处于0o755:使用chmod 0755 filename。确保第一行有shebang:

#! /usr/local/bin/python

同时,你的脚本需要执行的文件都有对应的权限。因为你的服务器被用户nobody执行,它只能读/写/执行那些被所有人读/写/执行的文件。当前目录和系统环境变量也可能可你目前所处的不一样。

如果你需要从别的目录引用模块,使用sys.path.insert(0, "/path/to/your/module")这样你的模块会被首先搜索。

测试你的CGI脚本

不行的是,当你从命令行尝试CGI脚本是,它很有可能不会运行,而一个能运行的CGI脚本往往在服务器中不能运行。但你仍然应该从命令行中运行脚本,检查一下他是否有语法错误。如果你的脚本没有语法错误,但是它不工作,你只能读下一节。

调试CGI脚本

首先,检查一下琐碎的安装错误,读一下上面关于安装的部分,能节约时间。如果你想知道你是否正确理解了安装过程,把这个模块文件cgi.py安装到你的cgi脚本目录下,启动这个脚本,他就会将它的环境和内容以HTML的格式输出。给他一个合适的模式,发送给他一个请求。如果它被安装在cgi-bin目录下,在你的浏览器内输入如下url:

http://yourhostname/cgi-bin/c...\

如果返回404错误,则说明服务器没有找到这个脚本,或许你应该把它装在别的目录下。如果给了别的错误,说明你有安装问题。你应该首先解决这些安装问题,再做别的调试。如果它给出了非常整洁的环境变量和表单内容输出,说明cgi.py被正确的安装了。如果,你的脚本按上述过程安装,你现在可以对他进行调试了。

下一步是在你的脚本中调用cgi模块的test()方法,把它的主要代码替换成cgi.test

它应该输出和仅安装cgi.py时一致。

当一个普通的python脚本抛出了一个未处理的异常时,Python解释器会把traceback打印出来,退出。当你的CGI脚本抛出异常时,Python解释器也会这么做。这些traceback一般会在你的HTTP服务器的日志文件里,或者被丢弃了。

幸运的是,如果你的脚本执行了某些代码,你可以通过启用cgitb模块,把traceback的内容发送到浏览器中。把下面两行代码加到你脚本的顶部。

import cgitb
cgitb.enable()

如果你怀疑cgitb模块有问题,你可以使用一个更鲁棒的方法,只调用内置模块:

import sys
sys.stderr = sys.stdout
print("Content-Type: text/plain")
print()

上述代码依赖python解释器输出traceback,输出的内容的格式被指定为纯文本,去除了HTML过程。如果你的脚本正常工作,你的客户端会显示纯HTML。如果抛出了异常,前两行打印出之后,traceback会被打印出来,如果没有HTML解释器进行处理,所以traceback会可读。

常见问题及解决

  • 大多数HTTP服务器将CGI脚本的输出放入缓冲区直至脚本完成,这意味着在脚本还在执行时,不可能在客户端展示进度
  • 按上述核对安装过程
  • 监控日志文件
  • 先检查语法错误
  • 如果没有语法错误,在脚本顶部添加import cgitb; cgitb.enable()
  • 当启动外部程序时,确保他们能够被找到,通常这意味着绝对路径名,在CGI脚本中,PATH总是被设置为一个没啥用的值
  • 当脚本读写外部文件是,确保执行CGI的userid能够读写这些文件:一般来说是运行服务器的的userid,或者是服务器的suexec的userid
  • 不要给一个CGI set-uid权限,这在大多数操作系统上不可行,而且不安全。

通读Python官方文档之cgi的更多相关文章

  1. 通读Python官方文档之wsgiref(未完成)

    wsgirf-WSGI功能及参考实现 源码:Lib/wsgiref Web服务器网关接口(Web Server Gateway Interface, WSGI),是用Python写的一个服务器软件和w ...

  2. 通读Python官方文档之cgitb

    cgitb CGI脚本异常管理 源代码:Lib/cgitb.py cgitb模块为Python脚本提供了一个特殊的异常管理器.名字有点误导人,它最初设计是为了以HTML格式展示cgi脚本的大量异常信息 ...

  3. 别开心太早,Python 官方文档的翻译差远了

    近几天,很多公众号发布了 Python 官方文档的消息.然而,一个特别奇怪的现象就发生了,让人啼笑皆非. Python 文档的中文翻译工作一直是“默默无闻”,几个月前,我还吐槽过这件事<再聊聊P ...

  4. 阅读Python官方文档心得

    我会每天都阅读一些python的官方文档,并每天更新心得体会. -------------------------------------------------2016.12.08--------- ...

  5. [Python3]Python官方文档-Python Manuals

    简介 一般情况下,初学者都不愿意直接去浏览Python Manuals,即Python自带的官方文档.尤其是只有英文版的情况下,初学者更加不会去使用该官方文档了. 在这里笔者强力推荐初学者经常学会使用 ...

  6. PEP 324 subprocess 新的进程模块 -- Python官方文档译文 [原创]

    PEP 324 -- subprocess 新的进程模块(subprocess - New process module) 英文原文:https://www.python.org/dev/peps/p ...

  7. python官方文档

    Tutorialstart here Library Referencekeep this under your pillow Language Referencedescribes syntax a ...

  8. Python 官方文档解读(2):threading 模块

    使用 Python 可以编写多线程程序,注意,这并不是说程序能在多个 CPU 核上跑.如果你想这么做,可以看看关于 Python 并行计算的,比如官方 Wiki. Python 线程的主要应用场景是一 ...

  9. Python 官方文档解读(1):66 个内置函数

    Python 解释器 (CPython 3.7)内置有 66 个函数,这些函数在任何时刻都是可用的.此文是为了对这 66 个函数进行简单的梳理,便于以后可能用到它们时能想到. 1. abs(x) 返回 ...

随机推荐

  1. linux 下使用opengl的glut库显示和旋转BMP图片

    效果图: 这里显示的图和原图有明显的色差,目前猜测是opengl渲染时的颜色表顺序跟BMP文件里的颜色表顺序相反导致. BMP里应该是BGRBGRBRG... ,而opengl渲染时应该是按照RGBR ...

  2. SpringBoot 异步调用方法并接收返回值

    项目中肯定会遇到异步调用其他方法的场景,比如有个计算过程,需要计算很多个指标的值,但是每个指标计算的效率快慢不同,如果采用同步执行的方式,运行这一个过程的时间是计算所有指标的时间之和.比如: 方法A: ...

  3. JS-闭包练习

    首先,第一个输出,因为前置运算,i要先参与输出,然后再自增,所以输出为0 第二个输出,因为f1和f2是不同的函数,不共享i变量,所以输出也为0 第三个输出,因为是f1,共享i,所以i加了1,输出为1 ...

  4. C++ STL 之 deque容器 打分案例(内含sort排序用法)

    #include <iostream> #include <vector> #include <time.h> #include <deque> #in ...

  5. 智能指针原理及实现(1)shared_ptr

    0.异常安全 C++没有内存回收机制,每次程序员new出来的对象需要手动delete,流程复杂时可能会漏掉delete,导致内存泄漏.于是C++引入智能指针,可用于动态资源管理,资源即对象的管理策略. ...

  6. 前端基础(十):Bootstrap Switch 选择框开关控制

    简介 Bootstrap Switch是一款轻量级插件,可以给选择框设置类似于开关的样式 它是依赖于Bootstrap的一款插件 下载 下载地址 在线引用 导入 因为它是依赖于Bootstrap的一款 ...

  7. web开发:javascript基础

    一.js引入 二.变量的定义 三.三种弹出框 四.调试方式 五.数据类型 六.数据类型转换 七.运算符 八.分支机构 九.循环结构 十.异常处理 十一.函数 一.js引入 - ES: ECMAScri ...

  8. Hadoop_18_MapRduce 内部的shuffle机制

    1.Mapreduce的shuffle机制: Mapreduce中,map阶段处理的数据如何传递给Reduce阶段,是mapreduce框架中最关键的一个流程,这个流程就叫shuffle 将mapta ...

  9. 【django】另一种思路代替nginx 的rewrite

    需求:访问xx.com 跳转到xx.com/index 修改setting 同级别的urls.py 文件 from django.conf.urls import include, url from ...

  10. layui多图上传实现删除功能

    在使用layui的多图上传时发现没有删除功能 在网上搜索解决办法时有的感觉太复杂有的不符合自己所需要的所以就自己动手 下面附上代码 HTML: <div class="layui-up ...