php_functions.c

Go to the documentation of this file.

/*
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Author: Sascha Schumann <sascha@schumann.cx>                         |
   +----------------------------------------------------------------------+
 */
 
#define ZEND_INCLUDE_FULL_WINDOWS_HEADERS
 
#include "php.h"
#ifdef strcasecmp
# undef strcasecmp
#endif
#ifdef strncasecmp
# undef strncasecmp
#endif
#include "zend_smart_str.h"
#include "ext/standard/info.h"
#include "ext/standard/head.h"
#include "php_ini.h"
#include "SAPI.h"
 
#include "apr_strings.h"
#include "apr_time.h"
#include "ap_config.h"
#include "util_filter.h"
#include "httpd.h"
#include "http_config.h"
#include "http_request.h"
#include "http_core.h"
#include "http_protocol.h"
#include "http_log.h"
#include "http_main.h"
#include "util_script.h"
#include "http_core.h"
#include "ap_mpm.h"
#ifndef PHP_WIN32
#include "unixd.h"
#endif
 
#include "php_apache.h"
#include "php_functions_arginfo.h"
 
#ifdef ZTS
int php_apache2_info_id;
#else
php_apache2_info_struct php_apache2_info;
#endif
 
#define SECTION(name)  PUTS("<h2>" name "</h2>\n")
 
static request_rec *php_apache_lookup_uri(char *filename)
{
    php_struct *ctx = SG(server_context);
 
    if (!filename || !ctx || !ctx->r) {
        return NULL;
    }
 
    return ap_sub_req_lookup_uri(filename, ctx->r, ctx->r->output_filters);
}
 
/* {{{ Perform an apache sub-request */
PHP_FUNCTION(virtual)
{
    char *filename;
    size_t filename_len;
    request_rec *rr;
 
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "p", &filename, &filename_len) == FAILURE) {
        RETURN_THROWS();
    }
 
    if (!(rr = php_apache_lookup_uri(filename))) {
        php_error_docref(NULL, E_WARNING, "Unable to include '%s' - URI lookup failed", filename);
        RETURN_FALSE;
    }
 
    if (rr->status != HTTP_OK) {
        php_error_docref(NULL, E_WARNING, "Unable to include '%s' - error finding URI", filename);
        ap_destroy_sub_req(rr);
        RETURN_FALSE;
    }
 
    /* Flush everything. */
    php_output_end_all();
    php_header();
 
    /* Ensure that the ap_r* layer for the main request is flushed, to
     * work around http://issues.apache.org/bugzilla/show_bug.cgi?id=17629 */
    ap_rflush(rr->main);
 
    if (ap_run_sub_req(rr)) {
        php_error_docref(NULL, E_WARNING, "Unable to include '%s' - request execution failed", filename);
        ap_destroy_sub_req(rr);
        RETURN_FALSE;
    }
    ap_destroy_sub_req(rr);
    RETURN_TRUE;
}
/* }}} */
 
