Awesome

ngx-php

ngx-php is an extension module of high-performance web server nginx, which implements embedded PHP7 and PHP8 script to process nginx location and variables.

ngx-php draws on the design of ngx_lua and is committed to providing non-blocking web services with significant performance advantages over php-cgi, mod_php, php-fpm and hhvm.

ngx-php doesn't want to replace anything, just want to provide a solution.

There is a legacy version of ngx_php5, which records some of my past code practices and is also valuable.

Benchmarks about ngx-php and php

Table of contents

• What's different with official php
• Requirement
• Installation
• Synopsis
• Test
• Directives
• Nginx API for php
• Nginx non-blocking API for php
• Nginx constants
• Copyright and License

What's different with official php

• Global variable is unsafe in per request
• Static variable of a class is unsafe in per request
• Do not design singleton mode
• The native IO function works fine, but it slows down nginx

Requirement

• Linux only
• PHP-7.* ~ PHP-8.3
• nginx-1.4.7 ~ nginx-1.25.x

Installation

Compile install

$ wget 'http://php.net/distributions/php-7.3.10.tar.gz'
$ tar xf php-7.3.10.tar.gz
$ cd php-7.3.10

$ ./configure --prefix=/path/to/php --enable-embed
$ make && make install

$ git clone https://github.com/rryqszq4/ngx-php.git

$ wget 'http://nginx.org/download/nginx-1.12.2.tar.gz'
$ tar -zxvf nginx-1.12.2.tar.gz
$ cd nginx-1.12.2

$ export PHP_CONFIG=/path/to/php/bin/php-config
$ export PHP_BIN=/path/to/php/bin
$ export PHP_INC=/path/to/php/include/php
$ export PHP_LIB=/path/to/php/lib

$ ./configure --user=www --group=www \
$             --prefix=/path/to/nginx \
$             --with-ld-opt="-Wl,-rpath,$PHP_LIB" \
$             --add-module=/path/to/ngx-php/third_party/ngx_devel_kit \
$             --add-module=/path/to/ngx-php
$ make && make install

CentOS / RedHat 7

yum -y install https://extras.getpagespeed.com/release-el7-latest.rpm
yum -y install http://rpms.remirepo.net/enterprise/remi-release-7.rpm yum-utils
yum-config-manager --enable remi-php73
yum install nginx-module-php7

Edit nginx.conf and load the required modules at the top:

load_module modules/ndk_http_module.so;
load_module modules/ngx_http_php_module.so;

Ubuntu

apt-get update -yqq && apt-get install -yqq software-properties-common
LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php
apt-get update -yqq
apt-get install -yqq wget git unzip libxml2-dev cmake make systemtap-sdt-dev \
                     zlib1g-dev libpcre3-dev libargon2-0-dev libsodium-dev libkrb5-dev \
                     php7.4-cli php7.4-dev libphp7.4-embed php7.4-mysql

git clone https://github.com/rryqszq4/ngx-php.git

wget 'http://nginx.org/download/nginx-1.18.0.tar.gz'
tar -zxvf nginx-1.18.0.tar.gz
cd nginx-1.18.0

export PHP_LIB=/usr/lib

./configure --user=www --group=www \
            --prefix=/path/to/nginx \
            --with-ld-opt="-Wl,-rpath,$PHP_LIB" \
            --add-module=/path/to/ngx-php/third_party/ngx_devel_kit \
            --add-module=/path/to/ngx-php
make && make install

Mac osx

https://github.com/rryqszq4/ngx-php/blob/master/docs/zh-cn/osx_install.md

Docker

$ docker build -t nginx-php7 .
$ : "app.conf: Create nginx config"
$ docker run -p 80:80 -v $PWD/app.conf:/etc/nginx/conf.d/default.conf nginx-php7

Synopsis

worker_processes  auto;

events {
    worker_connections  102400;
}

