nginx 内置模块解析 - ngx_http_static_module

2018-07-26 08:52:26

ngx_http_static_module 模块是 nginx 比较原始且重要的模块,用来读取磁盘上的文件并把读取的数据当做内容输出。

如果 uri 是以 / 结尾,则会交由 index 模块来链接上完整的路径名然后通过内部调用的方式来调用本模块。

如果指定的文件是目录,则会返回 301 并跳转。

#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>


// 读取磁盘上的静态文件作为响应内容
static ngx_int_t ngx_http_static_handler(ngx_http_request_t *r);

// postconfiguration,注册处理函数
static ngx_int_t ngx_http_static_init(ngx_conf_t *cf);


// 仅一个函数指针,注册处理函数
static ngx_http_module_t  ngx_http_static_module_ctx = {
    NULL,                                  /* preconfiguration */
    ngx_http_static_init,                  /* postconfiguration */

    NULL,                                  /* create main configuration */
    NULL,                                  /* init main configuration */

    NULL,                                  /* create server configuration */
    NULL,                                  /* merge server configuration */

    NULL,                                  /* create location configuration */
    NULL                                   /* merge location configuration */
};


ngx_module_t  ngx_http_static_module = {
    NGX_MODULE_V1,
    &ngx_http_static_module_ctx,           /* module context */
    NULL,                                  /* module directives */
    NGX_HTTP_MODULE,                       /* module type */
    NULL,                                  /* init master */
    NULL,                                  /* init module */
    NULL,                                  /* init process */
    NULL,                                  /* init thread */
    NULL,                                  /* exit thread */
    NULL,                                  /* exit process */
    NULL,                                  /* exit master */
    NGX_MODULE_V1_PADDING
};
// postconfiguration,注册处理函数
static ngx_int_t
ngx_http_static_init(ngx_conf_t *cf)
{
    ngx_http_handler_pt        *h;
    ngx_http_core_main_conf_t  *cmcf;

    // 获取core模块的main conf
    cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

    // 使用CONTENT_PHASE
    // 对所有的location都有效
    // 还有另外一种注册方式,只对特定的 location 有效
    h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
    if (h == NULL) {
        return NGX_ERROR;
    }

    // 添加到phases数组,完成注册
    *h = ngx_http_static_handler;

    return NGX_OK;
}
// 读取磁盘上的静态文件作为响应内容
static ngx_int_t
ngx_http_static_handler(ngx_http_request_t *r)
{
    u_char                    *last, *location;
    size_t                     root, len;
    ngx_str_t                  path;
    ngx_int_t                  rc;
    ngx_uint_t                 level;
    ngx_log_t                 *log;
    ngx_buf_t                 *b;
    ngx_chain_t                out;
    ngx_open_file_info_t       of;
    ngx_http_core_loc_conf_t  *clcf;

    // 检查method,必须是get/head/post
    if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD|NGX_HTTP_POST))) {
        return NGX_HTTP_NOT_ALLOWED;
    }

    // 检查uri,最后一个字符不能是'/',也就是说不允许操作目录
    // 如果是目录,会转交index模块处理
    if (r->uri.data[r->uri.len - 1] == '/') {
        return NGX_DECLINED;
    }

    log = r->connection->log;

    // 把文件的绝对路径 + \0 存入 path。
    // last 指向最后1个字节 \0
    last = ngx_http_map_uri_to_path(r, &path, &root, 0);
    if (last == NULL) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // 获取path长度
    path.len = last - path.data;

    // 获取core loc conf
    clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);

    // 设置打开文件的选项
    ngx_memzero(&of, sizeof(ngx_open_file_info_t));

    of.read_ahead = clcf->read_ahead;
    of.directio = clcf->directio;
    of.valid = clcf->open_file_cache_valid;
    of.min_uses = clcf->open_file_cache_min_uses;
    of.errors = clcf->open_file_cache_errors;
    of.events = clcf->open_file_cache_events;

    // 如果文件是符号链接,则会根据  disable_symlinks 指令来判断是否合法
    if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // 从打开文件缓存里取出文件描述符和文件信息,没有缓存则打开后再缓存,来避免多次的 open、stat 等系统调用
    // 相关配置指令为 open_file_cache
    if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
        != NGX_OK)
    {
        switch (of.err) {

        case 0:
            return NGX_HTTP_INTERNAL_SERVER_ERROR;

        case NGX_ENOENT:
        case NGX_ENOTDIR:
        case NGX_ENAMETOOLONG:

            level = NGX_LOG_ERR;
            rc = NGX_HTTP_NOT_FOUND;
            break;

        case NGX_EACCES:
#if (NGX_HAVE_OPENAT)
        case NGX_EMLINK:
        case NGX_ELOOP:
#endif

            level = NGX_LOG_ERR;
            rc = NGX_HTTP_FORBIDDEN;
            break;

        default:

            level = NGX_LOG_CRIT;
            rc = NGX_HTTP_INTERNAL_SERVER_ERROR;
            break;
        }

        if (rc != NGX_HTTP_NOT_FOUND || clcf->log_not_found) {
            ngx_log_error(level, log, of.err,
                          "%s \"%s\" failed", of.failed, path.data);
        }

        return rc;
    }

    r->root_tested = !r->error_page;


    //如果访问的文件是目录,那么利用 301 在响应头里附上 Location: /dir/
    //比如访问的是 /test/dir?age=22
    //则在响应头里返回 Location: /test/dir/?age=22
    if (of.is_dir) {
        ngx_http_clear_location(r);

        r->headers_out.location = ngx_list_push(&r->headers_out.headers);
        if (r->headers_out.location == NULL) {
            return NGX_HTTP_INTERNAL_SERVER_ERROR;
        }

        len = r->uri.len + 1;


        if (!clcf->alias && clcf->root_lengths == NULL && r->args.len == 0) {
            location = path.data + clcf->root.len;

            *last = '/';

        } else {
            if (r->args.len) {
                len += r->args.len + 1;
            }

            location = ngx_pnalloc(r->pool, len);
            if (location == NULL) {
                ngx_http_clear_location(r);
                return NGX_HTTP_INTERNAL_SERVER_ERROR;
            }

            last = ngx_copy(location, r->uri.data, r->uri.len);

            *last = '/';

            if (r->args.len) {
                *++last = '?';
                ngx_memcpy(++last, r->args.data, r->args.len);
            }
        }

        //设置跳转
        r->headers_out.location->hash = 1;
        ngx_str_set(&r->headers_out.location->key, "Location");
        r->headers_out.location->value.len = len;
        r->headers_out.location->value.data = location;

        return NGX_HTTP_MOVED_PERMANENTLY;
    }

    //不是常规文件
    if (!of.is_file) {
        ngx_log_error(NGX_LOG_CRIT, log, 0,
                      "\"%s\" is not a regular file", path.data);

        return NGX_HTTP_NOT_FOUND;
    }

    // 不允许post数据到一个文件
    // 即只允许get/head
    if (r->method == NGX_HTTP_POST) {
        return NGX_HTTP_NOT_ALLOWED;
    }

    // 丢弃请求体
    rc = ngx_http_discard_request_body(r);

    if (rc != NGX_OK) {
        return rc;
    }

    log->action = "sending response to client";

    // 设置响应头信息:状态码,长度,修改时间
    r->headers_out.status = NGX_HTTP_OK;
    r->headers_out.content_length_n = of.size;
    r->headers_out.last_modified_time = of.mtime;

    // 设置etag头
    if (ngx_http_set_etag(r) != NGX_OK) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // content type
    if (ngx_http_set_content_type(r) != NGX_OK) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // r != r->main 子请求
    // of.size == 0 文件长度是0
    // 那么就只发送头,没有实际的响应数据
    if (r != r->main && of.size == 0) {
        return ngx_http_send_header(r);
    }

    // 允许range请求
    r->allow_ranges = 1;

    /* we need to allocate all before the header would be sent */

    // 创建一个缓冲区结构体,注意不分配实际内存
    // before 1.14.0
    // b = ngx_pcalloc(r->pool, sizeof(ngx_buf_t));
    b = ngx_calloc_buf(r->pool);
    if (b == NULL) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // 创建一个文件结构体,用于描述磁盘文件
    b->file = ngx_pcalloc(r->pool, sizeof(ngx_file_t));
    if (b->file == NULL) {
        return NGX_HTTP_INTERNAL_SERVER_ERROR;
    }

    // 先发送头
    rc = ngx_http_send_header(r);

    // 发送出错,或者head请求,就无需发送body
    if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
        return rc;
    }

    // 设置缓冲区里的file位置信息
    b->file_pos = 0;
    b->file_last = of.size;

    b->in_file = b->file_last ? 1: 0;

    // 如果是主请求,那么last_buf,即最后一块数据
    b->last_buf = (r == r->main) ? 1: 0;

    // 因为只有一块数据,链里的唯一一个也就是最后一个
    b->last_in_chain = 1;

    b->file->fd = of.fd;
    b->file->name = path;
    b->file->log = log;
    b->file->directio = of.is_directio;

    // 把缓冲区放进链表里
    out.buf = b;

    // 重要操作,链表的指针必须是nullptr,否则会发生严重错误
    out.next = NULL;

    // 调用过滤链表,走过滤模块,最终发送给客户端
    return ngx_http_output_filter(r, &out);
}


备注

1.测试环境centos7 64位,nginx版本为 1.14.0。
2..原文地址http://www.freecls.com/a/2712/da


©著作权归作者所有
收藏
推荐阅读
简介
天降大任于斯人也,必先苦其心志。