jinql
/
ngx-fancyindex
mirror of https://github.com/aperezdc/ngx-fancyindex
1
0
Fork 0
Code Issues Releases Wiki Activity

Allow specifying timestamp format with fancyindex_time_format 

This patch adds a new configuration directive fancyindex_time_format, which
accepts a strftime()-style format string used to format the timestamps in the
generated listings. The accepted format specifiers are an useful subset of
those supported by strftime(), but the libc function is not used to make the
output of the module stable and locale-independent.

This fixes issue #23.
pull/28/head
Adrian Perez de Castro 2015-08-16 23:48:25 +03:00
parent fd0bbd7fb8
commit 5599bbebba
3 changed files with 173 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -6,6 +6,9 @@ All notable changes to this project will be documented in this file.
- New feature: Allow filtering out symbolic links using the
`fancyindex_hide_symlinks` configuration directive. (Idea and prototype
patch by Thomas Wemm.)
- New feature: Allow specifying the format of timestamps using the
`fancyindex_time_format` configuration directive. (Idea suggested by
Xiao Meng <novoreorx@gmail.com>).
### Changed
- Listings in top-level directories will not generate a "Parent Directory"
link as first element of the listing. (Patch by Thomas P.)

40
README.rst
View File

@ -196,6 +196,46 @@ fancyindex_localtime
:Description:
Enables showing file times as local time. Default is “off” (GMT time).
fancyindex_time_format
~~~~~~~~~~~~~~~~~~~~~~
:Syntax: *fancyindex_time_format* string
:Default: fancyindex_time_format "%Y-%b-%d %H:%M"
:Context: http, server, location
:Description:
Format string used for timestamps. The format specifiers are a subset of
those supported by the `strftime <http://linux.die.net/man/3/strftime>`_
function, and the behavior is locale-independent (for example, day and month
names are always in English). The supported formats are:
* ``%a``: Abbreviated name of the day of the week.
* ``%A``: Full name of the day of the week.
* ``%b``: Abbreviated month name.
* ``%B``: Full month name.
* ``%d``: Day of the month as a decimal number (range 01 to 31).
* ``%e``: Like ``%d``, the day of the month as a decimal number, but a
leading zero is replaced by a space.
* ``%F``: Equivalent to ``%Y-%m-%d`` (the ISO 8601 date format).
* ``%H``: Hour as a decimal number using a 24-hour clock (range 00
to 23).
* ``%I``: Hour as a decimal number using a 12-hour clock (range 01 to 12).
* ``%k``: Hour (24-hour clock) as a decimal number (range 0 to 23);
single digits are preceded by a blank.
* ``%l``: Hour (12-hour clock) as a decimal number (range 1 to 12); single
digits are preceded by a blank.
* ``%m``: Month as a decimal number (range 01 to 12).
* ``%M``: Minute as a decimal number (range 00 to 59).
* ``%p``: Either "AM" or "PM" according to the given time value.
* ``%P``: Like ``%p`` but in lowercase: "am" or "pm".
* ``%r``: Time in a.m. or p.m. notation. Equivalent to ``%I:%M:%S %p``.
* ``%R``: Time in 24-hour notation (``%H:%M``).
* ``%S``: Second as a decimal number (range 00 to 60).
* ``%T``: Time in 24-hour notation (``%H:%M:%S``).
* ``%u``: Day of the week as a decimal, range 1 to 7, Monday being 1.
* ``%w``: Day of the week as a decimal, range 0 to 6, Monday being 0.
* ``%y``: Year as a decimal number without a century (range 00 to 99).
* ``%Y``: Year as a decimal number including the century.
.. _nginx: http://nginx.net
.. vim:ft=rst:spell:spelllang=en:

150
ngx_http_fancyindex_module.c
View File

@ -33,6 +33,113 @@
#endif /* __GNUC__ */
static const char *short_weekday[] = {
"Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun",
};
static const char *long_weekday[] = {
"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Sunday",
};
static const char *short_month[] = {
"Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
};
static const char *long_month[] = {
"January", "February", "March", "April", "May", "June", "July",
"August", "September", "October", "November", "December",
};
#define DATETIME_FORMATS(F_, t) \
F_ ('a', 3, "%3s", short_weekday[((t)->ngx_tm_wday + 6) % 7]) \
F_ ('A', 9, "%s", long_weekday [((t)->ngx_tm_wday + 6) % 7]) \
F_ ('b', 3, "%3s", short_month[(t)->ngx_tm_mon - 1] ) \
F_ ('B', 9, "%s", long_month [(t)->ngx_tm_mon - 1] ) \
F_ ('d', 2, "%02d", (t)->ngx_tm_mday ) \
F_ ('e', 2, "%2d", (t)->ngx_tm_mday ) \
F_ ('F', 10, "%d-%02d-%02d", \
(t)->ngx_tm_year, \
(t)->ngx_tm_mon, \
(t)->ngx_tm_mday ) \
F_ ('H', 2, "%02d", (t)->ngx_tm_hour ) \
F_ ('I', 2, "%02d", ((t)->ngx_tm_hour % 12) + 1 ) \
F_ ('k', 2, "%2d", (t)->ngx_tm_hour ) \
F_ ('l', 2, "%2d", ((t)->ngx_tm_hour % 12) + 1 ) \
F_ ('m', 2, "%02d", (t)->ngx_tm_mon ) \
F_ ('M', 2, "%02d", (t)->ngx_tm_min ) \
F_ ('p', 2, "%2s", (((t)->ngx_tm_hour < 12) ? "AM" : "PM") ) \
F_ ('P', 2, "%2s", (((t)->ngx_tm_hour < 12) ? "am" : "pm") ) \
F_ ('r', 11, "%02d:%02d:%02d %2s", \
((t)->ngx_tm_hour % 12) + 1, \
(t)->ngx_tm_min, \
(t)->ngx_tm_sec, \
(((t)->ngx_tm_hour < 12) ? "AM" : "PM") ) \
F_ ('R', 5, "%02d:%02d", (t)->ngx_tm_hour, (t)->ngx_tm_min ) \
F_ ('S', 2, "%02d", (t)->ngx_tm_sec ) \
F_ ('T', 8, "%02d:%02d:%02d", \
(t)->ngx_tm_hour, \
(t)->ngx_tm_min, \
(t)->ngx_tm_sec ) \
F_ ('u', 1, "%1d", (((t)->ngx_tm_wday + 6) % 7) + 1 ) \
F_ ('w', 1, "%1d", ((t)->ngx_tm_wday + 6) % 7 ) \
F_ ('y', 2, "%02d", (t)->ngx_tm_year % 100 ) \
F_ ('Y', 4, "%04d", (t)->ngx_tm_year )
static size_t
ngx_fancyindex_timefmt_calc_size (const ngx_str_t *fmt)
{
#define DATETIME_CASE(letter, fmtlen, fmt, ...) \
case letter: result += (fmtlen); break;
size_t i, result = 0;
for (i = 0; i < fmt->len; i++) {
if (fmt->data[i] == '%') {
if (++i >= fmt->len) {
result++;
break;
}
switch (fmt->data[i]) {
DATETIME_FORMATS(DATETIME_CASE,)
default:
result++;
}
} else {
result++;
}
}
return result;
#undef DATETIME_CASE
}
static u_char*
ngx_fancyindex_timefmt (u_char *buffer, const ngx_str_t *fmt, const ngx_tm_t *tm)
{
#define DATETIME_CASE(letter, fmtlen, fmt, ...) \
case letter: buffer = ngx_snprintf(buffer, fmtlen, fmt, ##__VA_ARGS__); break;
size_t i;
for (i = 0; i < fmt->len; i++) {
if (fmt->data[i] == '%') {
if (++i >= fmt->len) {
*buffer++ = '%';
break;
}
switch (fmt->data[i]) {
DATETIME_FORMATS(DATETIME_CASE, tm)
default:
*buffer++ = fmt->data[i];
}
} else {
*buffer++ = fmt->data[i];
}
}
return buffer;
#undef DATETIME_CASE
}
/**
* Configuration structure for the fancyindex module. The configuration
@ -49,6 +156,7 @@ typedef struct {
ngx_str_t header; /**< File name for header, or empty if none. */
ngx_str_t footer; /**< File name for footer, or empty if none. */
ngx_str_t css_href; /**< Link to a CSS stylesheet, or empty if none. */
ngx_str_t time_format; /**< Format used for file timestamps. */
ngx_array_t *ignore; /**< List of files to ignore in listings. */
} ngx_http_fancyindex_loc_conf_t;
@ -231,6 +339,13 @@ static ngx_command_t ngx_http_fancyindex_commands[] = {
0,
NULL },
{ ngx_string("fancyindex_time_format"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
ngx_conf_set_str_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_fancyindex_loc_conf_t, time_format),
NULL },
ngx_null_command
};
@ -429,11 +544,6 @@ make_content_buf(
ngx_dir_t dir;
ngx_buf_t *b;
static char *months[] = {
"Jan", "Feb", "Mar", "Apr", "May", "Jun",
"Jul", "Aug", "Sep", "Oct", "Nov", "Dec",
};
/*
* NGX_DIR_MASK_LEN is lesser than NGX_HTTP_FANCYINDEX_PREALLOCATE
*/
@ -604,6 +714,7 @@ make_content_buf(
+ ngx_sizeof_ssz(t06_list1)
+ ngx_sizeof_ssz(t_parentdir_entry)
+ ngx_sizeof_ssz(t07_list2)
+ ngx_fancyindex_timefmt_calc_size (&alcf->time_format) * entries.nelts
;
/*
@ -632,9 +743,8 @@ make_content_buf(
+ alcf->name_length + ngx_sizeof_ssz("&gt;")
+ ngx_sizeof_ssz("</a></td><td>")
+ 20 /* File size */
+ ngx_sizeof_ssz("</td><td>")
+ ngx_sizeof_ssz(" 28-Sep-1970 12:00 ")
+ ngx_sizeof_ssz("</td></tr>\n")
+ ngx_sizeof_ssz("</td><td>") /* Date prefix */
+ ngx_sizeof_ssz("</td></tr>\n") /* Date suffix */
+ 2 /* CR LF */
;
}
@ -862,14 +972,9 @@ make_content_buf(
}
ngx_gmtime(entry[i].mtime + tp->gmtoff * 60 * alcf->localtime, &tm);
b->last = ngx_sprintf(b->last, "</td><td>%02d-%s-%d %02d:%02d</td></tr>",
tm.ngx_tm_mday,
months[tm.ngx_tm_mon - 1],
tm.ngx_tm_year,
tm.ngx_tm_hour,
tm.ngx_tm_min);
b->last = ngx_cpymem_ssz(b->last, "</td><td>");
b->last = ngx_fancyindex_timefmt(b->last, &alcf->time_format, &tm);
b->last = ngx_cpymem_ssz(b->last, "</td></tr>");
*b->last++ = CR;
*b->last++ = LF;
@ -1191,10 +1296,14 @@ ngx_http_fancyindex_create_loc_conf(ngx_conf_t *cf)
/*
* Set by ngx_pcalloc:
* conf->header.len = 0
* conf->header.data = NULL
* conf->footer.len = 0
* conf->footer.data = NULL
* conf->header.len = 0
* conf->header.data = NULL
* conf->footer.len = 0
* conf->footer.data = NULL
* conf->css_href.len = 0
* conf->css_href.data = NULL
* conf->time_format.len = 0
* conf->time_format.data = NULL
*/
conf->enable = NGX_CONF_UNSET;
conf->default_sort = NGX_CONF_UNSET_UINT;
@ -1222,6 +1331,7 @@ ngx_http_fancyindex_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
ngx_conf_merge_str_value(conf->header, prev->header, "");
ngx_conf_merge_str_value(conf->footer, prev->footer, "");
ngx_conf_merge_str_value(conf->time_format, prev->time_format, "%Y-%b-%d %H:%S");
ngx_conf_merge_ptr_value(conf->ignore, prev->ignore, NULL);
ngx_conf_merge_value(conf->hide_symlinks, prev->hide_symlinks, 0);