http {
    include       mime.types;
    default_type  application/octet-stream;

    keepalive_timeout  65;
    
    client_max_body_size 64k;   
    client_body_buffer_size 64k;

    php_ini_path /usr/local/php/etc/php.ini;

    server {
        listen       80;
        server_name  localhost;
        default_type 'application/json; charset=UTF-8';
    
        location /php {
            content_by_php_block {
                echo "hello ngx-php";
            }
        }

        location = /ngx_request {
            content_by_php_block {
                echo ngx_request_document_uri();
            }
        }

        # curl /ngx_get?a=1&b=2
        location = /ngx_get {
            content_by_php_block {
                echo "ngx_query_args()\n";
                var_dump(ngx_query_args());
            }
        }

        # curl -d 'a=1&b=2' /ngx_post
        location = /ngx_post {
            content_by_php_block {
                echo "ngx_post_args()\n";
                var_dump(ngx_post_args());
            }
        }

        location = /ngx_sleep {
            content_by_php_block {
                echo "ngx_sleep start\n";
                yield ngx_sleep(1);
                echo "ngx_sleep end\n";
            }
        }

        location = /ngx_socket2 {
            default_type 'application/json;charset=UTF-8';
            content_by_php_block {
                $fd = ngx_socket_create();

                yield ngx_socket_connect($fd, "httpbin.org", 80);

                $send_buf = "GET /get HTTP/1.1\r\n
                                            Host: httpbin.org\r\n
                                            Connection: close\r\n\r\n";
                yield ngx_socket_send($fd, $send_buf, strlen($send_buf));

                $recv_buf = "";
                yield ngx_socket_recv($fd, $recv_buf);
                var_dump($recv_buf);
                
                yield ngx_socket_close($fd);
            }
        }

        location = /ngx_var {
            set $a 1234567890;
            content_by_php_block {
                $a = ngx_var_get("a");
                var_dump($a);
            }
        }
        
        # set content-type of response headers
        location = /ngx_header {
            content_by_php_block {
                ngx_header_set("Content-Type", "text/html; charset=UTF-8");
            }
        }

        # run a php file
        location = /php {
            content_by_php_block {
                include "name_of_php_file.php";
            }
        }
        
        # run any php file in root
        location = / {
            content_by_php_block {
                include ngx_var_get("uri");
            }
        }

    }
}

Test

Using the perl of Test::Nginx module to testing, searching and finding out problem in ngx-php.

Ngx-php test ...
nginx version: nginx/1.22.1
built by gcc 9.4.0 (Ubuntu 9.4.0-1ubuntu1~20.04.1) 
configure arguments: --prefix=/home/runner/work/ngx-php/ngx-php/nginx --with-ld-opt=-Wl,-rpath,/usr/lib --add-module=../third_party/ngx_devel_kit --add-module=..
/home/runner/work/ngx-php/ngx-php
t/001-hello.t ..................... ok
t/002-ini.t ....................... ok
t/003-error.t ..................... ok
t/004-ngx_request.t ............... ok
t/005-ngx_log.t ................... ok
t/006-ngx_sleep.t ................. ok
t/007-ngx_socket.t ................ ok
t/008-ngx_exit.t .................. ok
t/009-ngx_query_args.t ............ ok
t/010-ngx_post_args.t ............. ok
t/011-ngx_constants.t ............. ok
t/012-function.t .................. ok
t/013-class.t ..................... ok
t/014-ngx_var.t ................... ok
t/015-ngx_header.t ................ ok
t/016-rewrite_by_php.t ............ ok
t/017-ngx_redirect.t .............. ok
t/018-ngx_mysql.t ................. skipped: Fix later
t/019-php_set.t ................... ok
t/020-ngx_cookie.t ................ ok
t/021-content_by_php_block.t ...... ok
t/022-init_worker_by_php_block.t .. ok
t/023-ngx_redis.t ................. ok
t/024-ngx_request_body.t .......... ok
t/025-opcache.t ................... ok
All tests successful.
Files=25, Tests=92, 16 wallclock secs ( 0.08 usr  0.04 sys +  4.56 cusr  0.93 csys =  5.61 CPU)
Result: PASS

Directives

