summaryrefslogtreecommitdiffhomepage
path: root/libs/luci-lib-rpcc/luasrc/rpcc.lua
blob: fc52b7eb07e664bfc5f75b272f517dfd92098a95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
-- Copyright 2009 Steven Barth <steven@midlink.org>
-- Licensed to the public under the Apache License 2.0.

local util = require "luci.util"
local json = require "luci.json"
local ltn12 = require "luci.ltn12"
local nixio = require "nixio", require "nixio.util"

local tostring, assert, setmetatable = tostring, assert, setmetatable
local error = error

--- LuCI RPC Client.
-- @cstyle instance
module "luci.rpcc"

RQLIMIT = 32 * nixio.const.buffersize

--- Create a new JSON-RPC stream client.
-- @class function
-- @param fd File descriptor
-- @param v1 Use protocol version 1.0
-- @return RPC Client
Client = util.class()

function Client.__init__(self, fd, v1)
	self.fd = fd
	self.uniqueid = tostring(self):match("0x([a-f0-9]+)")
	self.msgid = 1
	self.v1 = v1
end

--- Request an RP call and get the response.
-- @param method Remote method
-- @param params Parameters
-- @param notification Notification only?
-- @return response 
function Client.request(self, method, params, notification)
	local oldchunk = self.decoder and self.decoder.chunk
	self.decoder = json.ActiveDecoder(self.fd:blocksource(nil, RQLIMIT))
	self.decoder.chunk = oldchunk
	
	local reqid = self.msgid .. self.uniqueid
	local reqdata = json.Encoder({
		id = (not notification) and (self.msgid .. self.uniqueid) or nil,
		jsonrpc = (not self.v1) and "2.0" or nil,
		method = method,
		params = params
	})
	ltn12.pump.all(reqdata:source(), self.fd:sink())
	if not notification then
		self.msgid = self.msgid + 1
		local response = self.decoder:get()
		assert(response.id == reqid, "Invalid response id")
		if response.error then
			error(response.error.message or response.error)
		end
		return response.result
	end
end

--- Create a transparent RPC proxy.
-- @param prefix Method prefix
-- @return RPC Proxy object
function Client.proxy(self, prefix)
	prefix = prefix or ""
	return setmetatable({}, {
		__call = function(proxy, ...)
			return self:request(prefix, {...})
		end,
		__index = function(proxy, name)
			return self:proxy(prefix .. name .. ".")
		end
	})
end