#define ADD_LONG(name) \
        add_property_long(return_value, #name, rr->name)
#define ADD_TIME(name) \
        add_property_long(return_value, #name, apr_time_sec(rr->name));
#define ADD_STRING(name) \
        if (rr->name) add_property_string(return_value, #name, (char *) rr->name)
 
PHP_FUNCTION(apache_lookup_uri)
{
    request_rec *rr;
    char *filename;
    size_t filename_len;
 
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "p", &filename, &filename_len) == FAILURE) {
        RETURN_THROWS();
    }
 
    if (!(rr = php_apache_lookup_uri(filename))) {
        php_error_docref(NULL, E_WARNING, "Unable to include '%s' - URI lookup failed", filename);
        RETURN_FALSE;
    }
 
    if (rr->status == HTTP_OK) {
        object_init(return_value);
 
        ADD_LONG(status);
        ADD_STRING(the_request);
        ADD_STRING(status_line);
        ADD_STRING(method);
        ADD_TIME(mtime);
        ADD_LONG(clength);
        ADD_STRING(range);
        ADD_LONG(chunked);
        ADD_STRING(content_type);
        ADD_STRING(handler);
        ADD_LONG(no_cache);
        ADD_LONG(no_local_copy);
        ADD_STRING(unparsed_uri);
        ADD_STRING(uri);
        ADD_STRING(filename);
        ADD_STRING(path_info);
        ADD_STRING(args);
        ADD_LONG(allowed);
        ADD_LONG(sent_bodyct);
        ADD_LONG(bytes_sent);
        ADD_LONG(mtime);
        ADD_TIME(request_time);
 
        ap_destroy_sub_req(rr);
        return;
    }
 
    php_error_docref(NULL, E_WARNING, "Unable to include '%s' - error finding URI", filename);
    ap_destroy_sub_req(rr);
    RETURN_FALSE;
}
 
/* {{{ Fetch all HTTP request headers */
PHP_FUNCTION(apache_request_headers)
{
    php_struct *ctx;
    const apr_array_header_t *arr;
    char *key, *val;
 
    if (zend_parse_parameters_none() == FAILURE) {
        RETURN_THROWS();
    }
 
    array_init(return_value);
 
    ctx = SG(server_context);
    arr = apr_table_elts(ctx->r->headers_in);
 
    APR_ARRAY_FOREACH_OPEN(arr, key, val)
        if (!val) val = "";
        add_assoc_string(return_value, key, val);
    APR_ARRAY_FOREACH_CLOSE()
}
/* }}} */
 
/* {{{ Fetch all HTTP response headers */
PHP_FUNCTION(apache_response_headers)
{
    php_struct *ctx;
    const apr_array_header_t *arr;
    char *key, *val;
 
    if (zend_parse_parameters_none() == FAILURE) {
        RETURN_THROWS();
    }
 
    array_init(return_value);
 
    ctx = SG(server_context);
    arr = apr_table_elts(ctx->r->headers_out);
 
    APR_ARRAY_FOREACH_OPEN(arr, key, val)
        if (!val) val = "";
        add_assoc_string(return_value, key, val);
    APR_ARRAY_FOREACH_CLOSE()
}
/* }}} */
 
/* {{{ Get and set Apache request notes */
PHP_FUNCTION(apache_note)
{
    php_struct *ctx;
    char *note_name, *note_val = NULL;
    size_t note_name_len, note_val_len;
    char *old_note_val=NULL;
 
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "s|s!", &note_name, &note_name_len, &note_val, &note_val_len) == FAILURE) {
        RETURN_THROWS();
    }
 
    ctx = SG(server_context);
 
    old_note_val = (char *) apr_table_get(ctx->r->notes, note_name);
 
    if (note_val) {
        apr_table_set(ctx->r->notes, note_name, note_val);
    }
 
    if (old_note_val) {
        RETURN_STRING(old_note_val);
    }
 
    RETURN_FALSE;
}
/* }}} */
 
 
/* {{{ Set an Apache subprocess_env variable */
/*
 * XXX this doesn't look right. shouldn't it be the parent ?*/
PHP_FUNCTION(apache_setenv)
{
    php_struct *ctx;
    char *variable=NULL, *string_val=NULL;
    size_t variable_len, string_val_len;
    bool walk_to_top = 0;
    int arg_count = ZEND_NUM_ARGS();
    request_rec *r;
 
    if (zend_parse_parameters(arg_count, "ss|b", &variable, &variable_len, &string_val, &string_val_len, &walk_to_top) == FAILURE) {
        RETURN_THROWS();
    }
 
    ctx = SG(server_context);
 
    r = ctx->r;
    if (arg_count == 3) {
        if (walk_to_top) {
            while(r->prev) {
                r = r->prev;
            }
        }
    }
 
    apr_table_set(r->subprocess_env, variable, string_val);
 
    RETURN_TRUE;
}
/* }}} */
 
