]> git.sesse.net Git - vlc/blob - share/lua/intf/modules/httprequests.lua
generate properly escaped json
[vlc] / share / lua / intf / modules / httprequests.lua
1 --[==========================================================================[
2  httprequests.lua: code for processing httprequests commands and output
3 --[==========================================================================[
4  Copyright (C) 2007 the VideoLAN team
5  $Id$
6
7  Authors: Antoine Cellerier <dionoea at videolan dot org>
8  Rob Jonson <rob at hobbyistsoftware.com>
9
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License
21  along with this program; if not, write to the Free Software
22  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 --]==========================================================================]
24
25 module("httprequests",package.seeall)
26
27 local dkjson = require ("dkjson")
28
29
30
31 --Round the number to the specified precision
32 function round(what, precision)
33   if what then return math.floor(what*math.pow(10,precision)+0.5) / math.pow(10,precision) else return "" end
34 end
35
36 --split text where it matches the delimiter
37 function strsplit(text, delimiter)
38         local strfind = string.find
39         local strsub = string.sub
40         local tinsert = table.insert
41         local list = {}
42         local pos = 1
43         if strfind("", delimiter, 1) then -- this would result in endless loops
44                 error("delimiter matches empty string!")
45         end
46         local i=1
47         while 1 do
48                 i=i+1
49                 local first, last = strfind(text, delimiter, pos)
50                 if first then -- found?
51                         tinsert(list,i, strsub(text, pos, first-1))
52                         pos = last+1
53                 else
54                         tinsert(list,i, strsub(text, pos))
55                 break
56                 end
57         end
58         return list
59 end
60
61 function round(what, precision)
62 if what then return math.floor(what*math.pow(10,precision)+0.5) / math.pow(10,precision) else return "" end
63 end
64
65 --main function to process commands sent with the request
66
67 processcommands = function ()
68
69         local input = _GET['input']
70         local command = _GET['command']
71         local id = tonumber(_GET['id'] or -1)
72         local val = _GET['val']
73         local options = _GET['option']
74         local band = _GET['band']
75         if type(options) ~= "table" then -- Deal with the 0 or 1 option case
76           options = { options }
77         end
78
79         if command == "in_play" then
80           --[[
81           vlc.msg.err( "<options>" )
82           for a,b in ipairs(options) do
83                 vlc.msg.err(b)
84           end
85           vlc.msg.err( "</options>" )
86           --]]
87           vlc.playlist.add({{path=vlc.strings.make_uri(input),options=options}})
88         elseif command == "addsubtitle" then
89           vlc.input.add_subtitle (vlc.strings.make_uri(val))
90         elseif command == "in_enqueue" then
91           vlc.playlist.enqueue({{path=vlc.strings.make_uri(input),options=options}})
92         elseif command == "pl_play" then
93           if id == -1 then
94                 vlc.playlist.play()
95           else
96                 vlc.playlist.goto(id)
97           end
98         elseif command == "pl_pause" then
99           if vlc.playlist.status() == "stopped" then
100                 if id == -1 then
101                   vlc.playlist.play()
102                 else
103                   vlc.playlist.goto(id)
104                 end
105           else
106                 vlc.playlist.pause()
107           end
108         elseif command == "pl_forcepause" then
109           if vlc.playlist.status() == "playing" then
110                 vlc.playlist.pause()
111           end
112         elseif command == "pl_forceresume" then
113           if vlc.playlist.status() == "paused" then
114                 vlc.playlist.pause()
115           end
116         elseif command == "pl_stop" then
117           vlc.playlist.stop()
118         elseif command == "pl_next" then
119           vlc.playlist.next()
120         elseif command == "pl_previous" then
121           vlc.playlist.prev()
122         elseif command == "pl_delete" then
123           vlc.playlist.delete(id)
124         elseif command == "pl_empty" then
125           vlc.playlist.clear()
126         elseif command == "pl_sort" then
127           vlc.playlist.sort( val, id > 0 )
128         elseif command == "pl_random" then
129           vlc.playlist.random()
130         elseif command == "pl_loop" then
131         --if loop is set true, then repeat needs to be set false
132           if vlc.playlist.loop() then
133                 vlc.playlist.repeat_("off")
134           end
135         elseif command == "pl_repeat" then
136         --if repeat is set true, then loop needs to be set false
137           if vlc.playlist.repeat_() then
138                 vlc.playlist.loop("off")
139           end
140         elseif command == "pl_sd" then
141           if vlc.sd.is_loaded(val) then
142                 vlc.sd.remove(val)
143           else
144                 vlc.sd.add(val)
145           end
146         elseif command == "fullscreen" then
147           vlc.video.fullscreen()
148         elseif command == "snapshot" then
149           common.snapshot()
150         elseif command == "volume" then
151           common.volume(val)
152         elseif command == "seek" then
153           common.seek(val)
154         elseif command == "key" then
155           common.hotkey("key-"..val)
156         elseif command == "audiodelay" then
157           if vlc.object.input() and val then
158            vlc.var.set(vlc.object.input(),"audio-delay",val)
159           end
160         elseif command == "rate" then
161           if vlc.object.input() and tonumber(val) >= 0 then
162            vlc.var.set(vlc.object.input(),"rate",val)
163           end
164         elseif command == "subdelay" then
165           if vlc.object.input() then
166            vlc.var.set(vlc.object.input(),"spu-delay",val)
167           end
168         elseif command == "aspectratio" then
169           if vlc.object.vout() then
170            vlc.var.set(vlc.object.vout(),"aspect-ratio",val)
171           end
172         elseif command == "preamp" then
173           vlc.equalizer.preampset(val)
174         elseif command == "equalizer" then
175           vlc.equalizer.equalizerset(band,val)
176         elseif command == "enableeq" then
177           if val == '0' then vlc.equalizer.enable(false) else vlc.equalizer.enable(true) end
178         elseif command == "setpreset" then 
179           vlc.equalizer.setpreset(val)
180         end
181
182         local input = nil
183         local command = nil
184         local id = nil
185         local val = nil
186
187 end
188
189 --utilities for formatting output
190
191 function xmlString(s)
192   if (type(s)=="string") then
193         return vlc.strings.convert_xml_special_chars(s)
194   else
195         return tostring(s)
196   end
197 end
198
199
200
201 printTableAsJson = function (dict)
202         local output=dkjson.encode (dict, { indent = true })
203         print(output)
204 end
205
206 local printXmlKeyValue = function (k,v,indent)
207         print("\n")
208         for i=1,indent do print(" ") end
209         if (k) then
210                 print("<"..k..">")
211         end
212
213         if (type(v)=="table") then
214                 printTableAsXml(v,indent+2)
215         else
216         print(xmlString(v))
217     end
218
219     if (k) then
220                 print("</"..xmlString(k)..">")
221         end
222 end
223
224 printTableAsXml = function (dict,indent)
225         for k,v in pairs(dict) do
226         printXmlKeyValue(k,v,indent)
227     end
228 end
229
230 --[[
231 function logTable(t,pre)
232   local pre = pre or ""
233   for k,v in pairs(t) do
234     vlc.msg.err(pre..tostring(k).." : "..tostring(v))
235     if type(v) == "table" then
236       a(v,pre.."  ")
237     end
238   end
239 end
240 --]]
241
242 --main accessors
243
244 getplaylist = function ()
245         local p
246
247         if _GET["search"] then
248           if _GET["search"] ~= "" then
249                 _G.search_key = _GET["search"]
250           else
251                 _G.search_key = nil
252           end
253           local key = vlc.strings.decode_uri(_GET["search"])
254           p = vlc.playlist.search(key)
255         else
256           p = vlc.playlist.get()
257         end
258
259         --logTable(p) --Uncomment to debug
260
261         return p
262 end
263
264 parseplaylist = function (item)
265         if item.flags.disabled then return end
266
267         if (item.children) then
268                 local result={}
269                 local name = (item.name or "")
270
271                 result["type"]="node"
272                 result.id=tostring(item.id)
273                 result.name=tostring(name)
274                 result.ro=item.flags.ro and "ro" or "rw"
275
276                 --store children in an array
277                 --we use _array as a proxy for arrays
278                 result.children={}
279                 result.children._array={}
280
281                 for _, child in ipairs(item.children) do
282                         local nextChild=parseplaylist(child)
283             table.insert(result.children._array,nextChild)
284         end
285
286                 return result
287         else
288                 local result={}
289                 local name, path = item.name or ""
290                 local path = item.path or ""
291                 local current_item = vlc.input.item()
292
293                 -- Is the item the one currently played
294                 if(current_item ~= nil) then
295             if(vlc.input.item().uri(current_item) == path) then
296                 result.current = "current"
297             end
298         end
299
300                 result["type"]="leaf"
301                 result.id=tostring(item.id)
302                 result.uri=tostring(path)
303                 result.name=name
304                 result.ro=item.flags.ro and "ro" or "rw"
305                 result.duration=math.floor(item.duration)
306
307                 return result
308         end
309
310 end
311
312 playlisttable = function ()
313
314         local basePlaylist=getplaylist()
315
316         return parseplaylist(basePlaylist)
317 end
318
319 getbrowsetable = function ()
320
321         local dir = nil
322         local uri = _GET["uri"]
323         --uri takes precedence, but fall back to dir
324         if uri then
325                 dir = vlc.strings.make_path(uri)
326         else
327                 dir = _GET["dir"]
328         end
329
330         local result={}
331         --paths are returned as an array of elements
332         result.element={}
333         result.element._array={}
334
335         if dir then
336                 if dir == "~" then dir = vlc.misc.homedir() end
337                         dir = common.realpath(dir.."/")
338                         local d = vlc.net.opendir(dir)
339                         table.sort(d)
340
341                         for _,f in pairs(d) do
342                                 if f == ".." or not string.match(f,"^%.") then
343                                 local df = common.realpath(dir..f)
344                                 local s = vlc.net.stat(df)
345                                 local path, name =  df, f
346                                 local element={}
347
348                                 for k,v in pairs(s) do
349                                         element[k]=v
350                                 end
351                                 element["path"]=path
352                                 element["name"]=name
353
354                                 local uri=vlc.strings.make_uri(df)
355                                 --windows paths are returned with / separators, but make_uri expects \ for windows and returns nil
356                                 if not uri then
357                                         --convert failed path to windows format and try again
358                                         path=string.gsub(path,"/","\\")
359                                         uri=vlc.strings.make_uri(df)
360                                 end
361                                 element["uri"]=uri
362
363                                 table.insert(result.element._array,element)
364                         end
365
366                 end
367         end
368
369         return result;
370 end
371
372
373 getstatus = function (includecategories)
374
375
376 local input = vlc.object.input()
377 local item = vlc.input.item()
378 local playlist = vlc.object.playlist()
379 local vout = vlc.object.vout()
380 local aout = vlc.object.aout()
381
382         local s ={}
383
384         --update api version when new data/commands added
385         s.apiversion=1
386         s.version=vlc.misc.version()
387         s.volume=vlc.volume.get()
388
389         if input then
390                 s.length=math.floor(vlc.var.get(input,"length"))
391                 s.time=math.floor(vlc.var.get(input,"time"))
392                 s.position=vlc.var.get(input,"position")
393                 s.audiodelay=vlc.var.get(input,"audio-delay")
394                 s.rate=vlc.var.get(input,"rate")
395                 s.subtitledelay=vlc.var.get(input,"spu-delay")
396         else
397                 s.length=0
398                 s.time=0
399                 s.position=0
400                 s.audiodelay=0
401                 s.rate=1
402                 s.subtitledelay=0
403         end
404
405         if vout then
406                 s.fullscreen=vlc.var.get(vout,"fullscreen")
407                 s.aspectratio=vlc.var.get(vout,"aspect-ratio");
408                 if s.aspectratio=="" then s.aspectratio = "default" end
409         else
410                 s.fullscreen=0
411         end
412
413         if aout then
414                 local filters=vlc.var.get(aout,"audio-filter")
415                 local temp=strsplit(filters,":")
416                 s.audiofilters={}
417                 local id=0
418                 for i,j in pairs(temp) do
419                         s.audiofilters['filter_'..id]=j
420                         id=id+1
421                 end
422         end
423
424         s.videoeffects={}
425         s.videoeffects.hue=round(vlc.config.get("hue"),2)
426         s.videoeffects.brightness=round(vlc.config.get("brightness"),2)
427         s.videoeffects.contrast=round(vlc.config.get("contrast"),2)
428         s.videoeffects.saturation=round(vlc.config.get("saturation"),2)
429         s.videoeffects.gamma=round(vlc.config.get("gamma"),2)
430
431         s.state=vlc.playlist.status()
432         s.random=vlc.var.get(playlist,"random")
433         s.loop=vlc.var.get(playlist,"loop")
434         s["repeat"]=vlc.var.get(playlist,"repeat")
435
436         s.equalizer={}
437                 s.equalizer.preamp=round(vlc.equalizer.preampget(),2)
438                 s.equalizer.bands=vlc.equalizer.equalizerget()
439                 if s.equalizer.bands ~= null then
440                         for k,i in pairs(s.equalizer.bands) do s.equalizer.bands[k]=round(i,2) end
441                         s.equalizer.presets=vlc.equalizer.presets()
442                 end
443
444         if (includecategories and item) then
445                 s.information={}
446                 s.information.category={}
447                 s.information.category.meta=item:metas()
448
449                 local info = item:info()
450                 for k, v in pairs(info) do
451                         local streamTable={}
452                         for k2, v2 in pairs(v) do
453                                 local tag = string.gsub(k2," ","_")
454                                 streamTable[tag]=v2
455                         end
456
457                         s.information.category[k]=streamTable
458                 end
459
460                 s.stats={}
461
462                 local statsdata = item:stats()
463         for k,v in pairs(statsdata) do
464                 local tag = string.gsub(k,"_","")
465         s.stats[tag]=v
466       end
467         end
468         return s
469 end
470