/* * mod_dirlist - directory listing * * Description: * mod_dirlist enables you to list files inside a directory. * The output can be customized in various ways from style via css to excluding certain entries. * * Setups: * none * Options: * none * Actions: * dirlist [options] - show directory listing * options: optional (not required), array, can contain any of the following string => value pairs: * "sort" => criterium - string, one of "name", "size" or "type" * "css" => url - string, external css to use for styling, default: use internal css * "hide-dotfiles" => bool - hide entries beginning with a dot, default: true * "hide-tildefiles" => bool - hide entries ending with a tilde (~), often used for backups, default: true * "include-header" => bool - include HEADER.txt above the directory listing, default: false * "hide-header" => bool - hide HEADER.txt from the directory listing, default: false * "include-readme" => bool - include README.txt below the directory listing, default: false * "hide-header" => bool - hide README.txt from the directory listing, default: false * "hide-directories" => bool - hide directories from the directory listing, default: false * "exclude-suffix" => suffixlist - list of strings, filter entries that end with one of the strings supplied * "exclude-prefix" => prefixlist - list of strings, filter entries that begin with one of the strings supplied * "debug" => bool - outout debug information to log, default: false * * Example config: * if req.path =^ "/files/" { * dirlist ("include-header" => true, "hide-header" => true, "hide->suffix" => (".bak")); * } * - shows a directory listing including the content of HEADER.txt above the list and hiding itself from it * also hides all files ending in ".bak" * * Tip: * xyz * * Todo: * - make output generating "async", give up control every N entries * - filters for entries (pattern, regex) * - include-* parameters * - javascript for sorting * - sort parameter * - parameter to chose if dirs should be seperated from other files (listed first) * * Author: * Copyright (c) 2009 Thomas Porzelt * License: * MIT, see COPYING file in the lighttpd 2 tree */ #include #include #include LI_API gboolean mod_dirlist_init(liModules *mods, liModule *mod); LI_API gboolean mod_dirlist_free(liModules *mods, liModule *mod); /* html snippet constants */ static const gchar html_header[] = "\n" "\n" "\n" " \n" " Index of %s\n"; static const gchar html_table_start[] = " \n" " \n" "

Index of %s