/* {{{ Get an Apache subprocess_env variable */
/*
 * XXX: shouldn't this be the parent not the 'prev'
 */
PHP_FUNCTION(apache_getenv)
{
    php_struct *ctx;
    char *variable;
    size_t variable_len;
    bool walk_to_top = 0;
    int arg_count = ZEND_NUM_ARGS();
    char *env_val=NULL;
    request_rec *r;
 
    if (zend_parse_parameters(arg_count, "s|b", &variable, &variable_len, &walk_to_top) == FAILURE) {
        RETURN_THROWS();
    }
 
    ctx = SG(server_context);
 
    r = ctx->r;
    if (arg_count == 2) {
        if (walk_to_top) {
            while(r->prev) {
                r = r->prev;
            }
        }
    }
 
    env_val = (char*) apr_table_get(r->subprocess_env, variable);
 
    if (env_val != NULL) {
        RETURN_STRING(env_val);
    }
 
    RETURN_FALSE;
}
/* }}} */
 
static const char *php_apache_get_version(void)
{
    return ap_get_server_banner();
}
 
/* {{{ Fetch Apache version */
PHP_FUNCTION(apache_get_version)
{
    const char *apv = php_apache_get_version();
 
    if (apv && *apv) {
        RETURN_STRING(apv);
    } else {
        RETURN_FALSE;
    }
}
/* }}} */
 
/* {{{ Get a list of loaded Apache modules */
PHP_FUNCTION(apache_get_modules)
{
    int n;
    char *p;
 
    array_init(return_value);
 
    for (n = 0; ap_loaded_modules[n]; ++n) {
        const char *s = ap_loaded_modules[n]->name;
        if ((p = strchr(s, '.'))) {
            add_next_index_stringl(return_value, s, (p - s));
        } else {
            add_next_index_string(return_value, s);
        }
    }
}
/* }}} */
 
