mirror of
https://github.com/bjc/prosody.git
synced 2025-04-03 21:27:38 +03:00
net.http.files: Copy of mod_http_files
The intent is to make it easier to reuse and simplify mod_http_files. Currently modules will use the serve() function exported by mod_http_files in order to serve their own files. This makes it unclear whether mod_http_files should be doing anything on its own. Moving the logic into a separate module should help here, as well as make re-use outside of prosody easier.
This commit is contained in:
Kim Alvefur
parent
392eac3c62
commit
6f6ac91056
1 changed files with 198 additions and 0 deletions
198
net/http/files.lua
Normal file
198
net/http/files.lua
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
-- Prosody IM
|
||||
-- Copyright (C) 2008-2010 Matthew Wild
|
||||
-- Copyright (C) 2008-2010 Waqas Hussain
|
||||
--
|
||||
-- This project is MIT/X11 licensed. Please see the
|
||||
-- COPYING file in the source package for more information.
|
||||
--
|
||||
|
||||
module:depends("http");
|
||||
local server = require"net.http.server";
|
||||
local lfs = require "lfs";
|
||||
|
||||
local os_date = os.date;
|
||||
local open = io.open;
|
||||
local stat = lfs.attributes;
|
||||
local build_path = require"socket.url".build_path;
|
||||
local path_sep = package.config:sub(1,1);
|
||||
|
||||
local base_path = module:get_option_path("http_files_dir", module:get_option_path("http_path"));
|
||||
local cache_size = module:get_option_number("http_files_cache_size", 128);
|
||||
local cache_max_file_size = module:get_option_number("http_files_cache_max_file_size", 4096);
|
||||
local dir_indices = module:get_option_array("http_index_files", { "index.html", "index.htm" });
|
||||
local directory_index = module:get_option_boolean("http_dir_listing");
|
||||
|
||||
local mime_map = module:shared("/*/http_files/mime").types;
|
||||
if not mime_map then
|
||||
mime_map = {
|
||||
html = "text/html", htm = "text/html",
|
||||
xml = "application/xml",
|
||||
txt = "text/plain",
|
||||
css = "text/css",
|
||||
js = "application/javascript",
|
||||
png = "image/png",
|
||||
gif = "image/gif",
|
||||
jpeg = "image/jpeg", jpg = "image/jpeg",
|
||||
svg = "image/svg+xml",
|
||||
};
|
||||
module:shared("/*/http_files/mime").types = mime_map;
|
||||
|
||||
local mime_types, err = open(module:get_option_path("mime_types_file", "/etc/mime.types", "config"), "r");
|
||||
if mime_types then
|
||||
local mime_data = mime_types:read("*a");
|
||||
mime_types:close();
|
||||
setmetatable(mime_map, {
|
||||
__index = function(t, ext)
|
||||
local typ = mime_data:match("\n(%S+)[^\n]*%s"..(ext:lower()).."%s") or "application/octet-stream";
|
||||
t[ext] = typ;
|
||||
return typ;
|
||||
end
|
||||
});
|
||||
end
|
||||
end
|
||||
|
||||
local forbidden_chars_pattern = "[/%z]";
|
||||
if prosody.platform == "windows" then
|
||||
forbidden_chars_pattern = "[/%z\001-\031\127\"*:<>?|]"
|
||||
end
|
||||
|
||||
local urldecode = require "util.http".urldecode;
|
||||
function sanitize_path(path)
|
||||
if not path then return end
|
||||
local out = {};
|
||||
|
||||
local c = 0;
|
||||
for component in path:gmatch("([^/]+)") do
|
||||
component = urldecode(component);
|
||||
if component:find(forbidden_chars_pattern) then
|
||||
return nil;
|
||||
elseif component == ".." then
|
||||
if c <= 0 then
|
||||
return nil;
|
||||
end
|
||||
out[c] = nil;
|
||||
c = c - 1;
|
||||
elseif component ~= "." then
|
||||
c = c + 1;
|
||||
out[c] = component;
|
||||
end
|
||||
end
|
||||
if path:sub(-1,-1) == "/" then
|
||||
out[c+1] = "";
|
||||
end
|
||||
return "/"..table.concat(out, "/");
|
||||
end
|
||||
|
||||
local cache = require "util.cache".new(cache_size);
|
||||
|
||||
function serve(opts)
|
||||
if type(opts) ~= "table" then -- assume path string
|
||||
opts = { path = opts };
|
||||
end
|
||||
-- luacheck: ignore 431
|
||||
local base_path = opts.path;
|
||||
local dir_indices = opts.index_files or dir_indices;
|
||||
local directory_index = opts.directory_index;
|
||||
local function serve_file(event, path)
|
||||
local request, response = event.request, event.response;
|
||||
local sanitized_path = sanitize_path(path);
|
||||
if path and not sanitized_path then
|
||||
return 400;
|
||||
end
|
||||
path = sanitized_path;
|
||||
local orig_path = sanitize_path(request.path);
|
||||
local full_path = base_path .. (path or ""):gsub("/", path_sep);
|
||||
local attr = stat(full_path:match("^.*[^\\/]")); -- Strip trailing path separator because Windows
|
||||
if not attr then
|
||||
return 404;
|
||||
end
|
||||
|
||||
local request_headers, response_headers = request.headers, response.headers;
|
||||
|
||||
local last_modified = os_date('!%a, %d %b %Y %H:%M:%S GMT', attr.modification);
|
||||
response_headers.last_modified = last_modified;
|
||||
|
||||
local etag = ('"%02x-%x-%x-%x"'):format(attr.dev or 0, attr.ino or 0, attr.size or 0, attr.modification or 0);
|
||||
response_headers.etag = etag;
|
||||
|
||||
local if_none_match = request_headers.if_none_match
|
||||
local if_modified_since = request_headers.if_modified_since;
|
||||
if etag == if_none_match
|
||||
or (not if_none_match and last_modified == if_modified_since) then
|
||||
return 304;
|
||||
end
|
||||
|
||||
local data = cache:get(orig_path);
|
||||
if data and data.etag == etag then
|
||||
response_headers.content_type = data.content_type;
|
||||
data = data.data;
|
||||
elseif attr.mode == "directory" and path then
|
||||
if full_path:sub(-1) ~= "/" then
|
||||
local dir_path = { is_absolute = true, is_directory = true };
|
||||
for dir in orig_path:gmatch("[^/]+") do dir_path[#dir_path+1]=dir; end
|
||||
response_headers.location = build_path(dir_path);
|
||||
return 301;
|
||||
end
|
||||
for i=1,#dir_indices do
|
||||
if stat(full_path..dir_indices[i], "mode") == "file" then
|
||||
return serve_file(event, path..dir_indices[i]);
|
||||
end
|
||||
end
|
||||
|
||||
if directory_index then
|
||||
data = server._events.fire_event("directory-index", { path = request.path, full_path = full_path });
|
||||
end
|
||||
if not data then
|
||||
return 403;
|
||||
end
|
||||
cache:set(orig_path, { data = data, content_type = mime_map.html; etag = etag; });
|
||||
response_headers.content_type = mime_map.html;
|
||||
|
||||
else
|
||||
local f, err = open(full_path, "rb");
|
||||
if not f then
|
||||
module:log("debug", "Could not open %s. Error was %s", full_path, err);
|
||||
return 403;
|
||||
end
|
||||
local ext = full_path:match("%.([^./]+)$");
|
||||
local content_type = ext and mime_map[ext];
|
||||
response_headers.content_type = content_type;
|
||||
if attr.size > cache_max_file_size then
|
||||
response_headers.content_length = attr.size;
|
||||
module:log("debug", "%d > cache_max_file_size", attr.size);
|
||||
return response:send_file(f);
|
||||
else
|
||||
data = f:read("*a");
|
||||
f:close();
|
||||
end
|
||||
cache:set(orig_path, { data = data; content_type = content_type; etag = etag });
|
||||
end
|
||||
|
||||
return response:send(data);
|
||||
end
|
||||
|
||||
return serve_file;
|
||||
end
|
||||
|
||||
function wrap_route(routes)
|
||||
for route,handler in pairs(routes) do
|
||||
if type(handler) ~= "function" then
|
||||
routes[route] = serve(handler);
|
||||
end
|
||||
end
|
||||
return routes;
|
||||
end
|
||||
|
||||
if base_path then
|
||||
module:provides("http", {
|
||||
route = {
|
||||
["GET /*"] = serve {
|
||||
path = base_path;
|
||||
directory_index = directory_index;
|
||||
}
|
||||
};
|
||||
});
|
||||
else
|
||||
module:log("debug", "http_files_dir not set, assuming use by some other module");
|
||||
end
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue