One Level Up Top Level

src/http/modules/ngx_http_log_module.c - nginx-1.31.4 nginx/ @ 8d9666701

Global variables defined

Data types defined

Functions defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_http.h>

  12. #if (NGX_ZLIB)
  13. #include <zlib.h>
  14. #endif


  17. ‌typedef struct ngx_http_log_op_s  ngx_http_log_op_t;

  19. ‌typedef u_char *(*ngx_http_log_op_run_pt) (ngx_http_request_t *r, u_char *buf,
  20.     u_char *end, ngx_http_log_op_t *op);

  22. ‌typedef size_t (*ngx_http_log_op_getlen_pt) (ngx_http_request_t *r,
  23.     uintptr_t data);


  26. ‌struct ngx_http_log_op_s {
  27.     size_t                      len;
  28.     ngx_http_log_op_getlen_pt   getlen;
  29.     ngx_http_log_op_run_pt      run;
  30.     uintptr_t                   data;
  31. };


  34. ‌typedef struct {
  35.     ngx_str_t                   name;
  36.     ngx_array_t                *flushes;
  37.     ngx_array_t                *ops;        /* array of ngx_http_log_op_t */
  38. ‌} ngx_http_log_fmt_t;


  41. ‌typedef struct {
  42.     ngx_array_t                 formats;    /* array of ngx_http_log_fmt_t */
  43.     ngx_uint_t                  combined_used; /* unsigned  combined_used:1 */
  44. ‌} ngx_http_log_main_conf_t;


  47. ‌typedef struct {
  48.     u_char                     *start;
  49.     u_char                     *pos;
  50.     u_char                     *last;

  52.     ngx_event_t                *event;
  53.     ngx_msec_t                  flush;
  54.     ngx_int_t                   gzip;
  55. ‌} ngx_http_log_buf_t;


  58. ‌typedef struct {
  59.     ngx_array_t                *lengths;
  60.     ngx_array_t                *values;
  61. ‌} ngx_http_log_script_t;


  64. ‌typedef struct {
  65.     ngx_open_file_t            *file;
  66.     ngx_http_log_script_t      *script;
  67.     time_t                      disk_full_time;
  68.     time_t                      error_log_time;
  69.     ngx_syslog_peer_t          *syslog_peer;
  70.     ngx_http_log_fmt_t         *format;
  71.     ngx_http_complex_value_t   *filter;
  72. ‌} ngx_http_log_t;


  75. ‌typedef struct {
  76.     ngx_array_t                *logs;       /* array of ngx_http_log_t */

  78.     ngx_open_file_cache_t      *open_file_cache;
  79.     time_t                      open_file_cache_valid;
  80.     ngx_uint_t                  open_file_cache_min_uses;

  82.     ngx_uint_t                  off;        /* unsigned  off:1 */
  83. ‌} ngx_http_log_loc_conf_t;


  86. ‌typedef struct {
  87.     ngx_str_t                   name;
  88.     size_t                      len;
  89.     ngx_http_log_op_run_pt      run;
  90. ‌} ngx_http_log_var_t;


  93. ‌#define NGX_HTTP_LOG_ESCAPE_DEFAULT  0
  94. ‌#define NGX_HTTP_LOG_ESCAPE_JSON     1
  95. ‌#define NGX_HTTP_LOG_ESCAPE_NONE     2


  98. static void ngx_http_log_write(ngx_http_request_t *r, ngx_http_log_t *log,
  99.     u_char *buf, size_t len);
  100. static ssize_t ngx_http_log_script_write(ngx_http_request_t *r,
  101.     ngx_http_log_script_t *script, u_char **name, u_char *buf, size_t len);

  103. #if (NGX_ZLIB)
  104. static ssize_t ngx_http_log_gzip(ngx_fd_t fd, u_char *buf, size_t len,
  105.     ngx_int_t level, ngx_log_t *log);

  107. static void *ngx_http_log_gzip_alloc(void *opaque, u_int items, u_int size);
  108. static void ngx_http_log_gzip_free(void *opaque, void *address);
  109. #endif

  111. static void ngx_http_log_flush(ngx_open_file_t *file, ngx_log_t *log);
  112. static void ngx_http_log_flush_handler(ngx_event_t *ev);

  114. static u_char *ngx_http_log_pipe(ngx_http_request_t *r, u_char *buf,
  115.     u_char *end, ngx_http_log_op_t *op);
  116. static u_char *ngx_http_log_time(ngx_http_request_t *r, u_char *buf,
  117.     u_char *end, ngx_http_log_op_t *op);
  118. static u_char *ngx_http_log_iso8601(ngx_http_request_t *r, u_char *buf,
  119.     u_char *end, ngx_http_log_op_t *op);
  120. static u_char *ngx_http_log_msec(ngx_http_request_t *r, u_char *buf,
  121.     u_char *end, ngx_http_log_op_t *op);
  122. static u_char *ngx_http_log_request_time(ngx_http_request_t *r, u_char *buf,
  123.     u_char *end, ngx_http_log_op_t *op);
  124. static u_char *ngx_http_log_status(ngx_http_request_t *r, u_char *buf,
  125.     u_char *end, ngx_http_log_op_t *op);
  126. static u_char *ngx_http_log_bytes_sent(ngx_http_request_t *r, u_char *buf,
  127.     u_char *end, ngx_http_log_op_t *op);
  128. static u_char *ngx_http_log_body_bytes_sent(ngx_http_request_t *r, u_char *buf,
  129.     u_char *end, ngx_http_log_op_t *op);
  130. static u_char *ngx_http_log_request_length(ngx_http_request_t *r, u_char *buf,
  131.     u_char *end, ngx_http_log_op_t *op);

  133. static ngx_int_t ngx_http_log_variable_compile(ngx_conf_t *cf,
  134.     ngx_http_log_op_t *op, ngx_str_t *value, ngx_uint_t escape);
  135. static size_t ngx_http_log_variable_getlen(ngx_http_request_t *r,
  136.     uintptr_t data);
  137. static u_char *ngx_http_log_variable(ngx_http_request_t *r, u_char *buf,
  138.     u_char *end, ngx_http_log_op_t *op);
  139. static uintptr_t ngx_http_log_escape(u_char *dst, u_char *src, size_t size);
  140. static size_t ngx_http_log_json_variable_getlen(ngx_http_request_t *r,
  141.     uintptr_t data);
  142. static u_char *ngx_http_log_json_variable(ngx_http_request_t *r, u_char *buf,
  143.     u_char *end, ngx_http_log_op_t *op);
  144. static size_t ngx_http_log_unescaped_variable_getlen(ngx_http_request_t *r,
  145.     uintptr_t data);
  146. static u_char *ngx_http_log_unescaped_variable(ngx_http_request_t *r,
  147.     u_char *buf, u_char *end, ngx_http_log_op_t *op);

  149. static ngx_int_t ngx_http_log_check_length(ngx_http_request_t *r,
  150.     u_char *buf, u_char *end, size_t len);


  153. static void *ngx_http_log_create_main_conf(ngx_conf_t *cf);
  154. static void *ngx_http_log_create_loc_conf(ngx_conf_t *cf);
  155. static char *ngx_http_log_merge_loc_conf(ngx_conf_t *cf, void *parent,
  156.     void *child);
  157. static char *ngx_http_log_set_log(ngx_conf_t *cf, ngx_command_t *cmd,
  158.     void *conf);
  159. static char *ngx_http_log_set_format(ngx_conf_t *cf, ngx_command_t *cmd,
  160.     void *conf);
  161. static char *ngx_http_log_compile_format(ngx_conf_t *cf,
  162.     ngx_array_t *flushes, ngx_array_t *ops, ngx_array_t *args, ngx_uint_t s);
  163. static char *ngx_http_log_open_file_cache(ngx_conf_t *cf, ngx_command_t *cmd,
  164.     void *conf);
  165. static ngx_int_t ngx_http_log_init(ngx_conf_t *cf);


  168. ‌static ngx_command_t  ngx_http_log_commands[] = {

  170.     { ngx_string("log_format"),
  171.       NGX_HTTP_MAIN_CONF|NGX_CONF_2MORE,
  172.       ngx_http_log_set_format,
  173.       NGX_HTTP_MAIN_CONF_OFFSET,
  174.       0,
  175.       NULL },

  177.     { ngx_string("access_log"),
  178.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF
  179.                         |NGX_HTTP_LMT_CONF|NGX_CONF_1MORE,
  180.       ngx_http_log_set_log,
  181.       NGX_HTTP_LOC_CONF_OFFSET,
  182.       0,
  183.       NULL },

  185.     { ngx_string("open_log_file_cache"),
  186.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1234,
  187.       ngx_http_log_open_file_cache,
  188.       NGX_HTTP_LOC_CONF_OFFSET,
  189.       0,
  190.       NULL },

  192.       ngx_null_command
  193. };


  196. ‌static ngx_http_module_t  ngx_http_log_module_ctx = {
  197.     NULL,                                  /* preconfiguration */
  198.     ngx_http_log_init,                     /* postconfiguration */

  200.     ngx_http_log_create_main_conf,         /* create main configuration */
  201.     NULL,                                  /* init main configuration */

  203.     NULL,                                  /* create server configuration */
  204.     NULL,                                  /* merge server configuration */

  206.     ngx_http_log_create_loc_conf,          /* create location configuration */
  207.     ngx_http_log_merge_loc_conf            /* merge location configuration */
  208. };


  211. ‌ngx_module_t  ngx_http_log_module = {
  212.     NGX_MODULE_V1,
  213.     &ngx_http_log_module_ctx,              /* module context */
  214.     ngx_http_log_commands,                 /* module directives */
  215.     NGX_HTTP_MODULE,                       /* module type */
  216.     NULL,                                  /* init master */
  217.     NULL,                                  /* init module */
  218.     NULL,                                  /* init process */
  219.     NULL,                                  /* init thread */
  220.     NULL,                                  /* exit thread */
  221.     NULL,                                  /* exit process */
  222.     NULL,                                  /* exit master */
  223.     NGX_MODULE_V1_PADDING
  224. };


  227. static ngx_str_t  ngx_http_access_log = ngx_string(NGX_HTTP_LOG_PATH);


  230. ‌static ngx_str_t  ngx_http_combined_fmt =
  231.     ngx_string("$remote_addr - $remote_user [$time_local] "
  232.                "\"$request\" $status $body_bytes_sent "
  233.                "\"$http_referer\" \"$http_user_agent\"");


  236. ‌static ngx_http_log_var_t  ngx_http_log_vars[] = {
  237.     { ngx_string("pipe"), 1, ngx_http_log_pipe },
  238.     { ngx_string("time_local"), sizeof("28/Sep/1970:12:00:00 +0600") - 1,
  239.                           ngx_http_log_time },
  240.     { ngx_string("time_iso8601"), sizeof("1970-09-28T12:00:00+06:00") - 1,
  241.                           ngx_http_log_iso8601 },
  242.     { ngx_string("msec"), NGX_TIME_T_LEN + 4, ngx_http_log_msec },
  243.     { ngx_string("request_time"), NGX_TIME_T_LEN + 4,
  244.                           ngx_http_log_request_time },
  245.     { ngx_string("status"), NGX_INT_T_LEN, ngx_http_log_status },
  246.     { ngx_string("bytes_sent"), NGX_OFF_T_LEN, ngx_http_log_bytes_sent },
  247.     { ngx_string("body_bytes_sent"), NGX_OFF_T_LEN,
  248.                           ngx_http_log_body_bytes_sent },
  249.     { ngx_string("request_length"), NGX_OFF_T_LEN,
  250.                           ngx_http_log_request_length },

  252.     { ngx_null_string, 0, NULL }
  253. };


  256. static ngx_int_t
  257. ‌ngx_http_log_handler(ngx_http_request_t *r)
  258. {
  259.     u_char                   *line, *p, *end;
  260.     size_t                    len, size;
  261.     ssize_t                   n;
  262.     ngx_str_t                 val;
  263.     ngx_uint_t                i, l;
  264.     ngx_http_log_t           *log;
  265.     ngx_http_log_op_t        *op;
  266.     ngx_http_log_buf_t       *buffer;
  267.     ngx_http_log_loc_conf_t  *lcf;

  269.     ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  270.                    "http log handler");

  272.     lcf = ngx_http_get_module_loc_conf(r, ngx_http_log_module);

  274.     if (lcf->off) {
  275.         return NGX_OK;
  276.     }

  278.     log = lcf->logs->elts;
  279.     for (l = 0; l < lcf->logs->nelts; l++) {

  281.         if (log[l].filter) {
  282.             if (ngx_http_complex_value(r, log[l].filter, &val) != NGX_OK) {
  283.                 return NGX_ERROR;
  284.             }

  286.             if (val.len == 0 || (val.len == 1 && val.data[0] == '0')) {
  287.                 continue;
  288.             }
  289.         }

  291.         if (ngx_time() == log[l].disk_full_time) {

  293.             /*
  294.              * on FreeBSD writing to a full filesystem with enabled softupdates
  295.              * may block process for much longer time than writing to non-full
  296.              * filesystem, so we skip writing to a log for one second
  297.              */

  299.             continue;
  300.         }

  302.         ngx_http_script_flush_no_cacheable_variables(r, log[l].format->flushes);

  304.         len = 0;
  305.         op = log[l].format->ops->elts;
  306.         for (i = 0; i < log[l].format->ops->nelts; i++) {
  307.             if (op[i].len == 0) {
  308.                 len += op[i].getlen(r, op[i].data);

  310.             } else {
  311.                 len += op[i].len;
  312.             }
  313.         }

  315.         len += NGX_LINEFEED_SIZE;

  317.         if (log[l].syslog_peer) {

  319.             /* length of syslog's PRI and HEADER message parts */
  320.             len += sizeof("<255>Jan 01 00:00:00 ") - 1
  321.                    + ngx_cycle->hostname.len + 1
  322.                    + log[l].syslog_peer->tag.len + 2;

  324.             goto alloc_line;
  325.         }

  327.         buffer = log[l].file ? log[l].file->data : NULL;

  329.         if (buffer) {

  331.             if (len > (size_t) (buffer->last - buffer->pos)) {

  333.                 ngx_http_log_write(r, &log[l], buffer->start,
  334.                                    buffer->pos - buffer->start);

  336.                 buffer->pos = buffer->start;
  337.             }

  339.             if (len <= (size_t) (buffer->last - buffer->pos)) {

  341.                 p = buffer->pos;
  342.                 end = p + len - NGX_LINEFEED_SIZE;

  344.                 if (buffer->event && p == buffer->start) {
  345.                     ngx_add_timer(buffer->event, buffer->flush);
  346.                 }

  348.                 for (i = 0; i < log[l].format->ops->nelts && p; i++) {
  349.                     p = op[i].run(r, p, end, &op[i]);
  350.                 }

  352.                 if (p == NULL) {
  353.                     return NGX_ERROR;
  354.                 }

  356.                 ngx_linefeed(p);

  358.                 buffer->pos = p;

  360.                 continue;
  361.             }

  363.             if (buffer->event && buffer->event->timer_set) {
  364.                 ngx_del_timer(buffer->event);
  365.             }
  366.         }

  368.     alloc_line:

  370.         line = ngx_pnalloc(r->pool, len);
  371.         if (line == NULL) {
  372.             return NGX_ERROR;
  373.         }

  375.         p = line;
  376.         end = line + len - NGX_LINEFEED_SIZE;

  378.         if (log[l].syslog_peer) {
  379.             p = ngx_syslog_add_header(log[l].syslog_peer, line);
  380.         }

  382.         for (i = 0; i < log[l].format->ops->nelts && p; i++) {
  383.             p = op[i].run(r, p, end, &op[i]);
  384.         }

  386.         if (p == NULL) {
  387.             return NGX_ERROR;
  388.         }

  390.         if (log[l].syslog_peer) {

  392.             size = p - line;

  394.             n = ngx_syslog_send(log[l].syslog_peer, line, size);

  396.             if (n < 0) {
  397.                 ngx_log_error(NGX_LOG_WARN, r->connection->log, 0,
  398.                               "send() to syslog failed");

  400.             } else if ((size_t) n != size) {
  401.                 ngx_log_error(NGX_LOG_WARN, r->connection->log, 0,
  402.                               "send() to syslog has written only %z of %uz",
  403.                               n, size);
  404.             }

  406.             continue;
  407.         }

  409.         ngx_linefeed(p);

  411.         ngx_http_log_write(r, &log[l], line, p - line);
  412.     }

  414.     return NGX_OK;
  415. }


  418. static void
  419. ‌ngx_http_log_write(ngx_http_request_t *r, ngx_http_log_t *log, u_char *buf,
  420.     size_t len)
  421. {
  422.     u_char              *name;
  423.     time_t               now;
  424.     ssize_t              n;
  425.     ngx_err_t            err;
  426. #if (NGX_ZLIB)
  427.     ngx_http_log_buf_t  *buffer;
  428. #endif

  430.     if (log->script == NULL) {
  431.         name = log->file->name.data;

  433. #if (NGX_ZLIB)
  434.         buffer = log->file->data;

  436.         if (buffer && buffer->gzip) {
  437.             n = ngx_http_log_gzip(log->file->fd, buf, len, buffer->gzip,
  438.                                   r->connection->log);
  439.         } else {
  440.             n = ngx_write_fd(log->file->fd, buf, len);
  441.         }
  442. #else
  443.         n = ngx_write_fd(log->file->fd, buf, len);
  444. #endif

  446.     } else {
  447.         name = NULL;
  448.         n = ngx_http_log_script_write(r, log->script, &name, buf, len);
  449.     }

  451.     if (n == (ssize_t) len) {
  452.         return;
  453.     }

  455.     now = ngx_time();

  457.     if (n == -1) {
  458.         err = ngx_errno;

  460.         if (err == NGX_ENOSPC) {
  461.             log->disk_full_time = now;
  462.         }

  464.         if (now - log->error_log_time > 59) {
  465.             ngx_log_error(NGX_LOG_ALERT, r->connection->log, err,
  466.                           ngx_write_fd_n " to \"%s\" failed", name);

  468.             log->error_log_time = now;
  469.         }

  471.         return;
  472.     }

  474.     if (now - log->error_log_time > 59) {
  475.         ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
  476.                       ngx_write_fd_n " to \"%s\" was incomplete: %z of %uz",
  477.                       name, n, len);

  479.         log->error_log_time = now;
  480.     }
  481. }


  484. static ssize_t
  485. ‌ngx_http_log_script_write(ngx_http_request_t *r, ngx_http_log_script_t *script,
  486.     u_char **name, u_char *buf, size_t len)
  487. {
  488.     size_t                     root;
  489.     ssize_t                    n;
  490.     ngx_str_t                  log, path;
  491.     ngx_open_file_info_t       of;
  492.     ngx_http_log_loc_conf_t   *llcf;
  493.     ngx_http_core_loc_conf_t  *clcf;

  495.     clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);

  497.     if (!r->root_tested) {

  499.         /* test root directory existence */

  501.         if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
  502.             /* simulate successful logging */
  503.             return len;
  504.         }

  506.         path.data[root] = '\0';

  508.         ngx_memzero(&of, sizeof(ngx_open_file_info_t));

  510.         of.valid = clcf->open_file_cache_valid;
  511.         of.min_uses = clcf->open_file_cache_min_uses;
  512.         of.test_dir = 1;
  513.         of.test_only = 1;
  514.         of.errors = clcf->open_file_cache_errors;
  515.         of.events = clcf->open_file_cache_events;

  517.         if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {
  518.             /* simulate successful logging */
  519.             return len;
  520.         }

  522.         if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
  523.             != NGX_OK)
  524.         {
  525.             if (of.err == 0) {
  526.                 /* simulate successful logging */
  527.                 return len;
  528.             }

  530.             ngx_log_error(NGX_LOG_ERR, r->connection->log, of.err,
  531.                           "testing \"%s\" existence failed", path.data);

  533.             /* simulate successful logging */
  534.             return len;
  535.         }

  537.         if (!of.is_dir) {
  538.             ngx_log_error(NGX_LOG_ERR, r->connection->log, NGX_ENOTDIR,
  539.                           "testing \"%s\" existence failed", path.data);

  541.             /* simulate successful logging */
  542.             return len;
  543.         }
  544.     }

  546.     if (ngx_http_script_run(r, &log, script->lengths->elts, 1,
  547.                             script->values->elts)
  548.         == NULL)
  549.     {
  550.         /* simulate successful logging */
  551.         return len;
  552.     }

  554.     log.data[log.len - 1] = '\0';
  555.     *name = log.data;

  557.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  558.                    "http log \"%s\"", log.data);

  560.     llcf = ngx_http_get_module_loc_conf(r, ngx_http_log_module);

  562.     ngx_memzero(&of, sizeof(ngx_open_file_info_t));

  564.     of.log = 1;
  565.     of.valid = llcf->open_file_cache_valid;
  566.     of.min_uses = llcf->open_file_cache_min_uses;
  567.     of.directio = NGX_OPEN_FILE_DIRECTIO_OFF;

  569.     if (ngx_http_set_disable_symlinks(r, clcf, &log, &of) != NGX_OK) {
  570.         /* simulate successful logging */
  571.         return len;
  572.     }

  574.     if (ngx_open_cached_file(llcf->open_file_cache, &log, &of, r->pool)
  575.         != NGX_OK)
  576.     {
  577.         if (of.err == 0) {
  578.             /* simulate successful logging */
  579.             return len;
  580.         }

  582.         ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
  583.                       "%s \"%s\" failed", of.failed, log.data);
  584.         /* simulate successful logging */
  585.         return len;
  586.     }

  588.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  589.                    "http log #%d", of.fd);

  591.     n = ngx_write_fd(of.fd, buf, len);

  593.     return n;
  594. }


  597. #if (NGX_ZLIB)

  599. static ssize_t
  600. ‌ngx_http_log_gzip(ngx_fd_t fd, u_char *buf, size_t len, ngx_int_t level,
  601.     ngx_log_t *log)
  602. {
  603.     int          rc, wbits, memlevel;
  604.     u_char      *out;
  605.     size_t       size;
  606.     ssize_t      n;
  607.     z_stream     zstream;
  608.     ngx_err_t    err;
  609.     ngx_pool_t  *pool;

  611.     wbits = MAX_WBITS;
  612.     memlevel = MAX_MEM_LEVEL - 1;

  614.     while ((ssize_t) len < ((1 << (wbits - 1)) - 262)) {
  615.         wbits--;
  616.         memlevel--;
  617.     }

  619.     /*
  620.      * This is a formula from deflateBound() for conservative upper bound of
  621.      * compressed data plus 18 bytes of gzip wrapper.
  622.      */

  624.     size = len + ((len + 7) >> 3) + ((len + 63) >> 6) + 5 + 18;

  626.     ngx_memzero(&zstream, sizeof(z_stream));

  628.     pool = ngx_create_pool(256, log);
  629.     if (pool == NULL) {
  630.         /* simulate successful logging */
  631.         return len;
  632.     }

  634.     pool->log = log;

  636.     zstream.zalloc = ngx_http_log_gzip_alloc;
  637.     zstream.zfree = ngx_http_log_gzip_free;
  638.     zstream.opaque = pool;

  640.     out = ngx_pnalloc(pool, size);
  641.     if (out == NULL) {
  642.         goto done;
  643.     }

  645.     zstream.next_in = buf;
  646.     zstream.avail_in = len;
  647.     zstream.next_out = out;
  648.     zstream.avail_out = size;

  650.     rc = deflateInit2(&zstream, (int) level, Z_DEFLATED, wbits + 16, memlevel,
  651.                       Z_DEFAULT_STRATEGY);

  653.     if (rc != Z_OK) {
  654.         ngx_log_error(NGX_LOG_ALERT, log, 0, "deflateInit2() failed: %d", rc);
  655.         goto done;
  656.     }

  658.     ngx_log_debug4(NGX_LOG_DEBUG_HTTP, log, 0,
  659.                    "deflate in: ni:%p no:%p ai:%ud ao:%ud",
  660.                    zstream.next_in, zstream.next_out,
  661.                    zstream.avail_in, zstream.avail_out);

  663.     rc = deflate(&zstream, Z_FINISH);

  665.     if (rc != Z_STREAM_END) {
  666.         ngx_log_error(NGX_LOG_ALERT, log, 0,
  667.                       "deflate(Z_FINISH) failed: %d", rc);
  668.         goto done;
  669.     }

  671.     ngx_log_debug5(NGX_LOG_DEBUG_HTTP, log, 0,
  672.                    "deflate out: ni:%p no:%p ai:%ud ao:%ud rc:%d",
  673.                    zstream.next_in, zstream.next_out,
  674.                    zstream.avail_in, zstream.avail_out,
  675.                    rc);

  677.     size -= zstream.avail_out;

  679.     rc = deflateEnd(&zstream);

  681.     if (rc != Z_OK) {
  682.         ngx_log_error(NGX_LOG_ALERT, log, 0, "deflateEnd() failed: %d", rc);
  683.         goto done;
  684.     }

  686.     n = ngx_write_fd(fd, out, size);

  688.     if (n != (ssize_t) size) {
  689.         err = (n == -1) ? ngx_errno : 0;

  691.         ngx_destroy_pool(pool);

  693.         ngx_set_errno(err);
  694.         return -1;
  695.     }

  697. done:

  699.     ngx_destroy_pool(pool);

  701.     /* simulate successful logging */
  702.     return len;
  703. }


  706. static void *
  707. ‌ngx_http_log_gzip_alloc(void *opaque, u_int items, u_int size)
  708. {
  709.     ngx_pool_t *pool = opaque;

  711.     ngx_log_debug2(NGX_LOG_DEBUG_HTTP, pool->log, 0,
  712.                    "gzip alloc: n:%ud s:%ud", items, size);

  714.     return ngx_palloc(pool, items * size);
  715. }


  718. static void
  719. ‌ngx_http_log_gzip_free(void *opaque, void *address)
  720. {
  721. #if 0
  722.     ngx_pool_t *pool = opaque;

  724.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pool->log, 0, "gzip free: %p", address);
  725. #endif
  726. }

  728. #endif


  731. static void
  732. ‌ngx_http_log_flush(ngx_open_file_t *file, ngx_log_t *log)
  733. {
  734.     size_t               len;
  735.     ssize_t              n;
  736.     ngx_http_log_buf_t  *buffer;

  738.     buffer = file->data;

  740.     len = buffer->pos - buffer->start;

  742.     if (len == 0) {
  743.         return;
  744.     }

  746. #if (NGX_ZLIB)
  747.     if (buffer->gzip) {
  748.         n = ngx_http_log_gzip(file->fd, buffer->start, len, buffer->gzip, log);
  749.     } else {
  750.         n = ngx_write_fd(file->fd, buffer->start, len);
  751.     }
  752. #else
  753.     n = ngx_write_fd(file->fd, buffer->start, len);
  754. #endif

  756.     if (n == -1) {
  757.         ngx_log_error(NGX_LOG_ALERT, log, ngx_errno,
  758.                       ngx_write_fd_n " to \"%s\" failed",
  759.                       file->name.data);

  761.     } else if ((size_t) n != len) {
  762.         ngx_log_error(NGX_LOG_ALERT, log, 0,
  763.                       ngx_write_fd_n " to \"%s\" was incomplete: %z of %uz",
  764.                       file->name.data, n, len);
  765.     }

  767.     buffer->pos = buffer->start;

  769.     if (buffer->event && buffer->event->timer_set) {
  770.         ngx_del_timer(buffer->event);
  771.     }
  772. }


  775. static void
  776. ‌ngx_http_log_flush_handler(ngx_event_t *ev)
  777. {
  778.     ngx_log_debug0(NGX_LOG_DEBUG_EVENT, ev->log, 0,
  779.                    "http log buffer flush handler");

  781.     ngx_http_log_flush(ev->data, ev->log);
  782. }


  785. static u_char *
  786. ‌ngx_http_log_copy_short(ngx_http_request_t *r, u_char *buf, u_char *end,
  787.     ngx_http_log_op_t *op)
  788. {
  789.     size_t     len;
  790.     uintptr_t  data;

  792.     len = op->len;
  793.     data = op->data;

  795.     if (ngx_http_log_check_length(r, buf, end, len) != NGX_OK) {
  796.         return NULL;
  797.     }

  799.     while (len--) {
  800.         *buf++ = (u_char) (data & 0xff);
  801.         data >>= 8;
  802.     }

  804.     return buf;
  805. }


  808. static u_char *
  809. ‌ngx_http_log_copy_long(ngx_http_request_t *r, u_char *buf, u_char *end,
  810.     ngx_http_log_op_t *op)
  811. {
  812.     if (ngx_http_log_check_length(r, buf, end, op->len) != NGX_OK) {
  813.         return NULL;
  814.     }

  816.     return ngx_cpymem(buf, (u_char *) op->data, op->len);
  817. }


  820. static u_char *
  821. ‌ngx_http_log_pipe(ngx_http_request_t *r, u_char *buf, u_char *end,
  822.     ngx_http_log_op_t *op)
  823. {
  824.     if (ngx_http_log_check_length(r, buf, end, 1) != NGX_OK) {
  825.         return NULL;
  826.     }

  828.     if (r->pipeline) {
  829.         *buf = 'p';
  830.     } else {
  831.         *buf = '.';
  832.     }

  834.     return buf + 1;
  835. }


  838. static u_char *
  839. ‌ngx_http_log_time(ngx_http_request_t *r, u_char *buf, u_char *end,
  840.     ngx_http_log_op_t *op)
  841. {
  842.     if (ngx_http_log_check_length(r, buf, end, ngx_cached_http_log_time.len)
  843.         != NGX_OK)
  844.     {
  845.         return NULL;
  846.     }

  848.     return ngx_cpymem(buf, ngx_cached_http_log_time.data,
  849.                       ngx_cached_http_log_time.len);
  850. }

  852. static u_char *
  853. ‌ngx_http_log_iso8601(ngx_http_request_t *r, u_char *buf, u_char *end,
  854.     ngx_http_log_op_t *op)
  855. {
  856.     if (ngx_http_log_check_length(r, buf, end, ngx_cached_http_log_iso8601.len)
  857.         != NGX_OK)
  858.     {
  859.         return NULL;
  860.     }

  862.     return ngx_cpymem(buf, ngx_cached_http_log_iso8601.data,
  863.                       ngx_cached_http_log_iso8601.len);
  864. }

  866. static u_char *
  867. ‌ngx_http_log_msec(ngx_http_request_t *r, u_char *buf, u_char *end,
  868.     ngx_http_log_op_t *op)
  869. {
  870.     ngx_time_t  *tp;

  872.     if (ngx_http_log_check_length(r, buf, end, NGX_TIME_T_LEN + 4) != NGX_OK) {
  873.         return NULL;
  874.     }

  876.     tp = ngx_timeofday();

  878.     return ngx_sprintf(buf, "%T.%03M", tp->sec, tp->msec);
  879. }


  882. static u_char *
  883. ‌ngx_http_log_request_time(ngx_http_request_t *r, u_char *buf, u_char *end,
  884.     ngx_http_log_op_t *op)
  885. {
  886.     ngx_time_t      *tp;
  887.     ngx_msec_int_t   ms;

  889.     if (ngx_http_log_check_length(r, buf, end, NGX_TIME_T_LEN + 4) != NGX_OK) {
  890.         return NULL;
  891.     }

  893.     tp = ngx_timeofday();

  895.     ms = (ngx_msec_int_t)
  896.              ((tp->sec - r->start_sec) * 1000 + (tp->msec - r->start_msec));
  897.     ms = ngx_max(ms, 0);

  899.     return ngx_sprintf(buf, "%T.%03M", (time_t) ms / 1000, ms % 1000);
  900. }


  903. static u_char *
  904. ‌ngx_http_log_status(ngx_http_request_t *r, u_char *buf, u_char *end,
  905.     ngx_http_log_op_t *op)
  906. {
  907.     ngx_uint_t  status;

  909.     if (ngx_http_log_check_length(r, buf, end, NGX_INT_T_LEN) != NGX_OK) {
  910.         return NULL;
  911.     }

  913.     if (r->err_status) {
  914.         status = r->err_status;

  916.     } else if (r->headers_out.status) {
  917.         status = r->headers_out.status;

  919.     } else if (r->http_version == NGX_HTTP_VERSION_9) {
  920.         status = 9;

  922.     } else {
  923.         status = 0;
  924.     }

  926.     return ngx_sprintf(buf, "%03ui", status);
  927. }


  930. static u_char *
  931. ‌ngx_http_log_bytes_sent(ngx_http_request_t *r, u_char *buf, u_char *end,
  932.     ngx_http_log_op_t *op)
  933. {
  934.     if (ngx_http_log_check_length(r, buf, end, NGX_OFF_T_LEN) != NGX_OK) {
  935.         return NULL;
  936.     }

  938.     return ngx_sprintf(buf, "%O", r->connection->sent);
  939. }


  942. /*
  943. * although there is a real $body_bytes_sent variable,
  944. * this log operation code function is more optimized for logging
  945. */

  947. static u_char *
  948. ‌ngx_http_log_body_bytes_sent(ngx_http_request_t *r, u_char *buf, u_char *end,
  949.     ngx_http_log_op_t *op)
  950. {
  951.     off_t  length;

  953.     if (ngx_http_log_check_length(r, buf, end, NGX_OFF_T_LEN) != NGX_OK) {
  954.         return NULL;
  955.     }

  957.     length = r->connection->sent - r->header_size;

  959.     if (length > 0) {
  960.         return ngx_sprintf(buf, "%O", length);
  961.     }

  963.     *buf = '0';

  965.     return buf + 1;
  966. }


  969. static u_char *
  970. ‌ngx_http_log_request_length(ngx_http_request_t *r, u_char *buf, u_char *end,
  971.     ngx_http_log_op_t *op)
  972. {
  973.     if (ngx_http_log_check_length(r, buf, end, NGX_OFF_T_LEN) != NGX_OK) {
  974.         return NULL;
  975.     }

  977.     return ngx_sprintf(buf, "%O", r->request_length);
  978. }


  981. static ngx_int_t
  982. ‌ngx_http_log_variable_compile(ngx_conf_t *cf, ngx_http_log_op_t *op,
  983.     ngx_str_t *value, ngx_uint_t escape)
  984. {
  985.     ngx_int_t  index;

  987.     index = ngx_http_get_variable_index(cf, value);
  988.     if (index == NGX_ERROR) {
  989.         return NGX_ERROR;
  990.     }

  992.     op->len = 0;

  994.     switch (escape) {
  995.     case NGX_HTTP_LOG_ESCAPE_JSON:
  996.         op->getlen = ngx_http_log_json_variable_getlen;
  997.         op->run = ngx_http_log_json_variable;
  998.         break;

  1000.     case NGX_HTTP_LOG_ESCAPE_NONE:
  1001.         op->getlen = ngx_http_log_unescaped_variable_getlen;
  1002.         op->run = ngx_http_log_unescaped_variable;
  1003.         break;

  1005.     default: /* NGX_HTTP_LOG_ESCAPE_DEFAULT */
  1006.         op->getlen = ngx_http_log_variable_getlen;
  1007.         op->run = ngx_http_log_variable;
  1008.     }

  1010.     op->data = index;

  1012.     return NGX_OK;
  1013. }


  1016. static size_t
  1017. ‌ngx_http_log_variable_getlen(ngx_http_request_t *r, uintptr_t data)
  1018. {
  1019.     uintptr_t                   len;
  1020.     ngx_http_variable_value_t  *value;

  1022.     value = ngx_http_get_indexed_variable(r, data);

  1024.     if (value == NULL || value->not_found) {
  1025.         return 1;
  1026.     }

  1028.     len = ngx_http_log_escape(NULL, value->data, value->len);

  1030.     value->escape = len ? 1 : 0;

  1032.     return value->len + len * 3;
  1033. }


  1036. static u_char *
  1037. ‌ngx_http_log_variable(ngx_http_request_t *r, u_char *buf, u_char *end,
  1038.     ngx_http_log_op_t *op)
  1039. {
  1040.     uintptr_t                   len;
  1041.     ngx_http_variable_value_t  *value;

  1043.     value = ngx_http_get_indexed_variable(r, op->data);

  1045.     if (value == NULL || value->not_found) {
  1046.         if (ngx_http_log_check_length(r, buf, end, 1) != NGX_OK) {
  1047.             return NULL;
  1048.         }

  1050.         *buf = '-';
  1051.         return buf + 1;
  1052.     }

  1054.     if (value->escape == 0) {
  1055.         if (ngx_http_log_check_length(r, buf, end, value->len) != NGX_OK) {
  1056.             return NULL;
  1057.         }

  1059.         return ngx_cpymem(buf, value->data, value->len);

  1061.     } else {
  1062.         len = ngx_http_log_escape(NULL, value->data, value->len);

  1064.         if (ngx_http_log_check_length(r, buf, end, value->len + len * 3)
  1065.             != NGX_OK)
  1066.         {
  1067.             return NULL;
  1068.         }

  1070.         return (u_char *) ngx_http_log_escape(buf, value->data, value->len);
  1071.     }
  1072. }


  1075. static uintptr_t
  1076. ‌ngx_http_log_escape(u_char *dst, u_char *src, size_t size)
  1077. {
  1078.     ngx_uint_t      n;
  1079.     static u_char   hex[] = "0123456789ABCDEF";

  1081.     static uint32_t   escape[] = {
  1082.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */

  1084.                     /* ?>=< ;:98 7654 3210  /.-, +*)( '&%$ #"!  */
  1085.         0x00000004, /* 0000 0000 0000 0000  0000 0000 0000 0100 */

  1087.                     /* _^]\ [ZYX WVUT SRQP  ONML KJIH GFED CBA@ */
  1088.         0x10000000, /* 0001 0000 0000 0000  0000 0000 0000 0000 */

  1090.                     /*  ~}| {zyx wvut srqp  onml kjih gfed cba` */
  1091.         0x80000000, /* 1000 0000 0000 0000  0000 0000 0000 0000 */

  1093.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  1094.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  1095.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  1096.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  1097.     };


  1100.     if (dst == NULL) {

  1102.         /* find the number of the characters to be escaped */

  1104.         n = 0;

  1106.         while (size) {
  1107.             if (escape[*src >> 5] & (1U << (*src & 0x1f))) {
  1108.                 n++;
  1109.             }
  1110.             src++;
  1111.             size--;
  1112.         }

  1114.         return (uintptr_t) n;
  1115.     }

  1117.     while (size) {
  1118.         if (escape[*src >> 5] & (1U << (*src & 0x1f))) {
  1119.             *dst++ = '\\';
  1120.             *dst++ = 'x';
  1121.             *dst++ = hex[*src >> 4];
  1122.             *dst++ = hex[*src & 0xf];
  1123.             src++;

  1125.         } else {
  1126.             *dst++ = *src++;
  1127.         }
  1128.         size--;
  1129.     }

  1131.     return (uintptr_t) dst;
  1132. }


  1135. static size_t
  1136. ‌ngx_http_log_json_variable_getlen(ngx_http_request_t *r, uintptr_t data)
  1137. {
  1138.     uintptr_t                   len;
  1139.     ngx_http_variable_value_t  *value;

  1141.     value = ngx_http_get_indexed_variable(r, data);

  1143.     if (value == NULL || value->not_found) {
  1144.         return 0;
  1145.     }

  1147.     len = ngx_escape_json(NULL, value->data, value->len);

  1149.     value->escape = len ? 1 : 0;

  1151.     return value->len + len;
  1152. }


  1155. static u_char *
  1156. ‌ngx_http_log_json_variable(ngx_http_request_t *r, u_char *buf, u_char *end,
  1157.     ngx_http_log_op_t *op)
  1158. {
  1159.     uintptr_t                   len;
  1160.     ngx_http_variable_value_t  *value;

  1162.     value = ngx_http_get_indexed_variable(r, op->data);

  1164.     if (value == NULL || value->not_found) {
  1165.         return buf;
  1166.     }

  1168.     if (value->escape == 0) {
  1169.         if (ngx_http_log_check_length(r, buf, end, value->len) != NGX_OK) {
  1170.             return NULL;
  1171.         }

  1173.         return ngx_cpymem(buf, value->data, value->len);

  1175.     } else {
  1176.         len = ngx_escape_json(NULL, value->data, value->len);

  1178.         if (ngx_http_log_check_length(r, buf, end, value->len + len)
  1179.             != NGX_OK)
  1180.         {
  1181.             return NULL;
  1182.         }

  1184.         return (u_char *) ngx_escape_json(buf, value->data, value->len);
  1185.     }
  1186. }


  1189. static size_t
  1190. ‌ngx_http_log_unescaped_variable_getlen(ngx_http_request_t *r, uintptr_t data)
  1191. {
  1192.     ngx_http_variable_value_t  *value;

  1194.     value = ngx_http_get_indexed_variable(r, data);

  1196.     if (value == NULL || value->not_found) {
  1197.         return 0;
  1198.     }

  1200.     value->escape = 0;

  1202.     return value->len;
  1203. }


  1206. static u_char *
  1207. ‌ngx_http_log_unescaped_variable(ngx_http_request_t *r, u_char *buf,
  1208.     u_char *end, ngx_http_log_op_t *op)
  1209. {
  1210.     ngx_http_variable_value_t  *value;

  1212.     value = ngx_http_get_indexed_variable(r, op->data);

  1214.     if (value == NULL || value->not_found) {
  1215.         return buf;
  1216.     }

  1218.     if (ngx_http_log_check_length(r, buf, end, value->len) != NGX_OK) {
  1219.         return NULL;
  1220.     }

  1222.     return ngx_cpymem(buf, value->data, value->len);
  1223. }


  1226. static ngx_int_t
  1227. ‌ngx_http_log_check_length(ngx_http_request_t *r, u_char *buf, u_char *end,
  1228.     size_t len)
  1229. {
  1230.     if (end - buf < (ssize_t) len) {
  1231.         ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
  1232.                       "no buffer space in log script copy");
  1233.         return NGX_ERROR;
  1234.     }

  1236.     return NGX_OK;
  1237. }


  1240. static void *
  1241. ‌ngx_http_log_create_main_conf(ngx_conf_t *cf)
  1242. {
  1243.     ngx_http_log_main_conf_t  *conf;

  1245.     ngx_http_log_fmt_t  *fmt;

  1247.     conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_main_conf_t));
  1248.     if (conf == NULL) {
  1249.         return NULL;
  1250.     }

  1252.     if (ngx_array_init(&conf->formats, cf->pool, 4, sizeof(ngx_http_log_fmt_t))
  1253.         != NGX_OK)
  1254.     {
  1255.         return NULL;
  1256.     }

  1258.     fmt = ngx_array_push(&conf->formats);
  1259.     if (fmt == NULL) {
  1260.         return NULL;
  1261.     }

  1263.     ngx_str_set(&fmt->name, "combined");

  1265.     fmt->flushes = NULL;

  1267.     fmt->ops = ngx_array_create(cf->pool, 16, sizeof(ngx_http_log_op_t));
  1268.     if (fmt->ops == NULL) {
  1269.         return NULL;
  1270.     }

  1272.     return conf;
  1273. }


  1276. static void *
  1277. ‌ngx_http_log_create_loc_conf(ngx_conf_t *cf)
  1278. {
  1279.     ngx_http_log_loc_conf_t  *conf;

  1281.     conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_loc_conf_t));
  1282.     if (conf == NULL) {
  1283.         return NULL;
  1284.     }

  1286.     conf->open_file_cache = NGX_CONF_UNSET_PTR;

  1288.     return conf;
  1289. }


  1292. static char *
  1293. ‌ngx_http_log_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
  1294. {
  1295.     ngx_http_log_loc_conf_t *prev = parent;
  1296.     ngx_http_log_loc_conf_t *conf = child;

  1298.     ngx_http_log_t            *log;
  1299.     ngx_http_log_fmt_t        *fmt;
  1300.     ngx_http_log_main_conf_t  *lmcf;

  1302.     if (conf->open_file_cache == NGX_CONF_UNSET_PTR) {

  1304.         conf->open_file_cache = prev->open_file_cache;
  1305.         conf->open_file_cache_valid = prev->open_file_cache_valid;
  1306.         conf->open_file_cache_min_uses = prev->open_file_cache_min_uses;

  1308.         if (conf->open_file_cache == NGX_CONF_UNSET_PTR) {
  1309.             conf->open_file_cache = NULL;
  1310.         }
  1311.     }

  1313.     if (conf->logs || conf->off) {
  1314.         return NGX_CONF_OK;
  1315.     }

  1317.     conf->logs = prev->logs;
  1318.     conf->off = prev->off;

  1320.     if (conf->logs || conf->off) {
  1321.         return NGX_CONF_OK;
  1322.     }

  1324.     conf->logs = ngx_array_create(cf->pool, 2, sizeof(ngx_http_log_t));
  1325.     if (conf->logs == NULL) {
  1326.         return NGX_CONF_ERROR;
  1327.     }

  1329.     log = ngx_array_push(conf->logs);
  1330.     if (log == NULL) {
  1331.         return NGX_CONF_ERROR;
  1332.     }

  1334.     ngx_memzero(log, sizeof(ngx_http_log_t));

  1336.     log->file = ngx_conf_open_file(cf->cycle, &ngx_http_access_log);
  1337.     if (log->file == NULL) {
  1338.         return NGX_CONF_ERROR;
  1339.     }

  1341.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);
  1342.     fmt = lmcf->formats.elts;

  1344.     /* the default "combined" format */
  1345.     log->format = &fmt[0];
  1346.     lmcf->combined_used = 1;

  1348.     return NGX_CONF_OK;
  1349. }


  1352. static char *
  1353. ‌ngx_http_log_set_log(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1354. {
  1355.     ngx_http_log_loc_conf_t *llcf = conf;

  1357.     ssize_t                            size;
  1358.     ngx_int_t                          gzip;
  1359.     ngx_uint_t                         i, n;
  1360.     ngx_msec_t                         flush;
  1361.     ngx_str_t                         *value, name, s;
  1362.     ngx_http_log_t                    *log;
  1363.     ngx_syslog_peer_t                 *peer;
  1364.     ngx_http_log_buf_t                *buffer;
  1365.     ngx_http_log_fmt_t                *fmt;
  1366.     ngx_http_log_main_conf_t          *lmcf;
  1367.     ngx_http_script_compile_t          sc;
  1368.     ngx_http_compile_complex_value_t   ccv;

  1370.     value = cf->args->elts;

  1372.     if (ngx_strcmp(value[1].data, "off") == 0) {
  1373.         llcf->off = 1;
  1374.         if (cf->args->nelts == 2) {
  1375.             return NGX_CONF_OK;
  1376.         }

  1378.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1379.                            "invalid parameter \"%V\"", &value[2]);
  1380.         return NGX_CONF_ERROR;
  1381.     }

  1383.     if (llcf->logs == NULL) {
  1384.         llcf->logs = ngx_array_create(cf->pool, 2, sizeof(ngx_http_log_t));
  1385.         if (llcf->logs == NULL) {
  1386.             return NGX_CONF_ERROR;
  1387.         }
  1388.     }

  1390.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);

  1392.     log = ngx_array_push(llcf->logs);
  1393.     if (log == NULL) {
  1394.         return NGX_CONF_ERROR;
  1395.     }

  1397.     ngx_memzero(log, sizeof(ngx_http_log_t));


  1400.     if (ngx_strncmp(value[1].data, "syslog:", 7) == 0) {

  1402.         peer = ngx_pcalloc(cf->pool, sizeof(ngx_syslog_peer_t));
  1403.         if (peer == NULL) {
  1404.             return NGX_CONF_ERROR;
  1405.         }

  1407.         if (ngx_syslog_process_conf(cf, peer) != NGX_CONF_OK) {
  1408.             return NGX_CONF_ERROR;
  1409.         }

  1411.         log->syslog_peer = peer;

  1413.         goto process_formats;
  1414.     }

  1416.     n = ngx_http_script_variables_count(&value[1]);

  1418.     if (n == 0) {
  1419.         log->file = ngx_conf_open_file(cf->cycle, &value[1]);
  1420.         if (log->file == NULL) {
  1421.             return NGX_CONF_ERROR;
  1422.         }

  1424.     } else {
  1425.         if (ngx_conf_full_name(cf->cycle, &value[1], 0) != NGX_OK) {
  1426.             return NGX_CONF_ERROR;
  1427.         }

  1429.         log->script = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_script_t));
  1430.         if (log->script == NULL) {
  1431.             return NGX_CONF_ERROR;
  1432.         }

  1434.         ngx_memzero(&sc, sizeof(ngx_http_script_compile_t));

  1436.         sc.cf = cf;
  1437.         sc.source = &value[1];
  1438.         sc.lengths = &log->script->lengths;
  1439.         sc.values = &log->script->values;
  1440.         sc.variables = n;
  1441.         sc.complete_lengths = 1;
  1442.         sc.complete_values = 1;

  1444.         if (ngx_http_script_compile(&sc) != NGX_OK) {
  1445.             return NGX_CONF_ERROR;
  1446.         }
  1447.     }

  1449. process_formats:

  1451.     if (cf->args->nelts >= 3) {
  1452.         name = value[2];

  1454.         if (ngx_strcmp(name.data, "combined") == 0) {
  1455.             lmcf->combined_used = 1;
  1456.         }

  1458.     } else {
  1459.         ngx_str_set(&name, "combined");
  1460.         lmcf->combined_used = 1;
  1461.     }

  1463.     fmt = lmcf->formats.elts;
  1464.     for (i = 0; i < lmcf->formats.nelts; i++) {
  1465.         if (fmt[i].name.len == name.len
  1466.             && ngx_strcasecmp(fmt[i].name.data, name.data) == 0)
  1467.         {
  1468.             log->format = &fmt[i];
  1469.             break;
  1470.         }
  1471.     }

  1473.     if (log->format == NULL) {
  1474.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1475.                            "unknown log format \"%V\"", &name);
  1476.         return NGX_CONF_ERROR;
  1477.     }

  1479.     size = 0;
  1480.     flush = 0;
  1481.     gzip = 0;

  1483.     for (i = 3; i < cf->args->nelts; i++) {

  1485.         if (ngx_strncmp(value[i].data, "buffer=", 7) == 0) {
  1486.             s.len = value[i].len - 7;
  1487.             s.data = value[i].data + 7;

  1489.             size = ngx_parse_size(&s);

  1491.             if (size == NGX_ERROR || size == 0) {
  1492.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1493.                                    "invalid buffer size \"%V\"", &s);
  1494.                 return NGX_CONF_ERROR;
  1495.             }

  1497.             continue;
  1498.         }

  1500.         if (ngx_strncmp(value[i].data, "flush=", 6) == 0) {
  1501.             s.len = value[i].len - 6;
  1502.             s.data = value[i].data + 6;

  1504.             flush = ngx_parse_time(&s, 0);

  1506.             if (flush == (ngx_msec_t) NGX_ERROR || flush == 0) {
  1507.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1508.                                    "invalid flush time \"%V\"", &s);
  1509.                 return NGX_CONF_ERROR;
  1510.             }

  1512.             continue;
  1513.         }

  1515.         if (ngx_strncmp(value[i].data, "gzip", 4) == 0
  1516.             && (value[i].len == 4 || value[i].data[4] == '='))
  1517.         {
  1518. #if (NGX_ZLIB)
  1519.             if (size == 0) {
  1520.                 size = 64 * 1024;
  1521.             }

  1523.             if (value[i].len == 4) {
  1524.                 gzip = Z_BEST_SPEED;
  1525.                 continue;
  1526.             }

  1528.             s.len = value[i].len - 5;
  1529.             s.data = value[i].data + 5;

  1531.             gzip = ngx_atoi(s.data, s.len);

  1533.             if (gzip < 1 || gzip > 9) {
  1534.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1535.                                    "invalid compression level \"%V\"", &s);
  1536.                 return NGX_CONF_ERROR;
  1537.             }

  1539.             continue;

  1541. #else
  1542.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1543.                                "nginx was built without zlib support");
  1544.             return NGX_CONF_ERROR;
  1545. #endif
  1546.         }

  1548.         if (ngx_strncmp(value[i].data, "if=", 3) == 0) {
  1549.             s.len = value[i].len - 3;
  1550.             s.data = value[i].data + 3;

  1552.             ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));

  1554.             ccv.cf = cf;
  1555.             ccv.value = &s;
  1556.             ccv.complex_value = ngx_palloc(cf->pool,
  1557.                                            sizeof(ngx_http_complex_value_t));
  1558.             if (ccv.complex_value == NULL) {
  1559.                 return NGX_CONF_ERROR;
  1560.             }

  1562.             if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
  1563.                 return NGX_CONF_ERROR;
  1564.             }

  1566.             log->filter = ccv.complex_value;

  1568.             continue;
  1569.         }

  1571.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1572.                            "invalid parameter \"%V\"", &value[i]);
  1573.         return NGX_CONF_ERROR;
  1574.     }

  1576.     if (flush && size == 0) {
  1577.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1578.                            "no buffer is defined for access_log \"%V\"",
  1579.                            &value[1]);
  1580.         return NGX_CONF_ERROR;
  1581.     }

  1583.     if (size) {

  1585.         if (log->script) {
  1586.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1587.                                "buffered logs cannot have variables in name");
  1588.             return NGX_CONF_ERROR;
  1589.         }

  1591.         if (log->syslog_peer) {
  1592.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1593.                                "logs to syslog cannot be buffered");
  1594.             return NGX_CONF_ERROR;
  1595.         }

  1597.         if (log->file->data) {
  1598.             buffer = log->file->data;

  1600.             if (buffer->last - buffer->start != size
  1601.                 || buffer->flush != flush
  1602.                 || buffer->gzip != gzip)
  1603.             {
  1604.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1605.                                    "access_log \"%V\" already defined "
  1606.                                    "with conflicting parameters",
  1607.                                    &value[1]);
  1608.                 return NGX_CONF_ERROR;
  1609.             }

  1611.             return NGX_CONF_OK;
  1612.         }

  1614.         buffer = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_buf_t));
  1615.         if (buffer == NULL) {
  1616.             return NGX_CONF_ERROR;
  1617.         }

  1619.         buffer->start = ngx_pnalloc(cf->pool, size);
  1620.         if (buffer->start == NULL) {
  1621.             return NGX_CONF_ERROR;
  1622.         }

  1624.         buffer->pos = buffer->start;
  1625.         buffer->last = buffer->start + size;

  1627.         if (flush) {
  1628.             buffer->event = ngx_pcalloc(cf->pool, sizeof(ngx_event_t));
  1629.             if (buffer->event == NULL) {
  1630.                 return NGX_CONF_ERROR;
  1631.             }

  1633.             buffer->event->data = log->file;
  1634.             buffer->event->handler = ngx_http_log_flush_handler;
  1635.             buffer->event->log = &cf->cycle->new_log;
  1636.             buffer->event->cancelable = 1;

  1638.             buffer->flush = flush;
  1639.         }

  1641.         buffer->gzip = gzip;

  1643.         log->file->flush = ngx_http_log_flush;
  1644.         log->file->data = buffer;
  1645.     }

  1647.     return NGX_CONF_OK;
  1648. }


  1651. static char *
  1652. ‌ngx_http_log_set_format(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1653. {
  1654.     ngx_http_log_main_conf_t *lmcf = conf;

  1656.     ngx_str_t           *value;
  1657.     ngx_uint_t           i;
  1658.     ngx_http_log_fmt_t  *fmt;

  1660.     value = cf->args->elts;

  1662.     fmt = lmcf->formats.elts;
  1663.     for (i = 0; i < lmcf->formats.nelts; i++) {
  1664.         if (fmt[i].name.len == value[1].len
  1665.             && ngx_strcmp(fmt[i].name.data, value[1].data) == 0)
  1666.         {
  1667.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1668.                                "duplicate \"log_format\" name \"%V\"",
  1669.                                &value[1]);
  1670.             return NGX_CONF_ERROR;
  1671.         }
  1672.     }

  1674.     fmt = ngx_array_push(&lmcf->formats);
  1675.     if (fmt == NULL) {
  1676.         return NGX_CONF_ERROR;
  1677.     }

  1679.     fmt->name = value[1];

  1681.     fmt->flushes = ngx_array_create(cf->pool, 4, sizeof(ngx_int_t));
  1682.     if (fmt->flushes == NULL) {
  1683.         return NGX_CONF_ERROR;
  1684.     }

  1686.     fmt->ops = ngx_array_create(cf->pool, 16, sizeof(ngx_http_log_op_t));
  1687.     if (fmt->ops == NULL) {
  1688.         return NGX_CONF_ERROR;
  1689.     }

  1691.     return ngx_http_log_compile_format(cf, fmt->flushes, fmt->ops, cf->args, 2);
  1692. }


  1695. static char *
  1696. ‌ngx_http_log_compile_format(ngx_conf_t *cf, ngx_array_t *flushes,
  1697.     ngx_array_t *ops, ngx_array_t *args, ngx_uint_t s)
  1698. {
  1699.     u_char              *data, *p, ch;
  1700.     size_t               i, len;
  1701.     ngx_str_t           *value, var;
  1702.     ngx_int_t           *flush;
  1703.     ngx_uint_t           bracket, escape;
  1704.     ngx_http_log_op_t   *op;
  1705.     ngx_http_log_var_t  *v;

  1707.     escape = NGX_HTTP_LOG_ESCAPE_DEFAULT;
  1708.     value = args->elts;

  1710.     if (s < args->nelts && ngx_strncmp(value[s].data, "escape=", 7) == 0) {
  1711.         data = value[s].data + 7;

  1713.         if (ngx_strcmp(data, "json") == 0) {
  1714.             escape = NGX_HTTP_LOG_ESCAPE_JSON;

  1716.         } else if (ngx_strcmp(data, "none") == 0) {
  1717.             escape = NGX_HTTP_LOG_ESCAPE_NONE;

  1719.         } else if (ngx_strcmp(data, "default") != 0) {
  1720.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1721.                                "unknown log format escaping \"%s\"", data);
  1722.             return NGX_CONF_ERROR;
  1723.         }

  1725.         s++;
  1726.     }

  1728.     for ( /* void */ ; s < args->nelts; s++) {

  1730.         i = 0;

  1732.         while (i < value[s].len) {

  1734.             op = ngx_array_push(ops);
  1735.             if (op == NULL) {
  1736.                 return NGX_CONF_ERROR;
  1737.             }

  1739.             data = &value[s].data[i];

  1741.             if (value[s].data[i] == '$') {

  1743.                 if (++i == value[s].len) {
  1744.                     goto invalid;
  1745.                 }

  1747.                 if (value[s].data[i] == '{') {
  1748.                     bracket = 1;

  1750.                     if (++i == value[s].len) {
  1751.                         goto invalid;
  1752.                     }

  1754.                     var.data = &value[s].data[i];

  1756.                 } else {
  1757.                     bracket = 0;
  1758.                     var.data = &value[s].data[i];
  1759.                 }

  1761.                 for (var.len = 0; i < value[s].len; i++, var.len++) {
  1762.                     ch = value[s].data[i];

  1764.                     if (ch == '}' && bracket) {
  1765.                         i++;
  1766.                         bracket = 0;
  1767.                         break;
  1768.                     }

  1770.                     if ((ch >= 'A' && ch <= 'Z')
  1771.                         || (ch >= 'a' && ch <= 'z')
  1772.                         || (ch >= '0' && ch <= '9')
  1773.                         || ch == '_')
  1774.                     {
  1775.                         continue;
  1776.                     }

  1778.                     break;
  1779.                 }

  1781.                 if (bracket) {
  1782.                     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1783.                                        "the closing bracket in \"%V\" "
  1784.                                        "variable is missing", &var);
  1785.                     return NGX_CONF_ERROR;
  1786.                 }

  1788.                 if (var.len == 0) {
  1789.                     goto invalid;
  1790.                 }

  1792.                 for (v = ngx_http_log_vars; v->name.len; v++) {

  1794.                     if (v->name.len == var.len
  1795.                         && ngx_strncmp(v->name.data, var.data, var.len) == 0)
  1796.                     {
  1797.                         op->len = v->len;
  1798.                         op->getlen = NULL;
  1799.                         op->run = v->run;
  1800.                         op->data = 0;

  1802.                         goto found;
  1803.                     }
  1804.                 }

  1806.                 if (ngx_http_log_variable_compile(cf, op, &var, escape)
  1807.                     != NGX_OK)
  1808.                 {
  1809.                     return NGX_CONF_ERROR;
  1810.                 }

  1812.                 if (flushes) {

  1814.                     flush = ngx_array_push(flushes);
  1815.                     if (flush == NULL) {
  1816.                         return NGX_CONF_ERROR;
  1817.                     }

  1819.                     *flush = op->data; /* variable index */
  1820.                 }

  1822.             found:

  1824.                 continue;
  1825.             }

  1827.             i++;

  1829.             while (i < value[s].len && value[s].data[i] != '$') {
  1830.                 i++;
  1831.             }

  1833.             len = &value[s].data[i] - data;

  1835.             if (len) {

  1837.                 op->len = len;
  1838.                 op->getlen = NULL;

  1840.                 if (len <= sizeof(uintptr_t)) {
  1841.                     op->run = ngx_http_log_copy_short;
  1842.                     op->data = 0;

  1844.                     while (len--) {
  1845.                         op->data <<= 8;
  1846.                         op->data |= data[len];
  1847.                     }

  1849.                 } else {
  1850.                     op->run = ngx_http_log_copy_long;

  1852.                     p = ngx_pnalloc(cf->pool, len);
  1853.                     if (p == NULL) {
  1854.                         return NGX_CONF_ERROR;
  1855.                     }

  1857.                     ngx_memcpy(p, data, len);
  1858.                     op->data = (uintptr_t) p;
  1859.                 }
  1860.             }
  1861.         }
  1862.     }

  1864.     return NGX_CONF_OK;

  1866. invalid:

  1868.     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "invalid parameter \"%s\"", data);

  1870.     return NGX_CONF_ERROR;
  1871. }


  1874. static char *
  1875. ‌ngx_http_log_open_file_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1876. {
  1877.     ngx_http_log_loc_conf_t *llcf = conf;

  1879.     time_t       inactive, valid;
  1880.     ngx_str_t   *value, s;
  1881.     ngx_int_t    max, min_uses;
  1882.     ngx_uint_t   i;

  1884.     if (llcf->open_file_cache != NGX_CONF_UNSET_PTR) {
  1885.         return "is duplicate";
  1886.     }

  1888.     value = cf->args->elts;

  1890.     max = 0;
  1891.     inactive = 10;
  1892.     valid = 60;
  1893.     min_uses = 1;

  1895.     for (i = 1; i < cf->args->nelts; i++) {

  1897.         if (ngx_strncmp(value[i].data, "max=", 4) == 0) {

  1899.             max = ngx_atoi(value[i].data + 4, value[i].len - 4);
  1900.             if (max == NGX_ERROR) {
  1901.                 goto failed;
  1902.             }

  1904.             continue;
  1905.         }

  1907.         if (ngx_strncmp(value[i].data, "inactive=", 9) == 0) {

  1909.             s.len = value[i].len - 9;
  1910.             s.data = value[i].data + 9;

  1912.             inactive = ngx_parse_time(&s, 1);
  1913.             if (inactive == (time_t) NGX_ERROR) {
  1914.                 goto failed;
  1915.             }

  1917.             continue;
  1918.         }

  1920.         if (ngx_strncmp(value[i].data, "min_uses=", 9) == 0) {

  1922.             min_uses = ngx_atoi(value[i].data + 9, value[i].len - 9);
  1923.             if (min_uses == NGX_ERROR) {
  1924.                 goto failed;
  1925.             }

  1927.             continue;
  1928.         }

  1930.         if (ngx_strncmp(value[i].data, "valid=", 6) == 0) {

  1932.             s.len = value[i].len - 6;
  1933.             s.data = value[i].data + 6;

  1935.             valid = ngx_parse_time(&s, 1);
  1936.             if (valid == (time_t) NGX_ERROR) {
  1937.                 goto failed;
  1938.             }

  1940.             continue;
  1941.         }

  1943.         if (ngx_strcmp(value[i].data, "off") == 0) {

  1945.             llcf->open_file_cache = NULL;

  1947.             continue;
  1948.         }

  1950.     failed:

  1952.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1953.                            "invalid \"open_log_file_cache\" parameter \"%V\"",
  1954.                            &value[i]);
  1955.         return NGX_CONF_ERROR;
  1956.     }

  1958.     if (llcf->open_file_cache == NULL) {
  1959.         return NGX_CONF_OK;
  1960.     }

  1962.     if (max == 0) {
  1963.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1964.                         "\"open_log_file_cache\" must have \"max\" parameter");
  1965.         return NGX_CONF_ERROR;
  1966.     }

  1968.     llcf->open_file_cache = ngx_open_file_cache_init(cf->pool, max, inactive);

  1970.     if (llcf->open_file_cache) {

  1972.         llcf->open_file_cache_valid = valid;
  1973.         llcf->open_file_cache_min_uses = min_uses;

  1975.         return NGX_CONF_OK;
  1976.     }

  1978.     return NGX_CONF_ERROR;
  1979. }


  1982. static ngx_int_t
  1983. ‌ngx_http_log_init(ngx_conf_t *cf)
  1984. {
  1985.     ngx_str_t                  *value;
  1986.     ngx_array_t                 a;
  1987.     ngx_http_handler_pt        *h;
  1988.     ngx_http_log_fmt_t         *fmt;
  1989.     ngx_http_log_main_conf_t   *lmcf;
  1990.     ngx_http_core_main_conf_t  *cmcf;

  1992.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);

  1994.     if (lmcf->combined_used) {
  1995.         if (ngx_array_init(&a, cf->pool, 1, sizeof(ngx_str_t)) != NGX_OK) {
  1996.             return NGX_ERROR;
  1997.         }

  1999.         value = ngx_array_push(&a);
  2000.         if (value == NULL) {
  2001.             return NGX_ERROR;
  2002.         }

  2004.         *value = ngx_http_combined_fmt;
  2005.         fmt = lmcf->formats.elts;

  2007.         if (ngx_http_log_compile_format(cf, NULL, fmt->ops, &a, 0)
  2008.             != NGX_CONF_OK)
  2009.         {
  2010.             return NGX_ERROR;
  2011.         }
  2012.     }

  2014.     cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

  2016.     h = ngx_array_push(&cmcf->phases[NGX_HTTP_LOG_PHASE].handlers);
  2017.     if (h == NULL) {
  2018.         return NGX_ERROR;
  2019.     }

  2021.     *h = ngx_http_log_handler;

  2023.     return NGX_OK;
  2024. }

One Level Up Top Level