PHP_MINFO_FUNCTION(apache)
{
    const char *apv = php_apache_get_version();
    smart_str tmp1 = {0};
    char tmp[1024];
    int n, max_requests;
    char *p;
    server_rec *serv = ((php_struct *) SG(server_context))->r->server;
#ifndef PHP_WIN32
    AP_DECLARE_DATA extern unixd_config_rec ap_unixd_config;
#endif
 
    for (n = 0; ap_loaded_modules[n]; ++n) {
        const char *s = ap_loaded_modules[n]->name;
        if (n > 0) {
            smart_str_appendc(&tmp1, ' ');
        }
        if ((p = strchr(s, '.'))) {
            smart_str_appendl(&tmp1, s, (p - s));
        } else {
            smart_str_appends(&tmp1, s);
        }
    }
    if (!tmp1.s) {
        smart_str_appendc(&tmp1, '/');
    }
    smart_str_0(&tmp1);
 
    php_info_print_table_start();
    if (apv && *apv) {
        php_info_print_table_row(2, "Apache Version", apv);
    }
    snprintf(tmp, sizeof(tmp), "%d", MODULE_MAGIC_NUMBER_MAJOR);
    php_info_print_table_row(2, "Apache API Version", tmp);
 
    if (serv->server_admin && *(serv->server_admin)) {
        php_info_print_table_row(2, "Server Administrator", serv->server_admin);
    }
 
    snprintf(tmp, sizeof(tmp), "%s:%u", serv->server_hostname, serv->port);
    php_info_print_table_row(2, "Hostname:Port", tmp);
 
#ifndef PHP_WIN32
    snprintf(tmp, sizeof(tmp), "%s(%d)/%d", ap_unixd_config.user_name, ap_unixd_config.user_id, ap_unixd_config.group_id);
    php_info_print_table_row(2, "User/Group", tmp);
#endif
 
    ap_mpm_query(AP_MPMQ_MAX_REQUESTS_DAEMON, &max_requests);
    snprintf(tmp, sizeof(tmp), "Per Child: %d - Keep Alive: %s - Max Per Connection: %d", max_requests, (serv->keep_alive ? "on":"off"), serv->keep_alive_max);
    php_info_print_table_row(2, "Max Requests", tmp);
 
    apr_snprintf(tmp, sizeof tmp,
                 "Connection: %" APR_TIME_T_FMT " - Keep-Alive: %" APR_TIME_T_FMT,
                 apr_time_sec(serv->timeout), apr_time_sec(serv->keep_alive_timeout));
    php_info_print_table_row(2, "Timeouts", tmp);
 
    php_info_print_table_row(2, "Virtual Server", (serv->is_virtual ? "Yes" : "No"));
    php_info_print_table_row(2, "Server Root", ap_server_root);
    php_info_print_table_row(2, "Loaded Modules", ZSTR_VAL(tmp1.s));
 
    smart_str_free(&tmp1);
    php_info_print_table_end();
 
    DISPLAY_INI_ENTRIES();
 
    {
        const apr_array_header_t *arr = apr_table_elts(((php_struct *) SG(server_context))->r->subprocess_env);
        char *key, *val;
 
        SECTION("Apache Environment");
        php_info_print_table_start();
        php_info_print_table_header(2, "Variable", "Value");
        APR_ARRAY_FOREACH_OPEN(arr, key, val)
            if (!val) {
                val = "";
            }
            php_info_print_table_row(2, key, val);
        APR_ARRAY_FOREACH_CLOSE()
 
        php_info_print_table_end();
 
        SECTION("HTTP Headers Information");
        php_info_print_table_start();
        php_info_print_table_colspan_header(2, "HTTP Request Headers");
        php_info_print_table_row(2, "HTTP Request", ((php_struct *) SG(server_context))->r->the_request);
 
        arr = apr_table_elts(((php_struct *) SG(server_context))->r->headers_in);
        APR_ARRAY_FOREACH_OPEN(arr, key, val)
            if (!val) {
                val = "";
            }
                php_info_print_table_row(2, key, val);
        APR_ARRAY_FOREACH_CLOSE()
 
        php_info_print_table_colspan_header(2, "HTTP Response Headers");
        arr = apr_table_elts(((php_struct *) SG(server_context))->r->headers_out);
        APR_ARRAY_FOREACH_OPEN(arr, key, val)
            if (!val) {
                val = "";
            }
                php_info_print_table_row(2, key, val);
        APR_ARRAY_FOREACH_CLOSE()
 
        php_info_print_table_end();
    }
}
 
PHP_INI_BEGIN()
    STD_PHP_INI_BOOLEAN("xbithack",      "0",    PHP_INI_ALL, OnUpdateBool,   xbithack,   php_apache2_info_struct, php_apache2_info)
    STD_PHP_INI_BOOLEAN("engine",        "1",    PHP_INI_ALL, OnUpdateBool,   engine,     php_apache2_info_struct, php_apache2_info)
    STD_PHP_INI_BOOLEAN("last_modified", "0",    PHP_INI_ALL, OnUpdateBool,   last_modified,  php_apache2_info_struct, php_apache2_info)
PHP_INI_END()
 
static PHP_MINIT_FUNCTION(apache)
{
#ifdef ZTS
    ts_allocate_id(&php_apache2_info_id, sizeof(php_apache2_info_struct), (ts_allocate_ctor) NULL, NULL);
#endif
    REGISTER_INI_ENTRIES();
    return SUCCESS;
}
 
static PHP_MSHUTDOWN_FUNCTION(apache)
{
    UNREGISTER_INI_ENTRIES();
    return SUCCESS;
}
 
zend_module_entry php_apache_module = {
    STANDARD_MODULE_HEADER,
    "apache2handler",
    ext_functions,
    PHP_MINIT(apache),
    PHP_MSHUTDOWN(apache),
    NULL,
    NULL,
    PHP_MINFO(apache),
    PHP_VERSION,
    STANDARD_MODULE_PROPERTIES
};