• php_ini_path
• init_worker_by_php
• init_worker_by_php_block
• rewrite_by_php
• rewrite_by_php_block
• access_by_php
• access_by_php_block
• content_by_php
• content_by_php_block
• log_by_php
• log_by_php_block
• header_filter_by_php
• header_filter_by_php_block
• body_filter_by_php
• body_filter_by_php_block
• php_keepalive
• php_set
• php_socket_keepalive
• php_socket_buffer_size

php_ini_path

syntax: php_ini_path<php.ini file path>

context: http

phase: loading-config

This directive allows loading the official php configuration file php.ini, which will be used by subsequent PHP code.

init_worker_by_php

syntax: init_worker_by_php<php script code>

context: http

phase: starting-worker

init_worker_by_php_block

syntax: init_worker_by_php_block{php script code}

context: http

phase: starting-worker

rewrite_by_php

syntax: rewrite_by_php<php script code>

context: http, server, location, location if

phase: rewrite

In the rewrite phase of nginx, you can execute inline php code.

rewrite_by_php_block

syntax: rewrite_by_php_block{php script code}

context: location, location if

phase: rewrite

In the rewrite phase of nginx, you can execute inline php code.

access_by_php

syntax: access_by_php<php script code>

context: http, server, location, location if

phase: access

In the access phase of nginx, you can execute inline php code.

access_by_php_block

syntax: access_by_php_block{php script code}

context: location, location if

phase: access

In the access phase of nginx, you can execute inline php code.

content_by_php

syntax: content_by_php<php script code>

context: http, server, location, location if

phase: content

In the content phase of nginx, you can execute inline php code.

content_by_php_block

syntax: content_by_php_block{php script code}

context: location, location if

phase: content

In the content phase of nginx, you can execute inline php code.

log_by_php

syntax: log_by_php<php script code>

context: http, server, location, location if

phase: log

log_by_php_block

syntax: log_by_php_block{php script code}

context: location, location if

phase: log

header_filter_by_php

syntax: header_filter_by_php<php script code>

context: http, server, location, location if

phase: output-header-filter

header_filter_by_php_block

syntax: header_filter_by_php_block{php script code}

context: location, location if

phase: output-header-filter

body_filter_by_php

syntax: body_filter_by_php<php script code>

context: http, server, location, location if

phase: output-body-filter

body_filter_by_php_block

syntax: body_filter_by_php_block{php script code}

context: location, location if

phase: output-body-filter

php_keepalive

syntax: php_keepalive<size>

default: 0

context: http, server

In php, set upstream connection pool size.

php_set

syntax: php_set$variable <php script code>

context: http, server, location, location if

phase: loading-config

Installs a php handler for the specified variable.

php_socket_keepalive

syntax: php_socket_keepalive<size>

default: 0

context: http, server

php_socket_buffer_size

syntax: php_socket_buffer_size<size>

default: 4k

context: http, server, location, location if

Nginx API for php

• ngx_exit
• ngx_query_args
• ngx_post_args
• ngx_log_error
• ngx_request_method
• ngx_request_document_root
• ngx_request_document_uri
• ngx_request_script_name
• ngx_request_script_filename
• ngx_request_query_string
• ngx_request_uri
• ngx_request_server_protocol
• ngx_request_remote_addr
• ngx_request_server_addr
• ngx_request_remote_port
• ngx_request_server_port
• ngx_request_server_name
• ngx_request_headers
• ngx_var_get
• ngx_var_set
• ngx_header_set
• ngx_header_get
• ngx_header_get_all
• ngx_redirect
• ngx_cookie_get_all
• ngx_cookie_get
• ngx_cookie_set

ngx_exit

syntax: ngx_exit(int $status) : void

parameters:

• status: int

context: rewrite_by_php*, access_by_php*, content_by_php*

End of current request and return http status code.

ngx_query_args

syntax: ngx_query_args(void) : array or ngx::query_args(void) : array

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

An associative array of variables passed to the current script via the URL parameters (aka. query string).
Instead of php official constant $_GET.

ngx_post_args