\n" "
\n" " \n" " \n" " \n"; static const gchar html_table_row[] = " " "" "" "\n"; static const gchar html_table_end[] = " \n" "
NameLast ModifiedSizeType
%s%s%s%s
\n" "
\n"; static const gchar html_footer[] = "
%s
\n" " \n" ""; static const gchar html_css[] = "\n"; struct dirlist_data { liPlugin *plugin; GString *css; gboolean hide_dotfiles; gboolean hide_tildefiles; gboolean hide_directories; gboolean debug; GPtrArray *exclude_suffix; GPtrArray *exclude_prefix; GString *content_type; }; typedef struct dirlist_data dirlist_data; struct dirlist_plugin_data { void *unused; }; typedef struct dirlist_plugin_data dirlist_plugin_data; static void dirlist_format_size(gchar *buf, goffset size) { const gchar unit[] = "BKMGTPE"; /* Kilo, Mega, Tera, Peta, Exa */ gchar *u = (gchar*)unit; guint remaining = 0; while (size > 1024) { remaining = size & 1023; /* % 1024 */ size >>= 10; /* /= 1024 */ u++; } remaining /= 100; if (remaining > 9) remaining = 9; if (size > 999) { size = 0; remaining = 9; u++; } if (size > 99) { *buf++ = size / 100 + '0'; size = size % 100; *buf++ = size / 10 + '0'; *buf++ = (size % 10) + '0'; } else if (size > 9) { *buf++ = size / 10 + '0'; *buf++ = (size % 10) + '0'; } else { *buf++ = size + '0'; } if (u != unit) { *buf++ = '.'; *buf++ = remaining + '0'; } *buf++ = *u; *buf = '\0'; } static liHandlerResult dirlist(liVRequest *vr, gpointer param, gpointer *context) { GString *listing; liStatCacheEntry *sce; dirlist_data *dd; UNUSED(context); if (li_vrequest_is_handled(vr)) return LI_HANDLER_GO_ON; if (vr->physical.path->len == 0) return LI_HANDLER_GO_ON; switch (li_stat_cache_get_dirlist(vr, vr->physical.path, &sce)) { case LI_HANDLER_GO_ON: break; case LI_HANDLER_WAIT_FOR_EVENT: return LI_HANDLER_WAIT_FOR_EVENT; default: return LI_HANDLER_ERROR; } dd = param; if (sce->data.failed) { /* stat failed */ li_stat_cache_entry_release(vr, sce); switch (sce->data.err) { case ENOENT: case ENOTDIR: return LI_HANDLER_GO_ON; case EACCES: if (!li_vrequest_handle_direct(vr)) return LI_HANDLER_ERROR; vr->response.http_status = 403; return LI_HANDLER_GO_ON; default: VR_ERROR(vr, "stat('%s') failed: %s", sce->data.path->str, g_strerror(sce->data.err)); return LI_HANDLER_ERROR; } } else if (!S_ISDIR(sce->data.st.st_mode)) { li_stat_cache_entry_release(vr, sce); return LI_HANDLER_GO_ON; } else if (vr->request.uri.path->str[vr->request.uri.path->len-1] != G_DIR_SEPARATOR) { GString *host, *uri; if (!li_vrequest_handle_direct(vr)) { li_stat_cache_entry_release(vr, sce); return LI_HANDLER_ERROR; } /* redirect to scheme + host + path + / + querystring if directory without trailing slash */ /* TODO: local addr if HTTP 1.0 without host header, url encoding */ host = vr->request.uri.authority->len ? vr->request.uri.authority : vr->con->srv_sock->local_addr_str; uri = g_string_sized_new( 8 /* https:// */ + host->len + vr->request.uri.orig_path->len + 2 /* /? */ + vr->request.uri.query->len ); if (vr->con->is_ssl) g_string_append_len(uri, CONST_STR_LEN("https://")); else g_string_append_len(uri, CONST_STR_LEN("http://")); g_string_append_len(uri, GSTR_LEN(host)); g_string_append_len(uri, GSTR_LEN(vr->request.uri.orig_path)); g_string_append_c(uri, '/'); if (vr->request.uri.query->len) { g_string_append_c(uri, '?'); g_string_append_len(uri, GSTR_LEN(vr->request.uri.query)); } vr->response.http_status = 301; li_http_header_overwrite(vr->response.headers, CONST_STR_LEN("Location"), GSTR_LEN(uri)); g_string_free(uri, TRUE); li_stat_cache_entry_release(vr, sce); return LI_HANDLER_GO_ON; } else { /* everything ok, we have the directory listing */ gboolean cachable; guint i, j; liStatCacheEntryData *sced; GString *mime_str, *encoded; GArray *directories, *files; gchar sizebuf[sizeof("999.9K")+1]; gchar datebuf[sizeof("2005-Jan-01 22:23:24")+1]; guint datebuflen; struct tm tm; gboolean hide; if (!li_vrequest_handle_direct(vr)) { li_stat_cache_entry_release(vr, sce); return LI_HANDLER_ERROR; } vr->response.http_status = 200; if (dd->debug) VR_DEBUG(vr, "dirlist for \"%s\", %u entries", sce->data.path->str, sce->dirlist->len); li_http_header_overwrite(vr->response.headers, CONST_STR_LEN("Content-Type"), GSTR_LEN(dd->content_type)); li_etag_set_header(vr, &sce->data.st, &cachable); if (cachable) { vr->response.http_status = 304; li_stat_cache_entry_release(vr, sce); return LI_HANDLER_GO_ON; } /* temporary string for encoded names */ encoded = g_string_sized_new(64-1); /* seperate directories from other files */ directories = g_array_sized_new(FALSE, FALSE, sizeof(guint), 16); files = g_array_sized_new(FALSE, FALSE, sizeof(guint), sce->dirlist->len); for (i = 0; i < sce->dirlist->len; i++) { sced = &g_array_index(sce->dirlist, liStatCacheEntryData, i); hide = FALSE; /* ingore entries where the stat() failed */ if (sced->failed) continue; if (dd->hide_dotfiles && sced->path->str[0] == '.') continue; if (dd->hide_tildefiles && sced->path->str[sced->path->len-1] == '~') continue; for (j = 0; j < dd->exclude_suffix->len; j++) { if (li_string_suffix(sced->path, GSTR_LEN((GString*)g_ptr_array_index(dd->exclude_suffix, j)))) { hide = TRUE; break; } } if (hide) continue; for (j = 0; j < dd->exclude_prefix->len; j++) { if (li_string_prefix(sced->path, GSTR_LEN((GString*)g_ptr_array_index(dd->exclude_prefix, j)))) { hide = TRUE; break; } } if (hide) continue; if (S_ISDIR(sced->st.st_mode)) g_array_append_val(directories, i); else g_array_append_val(files, i); } listing = g_string_sized_new(4*1024-1); g_string_append_printf(listing, html_header, vr->request.uri.path->str); if (dd->css) { /* custom css */ g_string_append_len(listing, CONST_STR_LEN(" css)); g_string_append_len(listing, CONST_STR_LEN("\" />\n")); } else { /* default css */ g_string_append_len(listing, CONST_STR_LEN(html_css)); } g_string_append_printf(listing, html_table_start, vr->request.uri.path->str); g_string_append_printf(listing, html_table_row, "../", "Parent Directory", (gint64)0, "", (gint64)0, "-", "Directory"); /* list directories */ if (!dd->hide_directories) { for (i = 0; i < directories->len; i++) { sced = &g_array_index(sce->dirlist, liStatCacheEntryData, g_array_index(directories, guint, i)); localtime_r(&(sced->st.st_mtime), &tm); datebuflen = strftime(datebuf, sizeof(datebuf), "%Y-%b-%d %H:%M:%S", &tm); datebuf[datebuflen] = '\0'; g_string_append_len(listing, CONST_STR_LEN(" path->str, encoded, ENCODING_URI); g_string_append_len(listing, GSTR_LEN(encoded)); g_string_append_len(listing, CONST_STR_LEN("/\">")); string_encode(sced->path->str, encoded, ENCODING_HTML); g_string_append_len(listing, GSTR_LEN(encoded)); g_string_append_len(listing, CONST_STR_LEN("st.st_mtime); g_string_append_len(listing, CONST_STR_LEN("\">")); g_string_append_len(listing, datebuf, datebuflen); g_string_append_len(listing, CONST_STR_LEN("" "-" "Directory\n")); } } /*g_string_append_len(listing, CONST_STR_LEN(" \n"));*/ /* list files */ for (i = 0; i < files->len; i++) { sced = &g_array_index(sce->dirlist, liStatCacheEntryData, g_array_index(files, guint, i)); mime_str = li_mimetype_get(vr, sced->path); localtime_r(&(sced->st.st_mtime), &tm); datebuflen = strftime(datebuf, sizeof(datebuf), "%Y-%b-%d %H:%M:%S", &tm); datebuf[datebuflen] = '\0'; dirlist_format_size(sizebuf, sced->st.st_size); g_string_append_len(listing, CONST_STR_LEN(" path->str, encoded, ENCODING_URI); g_string_append_len(listing, GSTR_LEN(encoded)); g_string_append_len(listing, CONST_STR_LEN("\">")); string_encode(sced->path->str, encoded, ENCODING_HTML); g_string_append_len(listing, GSTR_LEN(encoded)); g_string_append_len(listing, CONST_STR_LEN( "" "st.st_mtime); g_string_append_len(listing, CONST_STR_LEN("\">")); g_string_append_len(listing, datebuf, datebuflen); g_string_append_len(listing, CONST_STR_LEN("st.st_size); g_string_append_len(listing, CONST_STR_LEN("\">")); g_string_append(listing, sizebuf); g_string_append_len(listing, CONST_STR_LEN("")); if (mime_str) { g_string_append_len(listing, GSTR_LEN(mime_str)); } else { g_string_append_len(listing, CONST_STR_LEN("application/octet-stream")); } g_string_append_len(listing, CONST_STR_LEN("\n")); /* g_string_append_printf(listing, html_table_row, sced->path->str, sced->path->str, (gint64)sced->st.st_mtime, datebuf, sced->st.st_size, sizebuf, mime_str ? mime_str->str : "application/octet-stream"); */ } g_string_append_len(listing, CONST_STR_LEN(html_table_end)); g_string_append_printf(listing, html_footer, CORE_OPTION(LI_CORE_OPTION_SERVER_TAG).string->str); li_chunkqueue_append_string(vr->out, listing); g_string_free(encoded, TRUE); g_array_free(directories, TRUE); g_array_free(files, TRUE); } li_stat_cache_entry_release(vr, sce); return LI_HANDLER_GO_ON; } static void dirlist_free(liServer *srv, gpointer param) { guint i; dirlist_data *data = param; UNUSED(srv); if (data->css) g_string_free(data->css, TRUE); for (i = 0; i < data->exclude_suffix->len; i++) g_string_free(g_ptr_array_index(data->exclude_suffix, i), TRUE); g_ptr_array_free(data->exclude_suffix, TRUE); for (i = 0; i < data->exclude_prefix->len; i++) g_string_free(g_ptr_array_index(data->exclude_prefix, i), TRUE); g_ptr_array_free(data->exclude_prefix, TRUE); g_string_free(data->content_type, TRUE); g_slice_free(dirlist_data, data); } static liAction* dirlist_create(liServer *srv, liPlugin* p, liValue *val) { dirlist_data *data; guint i; guint j; liValue *v, *tmpval; GString *k; if (val && val->type != LI_VALUE_LIST) { ERROR(srv, "%s", "dirlist expects an optional list of string-value pairs"); return NULL; } data = g_slice_new0(dirlist_data); data->plugin = p; data->hide_dotfiles = TRUE; data->hide_tildefiles = TRUE; data->exclude_suffix = g_ptr_array_new(); data->exclude_prefix = g_ptr_array_new(); data->content_type = g_string_new("text/html; charset=utf-8"); if (val) { for (i = 0; i < val->data.list->len; i++) { tmpval = g_array_index(val->data.list, liValue*, i); if (tmpval->type != LI_VALUE_LIST || tmpval->data.list->len != 2 || g_array_index(tmpval->data.list, liValue*, 0)->type != LI_VALUE_STRING) { ERROR(srv, "%s", "dirlist expects an optional list of string-value pairs"); dirlist_free(srv, data); return NULL; } k = g_array_index(tmpval->data.list, liValue*, 0)->data.string; v = g_array_index(tmpval->data.list, liValue*, 1); if (g_str_equal(k->str, "css")) { if (v->type != LI_VALUE_STRING) { ERROR(srv, "%s", "dirlist: css parameter must be a string"); dirlist_free(srv, data); return NULL; } data->css = g_string_new_len(GSTR_LEN(v->data.string)); } else if (g_str_equal(k->str, "hide-dotfiles")) { if (v->type != LI_VALUE_BOOLEAN) { ERROR(srv, "%s", "dirlist: hide-dotfiles parameter must be a boolean (true or false)"); dirlist_free(srv, data); return NULL; } data->hide_dotfiles = v->data.boolean; } else if (g_str_equal(k->str, "hide-tildefiles")) { if (v->type != LI_VALUE_BOOLEAN) { ERROR(srv, "%s", "dirlist: hide-tildefiles parameter must be a boolean (true or false)"); dirlist_free(srv, data); return NULL; } data->hide_tildefiles = v->data.boolean; } else if (g_str_equal(k->str, "hide-directories")) { if (v->type != LI_VALUE_BOOLEAN) { ERROR(srv, "%s", "dirlist: hide-directories parameter must be a boolean (true or false)"); dirlist_free(srv, data); return NULL; } data->hide_directories = v->data.boolean; } else if (g_str_equal(k->str, "exclude-suffix")) { if (v->type != LI_VALUE_LIST) { ERROR(srv, "%s", "dirlist: exclude-suffix parameter must be a list of strings"); dirlist_free(srv, data); return NULL; } for (j = 0; j < v->data.list->len; j++) { if (v->type != LI_VALUE_LIST) { ERROR(srv, "%s", "dirlist: exclude-suffix parameter must be a list of strings"); dirlist_free(srv, data); return NULL; } else { g_ptr_array_add(data->exclude_suffix, g_string_new_len(GSTR_LEN(g_array_index(v->data.list, liValue*, j)->data.string))); } } } else if (g_str_equal(k->str, "exclude-prefix")) { if (v->type != LI_VALUE_LIST) { ERROR(srv, "%s", "dirlist: exclude-prefix parameter must be a list of strings"); dirlist_free(srv, data); return NULL; } for (j = 0; j < v->data.list->len; j++) { if (v->type != LI_VALUE_LIST) { ERROR(srv, "%s", "dirlist: exclude-prefix parameter must be a list of strings"); dirlist_free(srv, data); return NULL; } else { g_ptr_array_add(data->exclude_prefix, g_string_new_len(GSTR_LEN(g_array_index(v->data.list, liValue*, j)->data.string))); } } } else if (g_str_equal(k->str, "debug")) { if (v->type != LI_VALUE_BOOLEAN) { ERROR(srv, "%s", "dirlist: debug parameter must be a boolean (true or false)"); dirlist_free(srv, data); return NULL; } data->debug = v->data.boolean; } else if (g_str_equal(k->str, "content-type")) { if (v->type != LI_VALUE_STRING) { ERROR(srv, "%s", "dirlist: content-type parameter must be a string"); dirlist_free(srv, data); return NULL; } g_string_assign(data->content_type, v->data.string->str); } else { ERROR(srv, "dirlist: unknown parameter \"%s\"", k->str); dirlist_free(srv, data); return NULL; } } } return li_action_new_function(dirlist, NULL, dirlist_free, data); } static const liPluginOption options[] = { { "dirlist.debug", LI_VALUE_BOOLEAN, NULL, NULL, NULL }, { NULL, 0, NULL, NULL, NULL } }; static const liPluginAction actions[] = { { "dirlist", dirlist_create }, { NULL, NULL } }; static const liliPluginSetupCB setups[] = { { NULL, NULL } }; static void plugin_dirlist_free(liServer *srv, liPlugin *p) { dirlist_plugin_data *pd; UNUSED(srv); pd = p->data; g_slice_free(dirlist_plugin_data, pd); } static void plugin_dirlist_init(liServer *srv, liPlugin *p) { dirlist_plugin_data *pd; UNUSED(srv); p->options = options; p->actions = actions; p->setups = setups; p->free = plugin_dirlist_free; pd = g_slice_new0(dirlist_plugin_data); p->data = pd; } gboolean mod_dirlist_init(liModules *mods, liModule *mod) { UNUSED(mod); MODULE_VERSION_CHECK(mods); mod->config = li_plugin_register(mods->main, "mod_dirlist", plugin_dirlist_init); return mod->config != NULL; } gboolean mod_dirlist_free(liModules *mods, liModule *mod) { if (mod->config) li_plugin_free(mods->main, mod->config); return TRUE; }