1 --[==========================================================================[
2 http.lua: HTTP interface module for VLC
3 --[==========================================================================[
4 Copyright (C) 2007-2009 the VideoLAN team
7 Authors: Antoine Cellerier <dionoea at videolan dot org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 --]==========================================================================]
24 --[==========================================================================[
25 Configuration options:
26 * host: A host to listen on.
27 * dir: Directory to use as the http interface's root.
28 * no_error_detail: If set, do not print the Lua error message when generating
30 * no_index: If set, don't build directory indexes
31 --]==========================================================================]
36 vlc.msg.info("Lua HTTP interface")
41 -- TODO: use internal VLC mime lookup function for mimes not included here
46 js = "text/javascript",
55 return (string.gsub(s,"([%^%$%%%.%[%]%*%+%-%?])","%%%1"))
58 function process_raw(filename)
59 local input = io.open(filename):read("*a")
60 -- find the longest [===[ or ]=====] type sequence and make sure that
61 -- we use one that's longer.
63 for str2 in string.gmatch(input,"[%[%]]=*[%[%]]") do
64 if #str < #str2 then str = str2 end
66 str=string.rep("=",#str-1)
69 <?xml version="1.0" encoding="charset" standalone="yes" ?> is still a problem. The closing '?>' needs to be printed using '?<?vlc print ">" ?>' to prevent a parse error.
71 local code0 = string.gsub(input,escape(close_tag)," print(["..str.."[")
72 local code1 = string.gsub(code0,escape(open_tag),"]"..str.."]) ")
73 local code = "print(["..str.."["..code1.."]"..str.."])"
74 --[[ Uncomment to debug
75 if string.match(filename,"vlm_cmd.xml$") then
80 return assert(loadstring(code,filename))
83 function process(filename)
84 local mtime = 0 -- vlc.net.stat(filename).modification_time
85 local func = false -- process_raw(filename)
87 local new_mtime = vlc.net.stat(filename).modification_time
88 if new_mtime ~= mtime then
89 -- Re-read the file if it changed
91 vlc.msg.dbg("Loading `"..filename.."'")
93 vlc.msg.dbg("Reloading `"..filename.."'")
95 func = process_raw(filename)
103 function callback_error(path,url,msg)
104 local url = url or "<page unknown>"
105 return [[<html xmlns="http://www.w3.org/1999/xhtml">
107 <title>Error loading ]]..url..[[</title>
110 <h1>Error loading ]]..url..[[</h1><pre>]]..(config.no_error_detail and "Remove configuration option `no_error_detail' on the server to get more information." or tostring(msg))..[[</pre>
112 <a href="http://www.videolan.org/">VideoLAN</a><br/>
113 <a href="http://www.lua.org/manual/5.1/">Lua 5.1 Reference Manual</a>
119 function dirlisting(url,listing,acl_)
121 for _,f in ipairs(listing) do
122 if not string.match(f,"^%.") then
123 table.insert(list,"<li><a href='"..f.."'>"..f.."</a></li>")
126 list = table.concat(list)
127 local function callback()
128 return [[<html xmlns="http://www.w3.org/1999/xhtml">
130 <title>Directory listing ]]..url..[[</title>
133 <h1>Directory listing ]]..url..[[</h1><ul>]]..list..[[</ul>
137 return h:file(url,"text/html",nil,nil,acl_,callback,nil)
140 -- FIXME: Experimental art support. Needs some cleaning up.
141 function callback_art(data, request)
142 local art = function(data, request)
143 local item = vlc.item()
144 local metas = item:metas()
145 local filename = vlc.strings.decode_uri(string.gsub(metas["artwork_url"],"file://",""))
146 local size = vlc.net.stat(filename).size
147 local ext = string.match(filename,"%.([^%.]-)$")
148 local raw = io.open(filename):read("*a")
149 local content = [[Content-Type: ]]..mimes[ext]..[[
151 Content-Length: ]]..size..[[
160 local ok, content = pcall(art, data, request)
163 Content-Type: text/plain
172 function file(h,path,url,acl_,mime)
173 local generate_page = process(path)
174 local callback = function(data,request)
175 -- FIXME: I'm sure that we could define a real sandbox
178 local function pageprint(...)
179 for i=1,select("#",...) do
181 table.insert(page,tostring(select(i,...)))
183 table.insert(page," "..tostring(select(i,...)))
187 _G._GET = parse_url_request(request)
188 local oldprint = print
190 local ok, msg = pcall(generate_page)
194 return callback_error(path,url,msg)
196 return table.concat(page)
198 return h:file(url or path,mime,nil,nil,acl_,callback,nil)
201 function rawfile(h,path,url,acl_)
202 local filename = path
203 local mtime = 0 -- vlc.net.stat(filename).modification_time
204 local page = false -- io.open(filename):read("*a")
205 local callback = function(data,request)
206 local new_mtime = vlc.net.stat(filename).modification_time
207 if mtime ~= new_mtime then
208 -- Re-read the file if it changed
210 vlc.msg.dbg("Loading `"..filename.."'")
212 vlc.msg.dbg("Reloading `"..filename.."'")
214 page = io.open(filename):read("*a")
219 return h:file(url or path,nil,nil,nil,acl_,callback,nil)
222 function parse_url_request(request)
223 if not request then return {} end
225 for k,v in string.gmatch(request,"([^=&]+)=?([^=&]*)") do
226 local k_ = vlc.strings.decode_uri(k)
227 local v_ = vlc.strings.decode_uri(v)
230 if type(t[k_]) ~= "table" then
232 table.insert(t2,t[k_])
245 local function find_datadir(name)
246 local list = vlc.misc.datadir_list(name)
247 for _, l in ipairs(list) do
248 local s = vlc.net.stat(l)
253 error("Unable to find the `"..name.."' directory.")
255 http_dir = config.dir or find_datadir("http")
258 local oldpath = package.path
259 package.path = http_dir.."/?.lua"
260 local ok, err = pcall(require,"custom")
262 vlc.msg.warn("Couldn't load "..http_dir.."/custom.lua",err)
264 vlc.msg.dbg("Loaded "..http_dir.."/custom.lua")
266 package.path = oldpath
269 local function load_dir(dir,root,parent_acl)
270 local root = root or "/"
271 local has_index = false
272 local my_acl = parent_acl
274 local af = dir.."/.hosts"
275 local s = vlc.net.stat(af)
276 if s and s.type == "file" then
278 my_acl = vlc.acl(false)
282 local d = vlc.net.opendir(dir)
283 for _,f in ipairs(d) do
284 if not string.match(f,"^%.") then
285 local s = vlc.net.stat(dir.."/"..f)
286 if s.type == "file" then
288 if f == "index.html" then
294 local ext = string.match(f,"%.([^%.]-)$")
295 local mime = mimes[ext]
297 if mime and string.match(mime,"^text/") then
298 table.insert(files,file(h,dir.."/"..f,url,my_acl,mime))
300 table.insert(files,rawfile(h,dir.."/"..f,url,my_acl))
302 elseif s.type == "dir" then
303 load_dir(dir.."/"..f,root..f.."/",my_acl)
307 if not has_index and not config.no_index then
308 -- print("Adding index for", root)
309 table.insert(files,dirlisting(root,d,my_acl))
314 local u = vlc.net.url_parse( config.host or "0.0.0.0:8080" )
315 h = vlc.httpd(u.host,u.port)
316 local root_acl = load_dir( http_dir )
317 local a = h:handler("/art",nil,nil,root_acl,callback_art,nil)
319 while not vlc.misc.lock_and_wait() do end -- everything happens in callbacks