syntax: ngx_post_args(void) : array or ngx::post_args(void) : array

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

An associative array of variables passed to the current script via the HTTP POST method
when using application/x-www-form-urlencoded or multipart/form-data as the HTTP Content-Type in the request.
Instead of php official constant $_POST.

ngx_log_error

syntax: ngx_log_error(int $level, string $log_str) : void or ngx_log::error(int $level, string $log_str) : void

parameters:

• level: int
• log_str: string

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_request_method

syntax: ngx_request_method(void) : string or ngx_request::method(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

Which request method was used to access the page, such as 'GET','POST','PUT','DELETE' and so on.

ngx_request_document_root

syntax: ngx_request_document_root(void) : string or ngx_request::document_root(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The document root directory under which the current script is executing, as defined in the server's configuration file.

ngx_request_document_uri

syntax: ngx_request_document_uri(void) : string or ngx_request::document_uri(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_request_script_name

syntax: ngx_request_script_name(void) : string or ngx_request::script_name(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

Contains the current script'path. This is useful for pages which need to point to the themselves.
The FILE constant contains the full path and filename of the current (included) file.

ngx_request_script_filename

syntax: ngx_request_script_filename(void) : string or ngx_request::script_filename(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The absolute pathname of the currently executing script file name.

ngx_request_query_string

syntax: ngx_request_query_string(void) : string or ngx_request::query_string(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The query string, if any, via which the page was accessed.

ngx_request_uri

syntax: ngx_request_uri(void) : string or ngx_request::uri(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The URI which was given in order to access this page, for instance, '/index.html'.

ngx_request_server_protocol

syntax: ngx_request_server_protocol(void) : string or ngx_request::server_protocol(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

Name and revision of th information protocol via which the page was requested, such as 'HTTP/1.0'.

ngx_request_remote_addr

syntax: ngx_request_remote_addr(void) : string or ngx_request::remote_addr(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The IP address from which the user is viewing the current page.

ngx_request_server_addr

syntax: ngx_request_server_addr(void) : string or ngx_request::server_addr(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The IP address of the server under which the current script is executing.

ngx_request_remote_port

syntax: ngx_request_remote_port(void) : int or ngx_request::remote_port(void) : int

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The port being used on the user's machine to communicate with the web server.

ngx_request_server_port

syntax: ngx_request_server_port(void) : int or ngx_request::server_port(void) : int

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The port on the server machine being used by the web server for communication. For default setups,
this will be '80'; using SSL, for instance, will change this to whatever your defined secure HTTP port is.

ngx_request_server_name

syntax: ngx_request_server_name(void) : string or ngx_request::server_name(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

The name of the server host under which the current script is executing.
If the script is running on a virtual host, this will be the value defined for that virtual host.

ngx_request_headers

syntax: ngx_request_headers(void): array or ngx_request::headers(void) : array

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

Get the header full information of the http request.

ngx_var_get

syntax: ngx_var_get(string $key) : string or ngx_var::get(string $key) : string

parameters:

• key: string

context: rewrite_by_php*, access_by_php*, content_by_php*

Get the variables in the nginx configuration.

ngx_var_set

syntax: ngx_var_set(string $key, string $value) : void or ngx_var::set(string $key, string $value) : void

parameters:

• key: string
• value: string

context: rewrite_by_php*, access_by_php*, content_by_php*

Set the variables in the nginx configuration.

ngx_header_set

syntax: ngx_header_set(string $key, string $value) : bool

parameters:

• key: string
• value: string

context: rewrite_by_php*, access_by_php*, content_by_php*

Set the header information of the http response.

ngx_header_get

syntax: ngx_header_get(string $key) : string

parameters:

• key: string

context: rewrite_by_php*, access_by_php*, content_by_php*

Get the header information of the http response.

ngx_header_gets

syntax: ngx_header_gets(void) : array

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

Get the header full information of the http response.

ngx_redirect

syntax: ngx_redirect(string $uri, int $status) : bool

parameters:

• uri: string
• status: int

context: rewrite_by_php*, access_by_php*, content_by_php*

Set response header redirection.

ngx_cookie_get_all

syntax: ngx_cookie_get_all(void) : string

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_cookie_get

syntax: ngx_cookie_get(string $key) : string

parameters:

• key: string

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_cookie_set

syntax: ngx_cookie_set(string $data): bool

parameters:

• data: string

context: rewrite_by_php*, access_by_php*, content_by_php*

Nginx non-blocking API for php

• yield ngx_sleep
• yield ngx_msleep
• ngx_socket_create
• ngx_socket_iskeepalive
• yield ngx_socket_connect
• yield ngx_socket_close
• yield ngx_socket_send
• yield ngx_socket_recv
• yield ngx_socket_recvpage
• ngx_socket_recvsync
• ngx_socket_clear

ngx_sleep

syntax: yield ngx_sleep(int seconds)

parameters:

• secodes: int

context: rewrite_by_php*, access_by_php*, content_by_php*

Delays the program execution for the given number of seconds.

ngx_msleep

syntax: yield ngx_msleep(int milliseconds)

parameters:

• milliseconds: int

context: rewrite_by_php*, access_by_php*, content_by_php*

Delays the program execution for the given number of milliseconds.

ngx_socket_create

syntax: ngx_socket_create(int $domain, int $type, int $protocol) : resource

parameters:

• domain: int
• type: int
• protocol: int

context: rewrite_by_php*, access_by_php*, content_by_php*

Creates and returns a socket resource, also referred to as an endpoint of communication.
A typical network connection is made up of 2 sockets, one performing the role of the client,
and another performing the role of the server.

ngx_socket_iskeepalive

syntax: ngx_socket_iskeepalive(void) : bool

parameters:

• void

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_socket_connect

syntax: ( yield ngx_socket_connect(resource $socket, string $address, int $port) ) : bool

parameters:

• socket: resource
• address: string
• port: int

context: rewrite_by_php*, access_by_php*, content_by_php*

Initiate a connection to address using the socket resource socket, which must be a valid
socket resource created with ngx_socket_create().

ngx_socket_close

syntax: ( yield ngx_socket_close(resource $socket) ) : bool

parameters:

• socket: resource

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_socket_close() closes the socket resource given by socket. This function is specific to
sockets and cannot be used on any other type of resources.

ngx_socket_send

syntax: ( yield ngx_socket_send(resource $socket, string $buf, int $len) ) : int

parameters:

• socket: resource
• buf: string
• len: int

context: rewrite_by_php*, access_by_php*, content_by_php*

The function ngx_socket_send() sends len bytes to the socket socket from buf.

ngx_socket_recv

syntax: ( yield ngx_socket_recv(resource $socket, string &$buf, int $len) ) : int

parameters:

• socket: resource
• buf: string
• len: int

context: rewrite_by_php*, access_by_php*, content_by_php*

The ngx_socket_recv() function receives len bytes of data in buf from socket. ngx_socket_recv() can be
used to gather data from connected sockets.

buf is passed by reference, so it must be specified as a variable in the argument list.
Data read from socket by ngx_socket_recv() will be returned in buf.

ngx_socket_recvpage

syntax: ( yield ngx_socket_recvpage(resource $socket, string &$buf, int &$rc) ) : int

parameters:

• socket: resource
• buf: string
• rc: int

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_socket_recvsync

syntax: ngx_socket_recvsync(resource $socket, string &$buf, int $len) : int

parameters:

• socket: resource
• buf: string
• len: int

context: rewrite_by_php*, access_by_php*, content_by_php*

ngx_socket_clear

syntax: ngx_socket_recv(resource $socket) : bool

parameters:

• socket: resource

context: rewrite_by_php*, access_by_php*, content_by_php*

Close the socket resource and is blocking but hight performance.

Nginx constants

• version constants
• log constants for php
• status constants for php
• http status constants for php

version constants

log constants for php

status constants for php

http status constants for php

Copyright and License

Copyright (c) 2016-2020, rryqszq4 <rryqszq@gmail.com>
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.