PHP コア - SAPI インターフェイス

SAPI: サーバー アプリケーション プログラミング インターフェイス サーバー側のアプリケーション プログラミング ポート。 PHP アーキテクチャを学習したことのある学生は、この重要性を理解しているはずです。PHP は、PHP が他のアプリケーションと対話できるようにするインターフェイスを提供します。 この記事では、各 PHP SAPI については詳しく紹介せず、最も単純な CGI SAPI の SAPI の仕組みのみを説明します。

まず PHP のアーキテクチャ図を見てみましょう:

SAPI は、PC と同様に、PC に適合する限り、どのオペレーティング システムがインストールされているかに関係なく、特定の PHP アプリケーションのプログラミング インターフェイスを指します。 PHP スクリプトを適切に実行するには、Web サーバー経由、コマンド ラインから直接、または他のプログラムに埋め込むなど、さまざまな方法で実行できます。

通常、PHP スクリプトをテストするには、Apache や Nginx などの Web サーバーを使用するか、コマンドラインで PHP インタープリター プログラムを通じてスクリプトを実行します。 スクリプトが実行されると、Web サーバーが応答し、ブラウザーは応答情報を表示するか、コマンド ラインの標準出力に内容を表示します。

PHP インタープリターがどこにあるかを気にすることはほとんどありません。 Web サーバーとコマンドライン プログラムを介したスクリプトの実行は非常に異なって見えますが、ワークフローは実際には同じです。コマンド ライン パラメーターは、PHP インタープリターによって実行されるスクリプトに渡されます。これは、URL を介して PHP ページをリクエストするのと同じです。スクリプト実行後は応答結果が返されますが、ターミナル上にはコマンドラインからの応答結果が表示されます。

スクリプトの実行は、SAPI インターフェースの実装から始まります。たとえば、Apache の mod_php SAPI 実装は、Apache から取得した一部の情報を初期化し、コンテンツを出力するときにそのコンテンツを Apache に返す必要があるというだけです。

SAPI は、PHP5.2 の場合、Apache 用の mod_php5、IIS 用の ISAPI、および Shell CLI の多くの種類の 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
};

この構造には、php_info() を呼び出すときに使用される名前などのいくつかの定数が含まれています。一部の初期化関数、終了関数、および一部の関数ポインタは、Zend にデータの取得方法と出力方法を指示するために使用されます。

1. php_cgi_startup、アプリケーションが PHP を呼び出すと、この関数が呼び出されます。CGI の場合は、PHP の初期化関数

static int php_cgi_startup(sapi_module_struct *sapi_module)
{
    if (php_module_startup(sapi_module, NULL, 0) == FAILURE) {
        return FAILURE;
    }
    return SUCCESS;
}

2. php_module_shutdown_wrapper、PHP シンプル パッケージ化用のシャットダウン関数を呼び出します。単に php_module_shutdown; を呼び出すだけです

3. PHP はリクエストごとにいくつかの初期化とリソース割り当てトランザクションを処理します。この部分は、activate フィールドが定義されるものです。上記の構造から、CGI の場合は初期化ハンドルが提供されないことがわかります。 mod_php5 の場合は異なります。Apache プールにリソース デストラクターを登録し、スペースを適用し、環境変数を初期化する必要があります。

4. sapi_cgi_deactivate は、activate に対応する関数で、CGI の場合は、Zend が閉じる前にバッファを更新するだけです。すべての出力データ:

static int sapi_cgi_deactivate(TSRMLS_D)
{
    /* flush only when SAPI was started. The reasons are:
        1. SAPI Deactivate is called from two places: module init and request shutdown
        2. When the first call occurs and the request is not set up, flush fails on
            FastCGI.
    */
    if (SG(sapi_started)) {
        sapi_cgibin_flush(SG(server_context));
    }
    return SUCCESS;
}

、sapi_cgibin_ub_write、このハンドラーは Zend にデータの出力方法を指示しますが、CGI の場合は単に stdout を書き込みます。単純に fastcgi 互換の書き込みメソッドを実装するために削除されています。

6. sapi_cgibin_flush、これはキャッシュを更新するために zend に提供される関数ハンドルです。

7.NULL、この部分は Zend が検証できるようにするために使用されます。ファイルに実行権限があるかどうかなどを判断するための、実行されるスクリプトは CGI によって提供されません。

8. sapi_cgibin_getenv は、mod_php5 の場合、スクリプト内で getenv を呼び出すと、このハンドルが間接的に呼び出されます。 CGI の場合、その動作メカニズムは CLI に非常に似ているため、直接呼び出しの親はシェルであるため、システムによって提供される Genenv を呼び出すだけです:

