ngx_http_not_modified_filter_module 源码分析

[vislee]

概述

not modified filter 是第一个被调用的过滤模块，用来处理http缓存字段的。

和该模块相关的配置指令： if_modified_since off | exact | before; off：忽略请求头该字段，不进行缓存更新时间比较。 exact： 时间必需相等才认为缓存有效，返回304. before：传递的有效时间大于文件更新时间缓存有效，返回304.

先了解一下http关于缓存的几个头部的字段。

• 通用首部字段 Cache-Control 控制缓存的行为，缓存存储策略。

  • Public 作为响应首部，表明任何情况下都得缓存该资源。
  • Private 作为响应首部，表明部分可以缓存。
  • no-store 作为响应首部，不缓存资源。
  • no-cache 作为响应首部，会缓存只不过立即就过期了需要根据last-modified再次发送请求验证。
  • max-age 作为响应首部，告知客户端几秒内资源是新鲜的，无需向服务器发请求。
  • s-maxage 用于代理
  • max-stale
  • min-fresh
  • no-transform 作为响应首部，告知客户端缓存文件时不得对实体数据做任何改变。作为请求首部，告知服务器客户端希望获取未被转换过的数据。
  • only-if-cached 告知代理服务器客户端希望获取缓存的内容（若有），而不用向原服务器发去请求。
  • must-revalidate
  • proxy-revalidate
  • cacjed-extemsopm

• 请求首部字段 If-Match 比较etag是否一致，412 If-None-Match 比较etag是否不一致，etag不一致重发源数据，一致则返回304和响应头。 If-Modified-Since 比较资源最后更新的时间是否一致，再次请求时传递缓存资源的Last-Modified时间。如果一致则直接返回304，不一致则返回资源。 If-Unmodified-Since 比较资源最后的更新的时间是否不一致，不一致则返回412，否则返回资源。

• 响应首部 Etag 资源的匹配信息

• 实体首部字段 Expires 实体主体过期的时间 Last-Modified 资源的最后一次修改的时间

代码

static ngx_int_t
ngx_http_not_modified_header_filter(ngx_http_request_t *r)
{
    // 不是200的，或者是子请求，不处理。
    if (r->headers_out.status != NGX_HTTP_OK
        || r != r->main
        || r->disable_not_modified)
    {
        return ngx_http_next_header_filter(r);
    }

    // 比较 资源时间如果没有修改，则继续执行。如果有修改则返回412.
    if (r->headers_in.if_unmodified_since
        && !ngx_http_test_if_unmodified(r))
    {
        return ngx_http_filter_finalize_request(r, NULL,
                                                NGX_HTTP_PRECONDITION_FAILED);
    }

    // 比较etag如果一致则继续执行，否则返回412
    if (r->headers_in.if_match
        && !ngx_http_test_if_match(r, r->headers_in.if_match, 0))
    {
        return ngx_http_filter_finalize_request(r, NULL,
                                                NGX_HTTP_PRECONDITION_FAILED);
    }

    if (r->headers_in.if_modified_since || r->headers_in.if_none_match) {

        if (r->headers_in.if_modified_since
            && ngx_http_test_if_modified(r))
        {
            // 资源时间已经更新，继续执行。
            return ngx_http_next_header_filter(r);
        }

        if (r->headers_in.if_none_match
            && !ngx_http_test_if_match(r, r->headers_in.if_none_match, 1))
        {
            // 资源etag 已经更新，继续执行。
            return ngx_http_next_header_filter(r);
        }

        /* not modified */
        // 资源没有更新返回304
        r->headers_out.status = NGX_HTTP_NOT_MODIFIED;
        r->headers_out.status_line.len = 0;
        r->headers_out.content_type.len = 0;
        ngx_http_clear_content_length(r);
        ngx_http_clear_accept_ranges(r);

        if (r->headers_out.content_encoding) {
            r->headers_out.content_encoding->hash = 0;
            r->headers_out.content_encoding = NULL;
        }

        return ngx_http_next_header_filter(r);
    }

    // 不做缓存处理
    return ngx_http_next_header_filter(r);
}

static ngx_uint_t
ngx_http_test_if_unmodified(ngx_http_request_t *r)
{
    time_t  iums;

    if (r->headers_out.last_modified_time == (time_t) -1) {
        return 0;
    }

    iums = ngx_parse_http_time(r->headers_in.if_unmodified_since->value.data,
                               r->headers_in.if_unmodified_since->value.len);

    ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                 "http iums:%T lm:%T", iums, r->headers_out.last_modified_time);

    if (iums >= r->headers_out.last_modified_time) {
        return 1;
    }

    return 0;
}

static ngx_uint_t
ngx_http_test_if_modified(ngx_http_request_t *r)
{
    time_t                     ims;
    ngx_http_core_loc_conf_t  *clcf;

    if (r->headers_out.last_modified_time == (time_t) -1) {
        return 1;
    }

    clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);

    if (clcf->if_modified_since == NGX_HTTP_IMS_OFF) {
        return 1;
    }

    ims = ngx_parse_http_time(r->headers_in.if_modified_since->value.data,
                              r->headers_in.if_modified_since->value.len);

    ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                   "http ims:%T lm:%T", ims, r->headers_out.last_modified_time);

    if (ims == r->headers_out.last_modified_time) {
        return 0;
    }

    if (clcf->if_modified_since == NGX_HTTP_IMS_EXACT
        || ims < r->headers_out.last_modified_time)
    {
        return 1;
    }

    return 0;
}

static ngx_uint_t
ngx_http_test_if_match(ngx_http_request_t *r, ngx_table_elt_t *header,
    ngx_uint_t weak)
{
    u_char     *start, *end, ch;
    ngx_str_t   etag, *list;

    list = &header->value;

    if (list->len == 1 && list->data[0] == '*') {
        // if-match 继续执行。if-none-match 返回304。
        return 1;
    }

    if (r->headers_out.etag == NULL) {
       // 新resp资源没有etag，if-match 返回412，if-none-match 继续执行
        return 0;
    }

    etag = r->headers_out.etag->value;

    ngx_log_debug2(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
                   "http im:\"%V\" etag:%V", list, &etag);

    if (weak
        && etag.len > 2
        && etag.data[0] == 'W'
        && etag.data[1] == '/')
    {
        etag.len -= 2;
        etag.data += 2;
    }

    start = list->data;
    end = list->data + list->len;

    while (start < end) {
        // etag 弱验证
        if (weak
            && end - start > 2
            && start[0] == 'W'
            && start[1] == '/')
        {
            start += 2;
        }

        if (etag.len > (size_t) (end - start)) {
            return 0;
        }

        if (ngx_strncmp(start, etag.data, etag.len) != 0) {
            goto skip;
        }

        start += etag.len;

        while (start < end) {
            ch = *start;

            if (ch == ' ' || ch == '\t') {
                start++;
                continue;
            }

            break;
        }

        if (start == end || *start == ',') {
            return 1;
        }

    skip:

        while (start < end && *start != ',') { start++; }
        while (start < end) {
            ch = *start;

            if (ch == ' ' || ch == '\t' || ch == ',') {
                start++;
                continue;
            }

            break;
        }
    }

    return 0;
}