SAPI:Server Application Programming Interface 服务器端应用编程端口。研究过PHP架构的同学应该知道这个东东的重要性,它提供了一个接口,使得PHP可以和其他应用进行交互数据。 本文不会详细介绍每个PHP的SAPI,只是针对最简单的CGI SAPI,来说明SAPI的机制。
我们先来看看PHP的架构图:
SAPI指的是PHP具体应用的编程接口, 就像PC一样,无论安装哪些操作系统,只要满足了PC的接口规范都可以在PC上正常运行, PHP脚本要执行有很多种方式,通过Web服务器,或者直接在命令行下,也可以嵌入在其他程序中。
通常,我们使用Apache或者Nginx这类Web服务器来测试PHP脚本,或者在命令行下通过PHP解释器程序来执行。 脚本执行完后,Web服务器应答,浏览器显示应答信息,或者在命令行标准输出上显示内容。
我们很少关心PHP解释器在哪里。虽然通过Web服务器和命令行程序执行脚本看起来很不一样, 实际上它们的工作流程是一样的。命令行参数传递给PHP解释器要执行的脚本, 相当于通过url请求一个PHP页面。脚本执行完成后返回响应结果,只不过命令行的响应结果是显示在终端上。
脚本执行的开始都是以SAPI接口实现开始的。只是不同的SAPI接口实现会完成他们特定的工作, 例如Apache的mod_php SAPI实现需要初始化从Apache获取的一些信息,在输出内容是将内容返回给Apache, 其他的SAPI实现也类似。
SAPI提供了一个和外部通信的接口, 对于PHP5.2,默认提供了很多种SAPI, 常见的给apache的mod_php5,CGI,给IIS的ISAPI,还有Shell的CLI,本文就从CGI SAPI入手 ,介绍SAPI的机制。 虽然CGI简单,但是不用担心,它包含了绝大部分内容,足以让你深刻理解SAPI的工作原理。
要定义个SAPI,首先要定义个sapi_module_struct, 查看 PHP-SRC/sapi/cgi/cgi_main.c:
*/
static sapi_module_struct cgi_sapi_module = {
#if PHP_FASTCGI
"cgi-fcgi", /* name */
"CGI/FastCGI", /* pretty name */
#else
"cgi", /* name */
"CGI", /* pretty name */
#endif
php_cgi_startup, /* startup */
php_module_shutdown_wrapper, /* shutdown */
NULL, /* activate */
sapi_cgi_deactivate, /* deactivate */
sapi_cgibin_ub_write, /* unbuffered write */
sapi_cgibin_flush, /* flush */
NULL, /* get uid */
sapi_cgibin_getenv, /* getenv */
php_error, /* error handler */
NULL, /* header handler */
sapi_cgi_send_headers, /* send headers handler */
NULL, /* send header handler */
sapi_cgi_read_post, /* read POST data */
sapi_cgi_read_cookies, /* read Cookies */
sapi_cgi_register_variables, /* register server variables */
sapi_cgi_log_message, /* Log message */
NULL, /* Get request time */
STANDARD_SAPI_MODULE_PROPERTIES
};
这个结构,包含了一些常量,比如name, 这个会在我们调用php_info()的时候被使用。一些初始化,收尾函数,以及一些函数指针,用来告诉Zend,如何获取,和输出数据。
1. php_cgi_startup, 当一个应用要调用PHP的时候,这个函数会被调用,对于CGI来说,它只是简单的调用了PHP的初始化函数:
1 | static int php_cgi_startup(sapi_module_struct *sapi_module) |
3 | if (php_module_startup(sapi_module, NULL, 0) == FAILURE) { |
2. php_module_shutdown_wrapper , 一个对PHP关闭函数的简单包装。只是简单的调用php_module_shutdown;
3. PHP会在每个request的时候,处理一些初始化,资源分配的事务。这部分就是activate字段要定义的,从上面的结构我们可以看出,对于CGI来说,它并没有提供初始化处理句柄。对于mod_php来说,那就不同了,他要在apache的pool中注册资源析构函数, 申请空间, 初始化环境变量,等等。
4. sapi_cgi_deactivate, 这个是对应与activate的函数,顾名思义,它会提供一个handler, 用来处理收尾工作,对于CGI来说,他只是简单的刷新缓冲区,用以保证用户在Zend关闭前得到所有的输出数据:
01 | static int sapi_cgi_deactivate(TSRMLS_D) |
08 | if (SG(sapi_started)) { |
09 | sapi_cgibin_flush(SG(server_context)); |
5. sapi_cgibin_ub_write, 这个hanlder告诉了Zend,如何输出数据,对于mod_php来说,这个函数提供了一个向response数据写的接口,而对于CGI来说,只是简单的写到stdout:
01 | static inline size_t sapi_cgibin_single_write( const char *str, uint str_length TSRMLS_DC) |
03 | #ifdef PHP_WRITE_STDOUT |
10 | if (fcgi_is_fastcgi()) { |
11 | fcgi_request *request = (fcgi_request*) SG(server_context); |
12 | long ret = fcgi_write(request, FCGI_STDOUT, str, str_length); |
19 | #ifdef PHP_WRITE_STDOUT |
20 | ret = write(STDOUT_FILENO, str, str_length); |
21 | if (ret <= 0) return 0; |
24 | ret = fwrite (str, 1, MIN(str_length, 16384), stdout); |
29 | static int sapi_cgibin_ub_write( const char *str, uint str_length TSRMLS_DC) |
31 | const char *ptr = str; |
32 | uint remaining = str_length; |
35 | while (remaining > 0) { |
36 | ret = sapi_cgibin_single_write(ptr, remaining TSRMLS_CC); |
38 | php_handle_aborted_connection(); |
39 | return str_length - remaining; |
把真正的写的逻辑剥离出来,就是为了简单实现兼容fastcgi的写方式。
6. sapi_cgibin_flush, 这个是提供给zend的刷新缓存的函数句柄,对于CGI来说,只是简单的调用系统提供的fflush;
7.NULL, 这部分用来让Zend可以验证一个要执行脚本文件的state,从而判断文件是否据有执行权限等等,CGI没有提供。
8. sapi_cgibin_getenv, 为Zend提供了一个根据name来查找环境变量的接口,对于mod_php5来说,当我们在脚本中调用getenv的时候,就会间接的调用这个句柄。而对于CGI来说,因为他的运行机制和CLI很类似,直接调用父级是Shell, 所以,只是简单的调用了系统提供的genenv:
01 | static char *sapi_cgibin_getenv( char *name, size_t name_len TSRMLS_DC) |
08 | if (fcgi_is_fastcgi()) { |
09 | fcgi_request *request = (fcgi_request*) SG(server_context); |
10 | return fcgi_getenv(request, name, name_len); |
9. php_error, 错误处理函数, 到这里,说几句题外话,上次看到php maillist 提到的使得PHP的错误处理机制完全OO化, 也就是,改写这个函数句柄,使得每当有错误发生的时候,都throw一个异常。而CGI只是简单的调用了PHP提供的错误处理函数。
10. 这个函数会在我们调用PHP的header()函数的时候被调用,对于CGI来说,不提供。
11. sapi_cgi_send_headers, 这个函数会在要真正发送header的时候被调用,一般来说,就是当有任何的输出要发送之前:
01 | static int sapi_cgi_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC) |
03 | char buf[SAPI_CGI_MAX_HEADER_LENGTH]; |
04 | sapi_header_struct *h; |
05 | zend_llist_position pos; |
07 | if (SG(request_info).no_headers == 1) { |
08 | return SAPI_HEADER_SENT_SUCCESSFULLY; |
11 | if (cgi_nph || SG(sapi_headers).http_response_code != 200) |
15 | if (rfc2616_headers && SG(sapi_headers).http_status_line) { |
16 | len = snprintf(buf, SAPI_CGI_MAX_HEADER_LENGTH, |
17 | "%s\r\n" , SG(sapi_headers).http_status_line); |
19 | if (len > SAPI_CGI_MAX_HEADER_LENGTH) { |
20 | len = SAPI_CGI_MAX_HEADER_LENGTH; |
24 | len = sprintf (buf, "Status: %d\r\n" , SG(sapi_headers).http_response_code); |
30 | h = (sapi_header_struct*)zend_llist_get_first_ex(&sapi_headers->headers, &pos); |
34 | PHPWRITE_H(h->header, h->header_len); |
35 | PHPWRITE_H( "\r\n" , 2); |
37 | h = (sapi_header_struct*)zend_llist_get_next_ex(&sapi_headers->headers, &pos); |
39 | PHPWRITE_H( "\r\n" , 2); |
41 | return SAPI_HEADER_SENT_SUCCESSFULLY; |
12. NULL, 这个用来单独发送每一个header, CGI没有提供
13. sapi_cgi_read_post, 这个句柄指明了如何获取POST的数据,如果做过CGI编程的话,我们就知道CGI是从stdin中读取POST DATA的:
01 | static int sapi_cgi_read_post( char *buffer, uint count_bytes TSRMLS_DC) |
03 | uint read_bytes=0, tmp_read_bytes; |
08 | count_bytes = MIN(count_bytes, (uint) SG(request_info).content_length - SG(read_post_bytes)); |
09 | while (read_bytes < count_bytes) { |
11 | if (fcgi_is_fastcgi()) { |
12 | fcgi_request *request = (fcgi_request*) SG(server_context); |
13 | tmp_read_bytes = fcgi_read(request, pos, count_bytes - read_bytes); |
14 | pos += tmp_read_bytes; |
16 | tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes); |
19 | tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes); |
22 | if (tmp_read_bytes <= 0) { |
25 | read_bytes += tmp_read_bytes; |
14. sapi_cgi_read_cookies, 这个和上面的函数一样,只不过是去获取cookie值:
1 | static char *sapi_cgi_read_cookies(TSRMLS_D) |
3 | return sapi_cgibin_getenv(( char *) "HTTP_COOKIE" , sizeof ( "HTTP_COOKIE" )-1 TSRMLS_CC); |
15. sapi_cgi_register_variables, 这个函数给了一个接口,用以给$_SERVER变量中添加变量,对于CGI来说,注册了一个PHP_SELF,这样我们就可以在脚本中访问$_SERVER['PHP_SELF']来获取本次的request_uri:
1 | static void sapi_cgi_register_variables(zval *track_vars_array TSRMLS_DC) |
6 | php_import_environment_variables(track_vars_array TSRMLS_CC); |
8 | php_register_variable( "PHP_SELF" , (SG(request_info).request_uri ? SG(request_info).request_uri : "" ), track_vars_array TSRMLS_CC); |
16. sapi_cgi_log_message ,用来输出错误信息,对于CGI来说,只是简单的输出到stderr:
01 | static void sapi_cgi_log_message( char *message) |
04 | if (fcgi_is_fastcgi() && fcgi_logging) { |
05 | fcgi_request *request; |
08 | request = (fcgi_request*) SG(server_context); |
10 | int len = strlen (message); |
11 | char *buf = malloc (len+2); |
13 | memcpy (buf, message, len); |
14 | memcpy (buf + len, "\n" , sizeof ( "\n" )); |
15 | fcgi_write(request, FCGI_STDERR, buf, len+1); |
18 | fprintf (stderr, "%s\n" , message); |
22 | #endif /* PHP_FASTCGI */ |
23 | fprintf (stderr, "%s\n" , message); |
经过分析,我们已经了解了一个SAPI是如何实现的了, 分析过CGI以后,我们也就可以想象mod_php, embed等SAPI的实现机制。
原文地址:http://www.nowamagic.net/librarys/veda/detail/1285