static inline size_t sapi_cgibin_single_write(const char *str, uint str_length TSRMLS_DC)
{
#ifdef PHP_WRITE_STDOUT
    long ret;
#else
    size_t ret;
#endif
#if PHP_FASTCGI
    if (fcgi_is_fastcgi()) {
        fcgi_request *request = (fcgi_request*) SG(server_context);
        long ret = fcgi_write(request, FCGI_STDOUT, str, str_length);
        if (ret <= 0) {
            return 0;
        }
        return ret;
    }
#endif
#ifdef PHP_WRITE_STDOUT
    ret = write(STDOUT_FILENO, str, str_length);
    if (ret <= 0) return 0;
    return ret;
#else
    ret = fwrite(str, 1, MIN(str_length, 16384), stdout);
    return ret;
#endif
}
static int sapi_cgibin_ub_write(const char *str, uint str_length TSRMLS_DC)
{
    const char *ptr = str;
    uint remaining = str_length;
    size_t ret;
    while (remaining > 0) {
        ret = sapi_cgibin_single_write(ptr, remaining TSRMLS_CC);
        if (!ret) {
            php_handle_aborted_connection();
            return str_length - remaining;
        }
        ptr += ret;
        remaining -= ret;
    }
    return str_length;
}

9。 php_error、エラー処理関数、ここで少し余談を述べます。 PHP のメールリストを見たときに、PHP のエラー処理メカニズムは完全に OO、つまり、エラーが発生するたびに例外がスローされるようにこの関数ハンドルを書き換えていると記載されていました。 CGI は、PHP が提供するエラー処理関数を呼び出すだけです。

10. この関数は、CGI には提供されていない PHP の header() 関数を呼び出すときに呼び出されます。

11. sapi_cgi_send_headers、この関数はヘッダーが実際に送信されるとき、一般的には出力が送信される前に呼び出されます:

static char *sapi_cgibin_getenv(char *name, size_t name_len TSRMLS_DC)
{
#if PHP_FASTCGI
    /* when php is started by mod_fastcgi, no regular environment
       is provided to PHP.  It is always sent to PHP at the start
       of a request.  So we have to do our own lookup to get env
       vars.  This could probably be faster somehow.  */
    if (fcgi_is_fastcgi()) {
        fcgi_request *request = (fcgi_request*) SG(server_context);
        return fcgi_getenv(request, name, name_len);
    }
#endif
    /*  if cgi, or fastcgi and not found in fcgi env
        check the regular environment */
    return getenv(name);
}

12. NULL、これは各ヘッダーを個別に送信するために使用されます。CGI は提供されません

13. sapi_cgi_read_post, 这个句柄指明了如何获取POST的数据，如果做过CGI编程的话，我们就知道CGI是从stdin中读取POST DATA的：

static int sapi_cgi_read_post(char *buffer, uint count_bytes TSRMLS_DC)
{
    uint read_bytes=0, tmp_read_bytes;
#if PHP_FASTCGI
    char *pos = buffer;
#endif
    count_bytes = MIN(count_bytes, (uint) SG(request_info).content_length - SG(read_post_bytes));
    while (read_bytes < count_bytes) {
#if PHP_FASTCGI
        if (fcgi_is_fastcgi()) {
            fcgi_request *request = (fcgi_request*) SG(server_context);
            tmp_read_bytes = fcgi_read(request, pos, count_bytes - read_bytes);
            pos += tmp_read_bytes;
        } else {
            tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes);
        }
#else
        tmp_read_bytes = read(0, buffer + read_bytes, count_bytes - read_bytes);
#endif
        if (tmp_read_bytes <= 0) {
            break;
        }
        read_bytes += tmp_read_bytes;
    }
    return read_bytes;
}

14. sapi_cgi_read_cookies, 这个和上面的函数一样，只不过是去获取cookie值：

static char *sapi_cgi_read_cookies(TSRMLS_D)
{
   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：
static void sapi_cgi_register_variables(zval *track_vars_array TSRMLS_DC)
{
   /* In CGI mode, we consider the environment to be a part of the server
    * variables
    */
   php_import_environment_variables(track_vars_array TSRMLS_CC);
   /* Build the special-case PHP_SELF variable for the CGI version */
   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：
static void sapi_cgi_log_message(char *message)
{
#if PHP_FASTCGI
   if (fcgi_is_fastcgi() && fcgi_logging) {
       fcgi_request *request;
       TSRMLS_FETCH();

       request = (fcgi_request*) SG(server_context);
       if (request) {
           int len = strlen(message);
           char *buf = malloc(len+2);

           memcpy(buf, message, len);
           memcpy(buf + len, "\n", sizeof("\n"));
           fcgi_write(request, FCGI_STDERR, buf, len+1);
           free(buf);
       } else {
           fprintf(stderr, "%s\n", message);
       }
       /* ignore return code */
   } else
#endif /* PHP_FASTCGI */
   fprintf(stderr, "%s\n", message);
}

经过分析，我们已经了解了一个SAPI是如何实现的了， 分析过CGI以后，我们也就可以想象mod_php5, embed等SAPI的实现机制。