mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 19:01:56 +00:00
499 lines
38 KiB
HTML
499 lines
38 KiB
HTML
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="icon" href="favicon.png"><link type="text/css" rel="stylesheet" href="extra.css"><title>Source: rpc.js</title><!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="fallback-dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">LuCI Documentation</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-JsonRpcHowTo.html">Using JSON RPC daemon</a></div><div class="sidebar-section-children"><a href="tutorial-Modules.html">Modules</a></div><div class="sidebar-section-children"><a href="tutorial-ThemesHowTo.html">Making Themes</a></div><div class="sidebar-section-children"><a href="tutorial-i18n.html">Internationalisation - i18n</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.module_cbi.html">cbi</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.html">LuCI</a></div><div class="sidebar-section-children"><a href="LuCI.baseclass.html">baseclass</a></div><div class="sidebar-section-children"><a href="LuCI.dom.html">dom</a></div><div class="sidebar-section-children"><a href="LuCI.form.html">form</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractSection.html">AbstractSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractValue.html">AbstractValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Button.html">Button</a></div><div class="sidebar-section-children"><a href="LuCI.form.DirectoryPicker.html">DirectoryPicker</a></div><div class="sidebar-section-children"><a href="LuCI.form.DummyValue.html">DummyValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.form.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.form.Flag.html">Flag</a></div><div class="sidebar-section-children"><a href="LuCI.form.GridSection.html">GridSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.HiddenValue.html">HiddenValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.JSONMap.html">JSONMap</a></div><div class="sidebar-section-children"><a href="LuCI.form.ListValue.html">ListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Map.html">Map</a></div><div class="sidebar-section-children"><a href="LuCI.form.MultiValue.html">MultiValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.NamedSection.html">NamedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.RangeSliderValue.html">RangeSliderValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.RichListValue.html">RichListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.SectionValue.html">SectionValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TableSection.html">TableSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.TextValue.html">TextValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TypedSection.html">TypedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.Value.html">Value</a></div><div class="sidebar-section-children"><a href="LuCI.fs.html">fs</a></div><div class="sidebar-section-children"><a href="LuCI.headers.html">headers</a></div><div class="sidebar-section-children"><a href="LuCI.network.html">network</a></div><div class="sidebar-section-children"><a href="LuCI.network.Device.html">Device</a></div><div class="sidebar-section-children"><a href="LuCI.network.Hosts.html">Hosts</a></div><div class="sidebar-section-children"><a href="LuCI.network.Protocol.html">Protocol</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiDevice.html">WifiDevice</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiNetwork.html">WifiNetwork</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiVlan.html">WifiVlan</a></div><div class="sidebar-section-children"><a href="LuCI.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.request.html">request</a></div><div class="sidebar-section-children"><a href="LuCI.request.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.response.html">response</a></div><div class="sidebar-section-children"><a href="LuCI.rpc.html">rpc</a></div><div class="sidebar-section-children"><a href="LuCI.session.html">session</a></div><div class="sidebar-section-children"><a href="LuCI.uci.html">uci</a></div><div class="sidebar-section-children"><a href="LuCI.ui.html">ui</a></div><div class="sidebar-section-children"><a href="LuCI.ui.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Checkbox.html">Checkbox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.ComboButton.html">ComboButton</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Combobox.html">Combobox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Dropdown.html">Dropdown</a></div><div class="sidebar-section-children"><a href="LuCI.ui.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.ui.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Hiddenfield.html">Hiddenfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.RangeSlider.html">RangeSlider</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Select.html">Select</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textarea.html">Textarea</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textfield.html">Textfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.changes.html">changes</a></div><div class="sidebar-section-children"><a href="LuCI.ui.menu.html">menu</a></div><div class="sidebar-section-children"><a href="LuCI.ui.tabs.html">tabs</a></div><div class="sidebar-section-children"><a href="LuCI.validation.html">validation</a></div><div class="sidebar-section-children"><a href="LuCI.validation.Validator.html">Validator</a></div><div class="sidebar-section-children"><a href="LuCI.validation.ValidatorFactory.html">ValidatorFactory</a></div><div class="sidebar-section-children"><a href="LuCI.view.html">view</a></div><div class="sidebar-section-children"><a href="LuCI.xhr.html">xhr</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-String.html">String</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="github-home navbar-item"><a id="" href="https://github.com/openwrt/luci" target="">GitHub Project Page</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">rpc.js</h1></header><article><pre class="prettyprint source lang-js"><code>'use strict';
|
|
'require baseclass';
|
|
'require request';
|
|
|
|
let rpcRequestID = 1;
|
|
let rpcSessionID = L.env.sessionid ?? '00000000000000000000000000000000';
|
|
let rpcBaseURL = L.url('admin/ubus');
|
|
const rpcInterceptorFns = [];
|
|
|
|
/**
|
|
* @class rpc
|
|
* @memberof LuCI
|
|
* @hideconstructor
|
|
* @classdesc
|
|
*
|
|
* The `LuCI.rpc` class provides high level ubus JSON-RPC abstractions
|
|
* and means for listing and invoking remove RPC methods.
|
|
*/
|
|
return baseclass.extend(/** @lends LuCI.rpc.prototype */ {
|
|
/* privates */
|
|
call(req, cb, nobatch) {
|
|
let q = '';
|
|
|
|
if (Array.isArray(req)) {
|
|
if (req.length == 0)
|
|
return Promise.resolve([]);
|
|
|
|
for (let i = 0; i < req.length; i++)
|
|
if (req[i].params)
|
|
q += '%s%s.%s'.format(
|
|
q ? ';' : '/',
|
|
req[i].params[1],
|
|
req[i].params[2]
|
|
);
|
|
}
|
|
|
|
return request.post(rpcBaseURL + q, req, {
|
|
timeout: (L.env.rpctimeout ?? 20) * 1000,
|
|
nobatch,
|
|
credentials: true
|
|
}).then(cb, cb);
|
|
},
|
|
|
|
parseCallReply(req, res) {
|
|
let msg = null;
|
|
|
|
if (res instanceof Error)
|
|
return req.reject(res);
|
|
|
|
try {
|
|
if (!res.ok)
|
|
L.raise('RPCError', 'RPC call to %s/%s failed with HTTP error %d: %s',
|
|
req.object, req.method, res.status, res.statusText || '?');
|
|
|
|
msg = res.json();
|
|
}
|
|
catch (e) {
|
|
return req.reject(e);
|
|
}
|
|
|
|
/*
|
|
* The interceptor args are intentionally swapped.
|
|
* Response is passed as first arg to align with Request class interceptors
|
|
*/
|
|
Promise.all(rpcInterceptorFns.map(fn => fn(msg, req)))
|
|
.then(this.handleCallReply.bind(this, req, msg))
|
|
.catch(req.reject);
|
|
},
|
|
|
|
handleCallReply(req, msg) {
|
|
const type = Object.prototype.toString;
|
|
let ret = null;
|
|
|
|
try {
|
|
/* verify message frame */
|
|
if (!L.isObject(msg) || msg.jsonrpc != '2.0')
|
|
L.raise('RPCError', 'RPC call to %s/%s returned invalid message frame',
|
|
req.object, req.method);
|
|
|
|
/* check error condition */
|
|
if (L.isObject(msg.error) && msg.error.code && msg.error.message)
|
|
L.raise('RPCError', 'RPC call to %s/%s failed with error %d: %s',
|
|
req.object, req.method, msg.error.code, msg.error.message || '?');
|
|
}
|
|
catch (e) {
|
|
return req.reject(e);
|
|
}
|
|
|
|
if (!req.object && !req.method) {
|
|
ret = msg.result;
|
|
}
|
|
else if (Array.isArray(msg.result)) {
|
|
if (req.raise && msg.result[0] !== 0)
|
|
L.raise('RPCError', 'RPC call to %s/%s failed with ubus code %d: %s',
|
|
req.object, req.method, msg.result[0], this.getStatusText(msg.result[0]));
|
|
|
|
ret = (msg.result.length > 1) ? msg.result[1] : msg.result[0];
|
|
}
|
|
|
|
if (req.expect) {
|
|
for (const key in req.expect) {
|
|
if (ret != null && key != '')
|
|
ret = ret[key];
|
|
|
|
if (ret == null || type.call(ret) != type.call(req.expect[key]))
|
|
ret = req.expect[key];
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
/* apply filter */
|
|
if (typeof(req.filter) == 'function') {
|
|
req.priv[0] = ret;
|
|
req.priv[1] = req.params;
|
|
ret = req.filter.apply(this, req.priv);
|
|
}
|
|
|
|
req.resolve(ret);
|
|
},
|
|
|
|
/**
|
|
* Lists available remote ubus objects or the method signatures of
|
|
* specific objects.
|
|
*
|
|
* This function has two signatures and is sensitive to the number of
|
|
* arguments passed to it:
|
|
* - `list()` -
|
|
* Returns an array containing the names of all remote `ubus` objects
|
|
* - `list("objname", ...)`
|
|
* Returns method signatures for each given `ubus` object name.
|
|
*
|
|
* @param {...string} [args] (objectNames)
|
|
* If any object names are given, this function will return the method
|
|
* signatures of each given object.
|
|
*
|
|
* @returns {Promise<Array<string>|Object<string, Object<string, Object<string, string>>>>}
|
|
* When invoked without arguments, this function will return a promise
|
|
* resolving to an array of `ubus` object names. When invoked with one or
|
|
* more arguments, a promise resolving to an object describing the method
|
|
* signatures of each requested `ubus` object name will be returned.
|
|
*/
|
|
list(...args) {
|
|
const msg = {
|
|
jsonrpc: '2.0',
|
|
id: rpcRequestID++,
|
|
method: 'list',
|
|
params: args.length ? args : undefined
|
|
};
|
|
|
|
return new Promise(L.bind(function(resolve, reject) {
|
|
/* store request info */
|
|
const req = { resolve, reject };
|
|
|
|
/* call rpc */
|
|
this.call(msg, this.parseCallReply.bind(this, req));
|
|
}, this));
|
|
},
|
|
|
|
/**
|
|
* @typedef {Object} DeclareOptions
|
|
* @memberof LuCI.rpc
|
|
*
|
|
* @property {string} object
|
|
* The name of the remote `ubus` object to invoke.
|
|
*
|
|
* @property {string} method
|
|
* The name of the remote `ubus` method to invoke.
|
|
*
|
|
* @property {string[]} [params]
|
|
* Lists the named parameters expected by the remote `ubus` RPC method.
|
|
* The arguments passed to the resulting generated method call function
|
|
* will be mapped to named parameters in the order they appear in this
|
|
* array.
|
|
*
|
|
* Extraneous parameters passed to the generated function will not be
|
|
* sent to the remote procedure but are passed to the
|
|
* {@link LuCI.rpc.filterFn filter function} if one is specified.
|
|
*
|
|
* Examples:
|
|
* - `params: [ "foo", "bar" ]` -
|
|
* When the resulting call function is invoked with `fn(true, false)`,
|
|
* the corresponding args object sent to the remote procedure will be
|
|
* `{ foo: true, bar: false }`.
|
|
* - `params: [ "test" ], filter: function(reply, args, extra) { ... }` -
|
|
* When the resulting generated function is invoked with
|
|
* `fn("foo", "bar", "baz")` then `{ "test": "foo" }` will be sent as
|
|
* argument to the remote procedure and the filter function will be
|
|
* invoked with `filterFn(reply, [ "foo" ], "bar", "baz")`
|
|
*
|
|
* @property {Object<string,*>} [expect]
|
|
* Describes the expected return data structure. The given object is
|
|
* supposed to contain a single key selecting the value to use from
|
|
* the returned `ubus` reply object. The value of the sole key within
|
|
* the `expect` object is used to infer the expected type of the received
|
|
* `ubus` reply data.
|
|
*
|
|
* If the received data does not contain `expect`'s key, or if the
|
|
* type of the data differs from the type of the value in the expect
|
|
* object, the expect object's value is returned as default instead.
|
|
*
|
|
* The key in the `expect` object may be an empty string (`''`) in which
|
|
* case the entire reply object is selected instead of one of its subkeys.
|
|
*
|
|
* If the `expect` option is omitted, the received reply will be returned
|
|
* as-is, regardless of its format or type.
|
|
*
|
|
* Examples:
|
|
* - `expect: { '': { error: 'Invalid response' } }` -
|
|
* This requires the entire `ubus` reply to be a plain JavaScript
|
|
* object. If the reply isn't an object but e.g. an array or a numeric
|
|
* error code instead, it will get replaced with
|
|
* `{ error: 'Invalid response' }` instead.
|
|
* - `expect: { results: [] }` -
|
|
* This requires the received `ubus` reply to be an object containing
|
|
* a key `results` with an array as value. If the received reply does
|
|
* not contain such a key, or if `reply.results` points to a non-array
|
|
* value, the empty array (`[]`) will be used instead.
|
|
* - `expect: { success: false }` -
|
|
* This requires the received `ubus` reply to be an object containing
|
|
* a key `success` with a boolean value. If the reply does not contain
|
|
* `success` or if `reply.success` is not a boolean value, `false` will
|
|
* be returned as default instead.
|
|
*
|
|
* @property {LuCI.rpc.filterFn} [filter]
|
|
* Specifies an optional filter function which is invoked to transform the
|
|
* received reply data before it is returned to the caller.
|
|
*
|
|
* @property {boolean} [reject=false]
|
|
* If set to `true`, non-zero ubus call status codes are treated as fatal
|
|
* error and lead to the rejection of the call promise. The default
|
|
* behaviour is to resolve with the call return code value instead.
|
|
*/
|
|
|
|
/**
|
|
* The filter function is invoked to transform a received `ubus` RPC call
|
|
* reply before returning it to the caller.
|
|
*
|
|
* @callback LuCI.rpc.filterFn
|
|
*
|
|
* @param {*} data
|
|
* The received `ubus` reply data or a subset of it as described in the
|
|
* `expect` option of the RPC call declaration. In case of remote call
|
|
* errors, `data` is numeric `ubus` error code instead.
|
|
*
|
|
* @param {Array<*>} args
|
|
* The arguments the RPC method has been invoked with.
|
|
*
|
|
* @param {...*} extraArgs
|
|
* All extraneous arguments passed to the RPC method exceeding the number
|
|
* of arguments describes in the RPC call declaration.
|
|
*
|
|
* @returns {*}
|
|
* The return value of the filter function will be returned to the caller
|
|
* of the RPC method as-is.
|
|
*/
|
|
|
|
/**
|
|
* The generated invocation function is returned by
|
|
* {@link LuCI.rpc#declare rpc.declare()} and encapsulates a single
|
|
* RPC method call.
|
|
*
|
|
* Calling this function will execute a remote `ubus` HTTP call request
|
|
* using the arguments passed to it as arguments and return a promise
|
|
* resolving to the received reply values.
|
|
*
|
|
* @callback LuCI.rpc.invokeFn
|
|
*
|
|
* @param {...*} params
|
|
* The parameters to pass to the remote procedure call. The given
|
|
* positional arguments will be named to named RPC parameters according
|
|
* to the names specified in the `params` array of the method declaration.
|
|
*
|
|
* Any additional parameters exceeding the amount of arguments in the
|
|
* `params` declaration are passed as private extra arguments to the
|
|
* declared filter function.
|
|
*
|
|
* @returns {Promise<*>}
|
|
* Returns a promise resolving to the result data of the remote `ubus`
|
|
* RPC method invocation, optionally substituted and filtered according
|
|
* to the `expect` and `filter` declarations.
|
|
*/
|
|
|
|
/**
|
|
* Describes a remote RPC call procedure and returns a function
|
|
* implementing it.
|
|
*
|
|
* @param {LuCI.rpc.DeclareOptions} options
|
|
* If any object names are given, this function will return the method
|
|
* signatures of each given object.
|
|
*
|
|
* @returns {LuCI.rpc.invokeFn}
|
|
* Returns a new function implementing the method call described in
|
|
* `options`.
|
|
*/
|
|
declare(options) {
|
|
return Function.prototype.bind.call(function(rpc, options, ...args) {
|
|
return new Promise((resolve, reject) => {
|
|
/* build parameter object */
|
|
let p_off = 0;
|
|
const params = { };
|
|
if (Array.isArray(options.params)) {
|
|
// Array style: parameter names are positional
|
|
for (p_off = 0; p_off < options.params.length; p_off++)
|
|
params[options.params[p_off]] = args[p_off];
|
|
} else if (typeof(options.params) === 'object') {
|
|
// Object style: first arg is an object with the parameter keys
|
|
const argObj = args[0];
|
|
if (argObj && typeof(argObj) === 'object') {
|
|
for (let key in options.params)
|
|
if (key in argObj)
|
|
params[key] = argObj[key];
|
|
}
|
|
p_off = 1;
|
|
}
|
|
|
|
/* all remaining arguments are private args */
|
|
const priv = [ undefined, undefined ];
|
|
for (; p_off < args.length; p_off++)
|
|
priv.push(args[p_off]);
|
|
|
|
/* store request info */
|
|
const req = {
|
|
expect: options.expect,
|
|
filter: options.filter,
|
|
resolve,
|
|
reject,
|
|
params,
|
|
priv,
|
|
object: options.object,
|
|
method: options.method,
|
|
raise: options.reject
|
|
};
|
|
|
|
/* build message object */
|
|
const msg = {
|
|
jsonrpc: '2.0',
|
|
id: rpcRequestID++,
|
|
method: 'call',
|
|
params: [
|
|
rpcSessionID,
|
|
options.object,
|
|
options.method,
|
|
params
|
|
]
|
|
};
|
|
|
|
/* call rpc */
|
|
rpc.call(msg, rpc.parseCallReply.bind(rpc, req), options.nobatch);
|
|
});
|
|
}, this, this, options);
|
|
},
|
|
|
|
/**
|
|
* Returns the current RPC session id.
|
|
*
|
|
* @returns {string}
|
|
* Returns the 32 byte session ID string used for authenticating remote
|
|
* requests.
|
|
*/
|
|
getSessionID() {
|
|
return rpcSessionID;
|
|
},
|
|
|
|
/**
|
|
* Set the RPC session id to use.
|
|
*
|
|
* @param {string} sid
|
|
* Sets the 32 byte session ID string used for authenticating remote
|
|
* requests.
|
|
*/
|
|
setSessionID(sid) {
|
|
rpcSessionID = sid;
|
|
},
|
|
|
|
/**
|
|
* Returns the current RPC base URL.
|
|
*
|
|
* @returns {string}
|
|
* Returns the RPC URL endpoint to issue requests against.
|
|
*/
|
|
getBaseURL() {
|
|
return rpcBaseURL;
|
|
},
|
|
|
|
/**
|
|
* Set the RPC base URL to use.
|
|
*
|
|
* @param {string} url
|
|
* Sets the RPC URL endpoint to issue requests against.
|
|
*/
|
|
setBaseURL(url) {
|
|
rpcBaseURL = url;
|
|
},
|
|
|
|
/**
|
|
* Translates a numeric `ubus` error code into a human readable
|
|
* description.
|
|
*
|
|
* @param {number} statusCode
|
|
* The numeric status code.
|
|
*
|
|
* @returns {string}
|
|
* Returns the textual description of the code.
|
|
*/
|
|
getStatusText(statusCode) {
|
|
switch (statusCode) {
|
|
case 0: return _('Command OK');
|
|
case 1: return _('Invalid command');
|
|
case 2: return _('Invalid argument');
|
|
case 3: return _('Method not found');
|
|
case 4: return _('Resource not found');
|
|
case 5: return _('No data received');
|
|
case 6: return _('Permission denied');
|
|
case 7: return _('Request timeout');
|
|
case 8: return _('Not supported');
|
|
case 9: return _('Unspecified error');
|
|
case 10: return _('Connection lost');
|
|
default: return _('Unknown error code');
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Registered interceptor functions are invoked before the standard reply
|
|
* parsing and handling logic.
|
|
*
|
|
* By returning rejected promises, interceptor functions can cause the
|
|
* invocation function to fail, regardless of the received reply.
|
|
*
|
|
* Interceptors may also modify their message argument in-place to
|
|
* rewrite received replies before they're processed by the standard
|
|
* response handling code.
|
|
*
|
|
* A common use case for such functions is to detect failing RPC replies
|
|
* due to expired authentication in order to trigger a new login.
|
|
*
|
|
* @callback LuCI.rpc~interceptorFn
|
|
*
|
|
* @param {*} msg
|
|
* The unprocessed, JSON decoded remote RPC method call reply.
|
|
*
|
|
* Since interceptors run before the standard parsing logic, the reply
|
|
* data is not verified for correctness or filtered according to
|
|
* `expect` and `filter` specifications in the declarations.
|
|
*
|
|
* @param {Object} req
|
|
* The related request object which is an extended variant of the
|
|
* declaration object, allowing access to internals of the invocation
|
|
* function such as `filter`, `expect` or `params` values.
|
|
*
|
|
* @returns {Promise<*>|*}
|
|
* Interceptor functions may return a promise to defer response
|
|
* processing until some delayed work completed. Any values the returned
|
|
* promise resolves to are ignored.
|
|
*
|
|
* When the returned promise rejects with an error, the invocation
|
|
* function will fail too, forwarding the error to the caller.
|
|
*/
|
|
|
|
/**
|
|
* Registers a new interceptor function.
|
|
*
|
|
* @param {LuCI.rpc.interceptorFn} interceptorFn
|
|
* The interceptor function to register.
|
|
*
|
|
* @returns {LuCI.rpc.interceptorFn}
|
|
* Returns the given function value.
|
|
*/
|
|
addInterceptor(interceptorFn) {
|
|
if (typeof(interceptorFn) == 'function')
|
|
rpcInterceptorFns.push(interceptorFn);
|
|
|
|
return interceptorFn;
|
|
},
|
|
|
|
/**
|
|
* Removes a registered interceptor function.
|
|
*
|
|
* @param {LuCI.rpc.interceptorFn} interceptorFn
|
|
* The interceptor function to remove.
|
|
*
|
|
* @returns {boolean}
|
|
* Returns `true` if the given function has been removed or `false`
|
|
* if it has not been found.
|
|
*/
|
|
removeInterceptor(interceptorFn) {
|
|
const oldlen = rpcInterceptorFns.length;
|
|
let i = oldlen;
|
|
|
|
while (i--)
|
|
if (rpcInterceptorFns[i] === interceptorFn)
|
|
rpcInterceptorFns.splice(i, 1);
|
|
|
|
return (rpcInterceptorFns.length < oldlen);
|
|
}
|
|
});
|
|
</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">LuCI Documentation</a><div class="mobile-nav-links"><div class="github-home navbar-item"><a id="" href="https://github.com/openwrt/luci" target="">GitHub Project Page</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-JsonRpcHowTo.html">Using JSON RPC daemon</a></div><div class="sidebar-section-children"><a href="tutorial-Modules.html">Modules</a></div><div class="sidebar-section-children"><a href="tutorial-ThemesHowTo.html">Making Themes</a></div><div class="sidebar-section-children"><a href="tutorial-i18n.html">Internationalisation - i18n</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.module_cbi.html">cbi</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="LuCI.html">LuCI</a></div><div class="sidebar-section-children"><a href="LuCI.baseclass.html">baseclass</a></div><div class="sidebar-section-children"><a href="LuCI.dom.html">dom</a></div><div class="sidebar-section-children"><a href="LuCI.form.html">form</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractSection.html">AbstractSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.AbstractValue.html">AbstractValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Button.html">Button</a></div><div class="sidebar-section-children"><a href="LuCI.form.DirectoryPicker.html">DirectoryPicker</a></div><div class="sidebar-section-children"><a href="LuCI.form.DummyValue.html">DummyValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.form.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.form.Flag.html">Flag</a></div><div class="sidebar-section-children"><a href="LuCI.form.GridSection.html">GridSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.HiddenValue.html">HiddenValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.JSONMap.html">JSONMap</a></div><div class="sidebar-section-children"><a href="LuCI.form.ListValue.html">ListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.Map.html">Map</a></div><div class="sidebar-section-children"><a href="LuCI.form.MultiValue.html">MultiValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.NamedSection.html">NamedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.RangeSliderValue.html">RangeSliderValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.RichListValue.html">RichListValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.SectionValue.html">SectionValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TableSection.html">TableSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.TextValue.html">TextValue</a></div><div class="sidebar-section-children"><a href="LuCI.form.TypedSection.html">TypedSection</a></div><div class="sidebar-section-children"><a href="LuCI.form.Value.html">Value</a></div><div class="sidebar-section-children"><a href="LuCI.fs.html">fs</a></div><div class="sidebar-section-children"><a href="LuCI.headers.html">headers</a></div><div class="sidebar-section-children"><a href="LuCI.network.html">network</a></div><div class="sidebar-section-children"><a href="LuCI.network.Device.html">Device</a></div><div class="sidebar-section-children"><a href="LuCI.network.Hosts.html">Hosts</a></div><div class="sidebar-section-children"><a href="LuCI.network.Protocol.html">Protocol</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiDevice.html">WifiDevice</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiNetwork.html">WifiNetwork</a></div><div class="sidebar-section-children"><a href="LuCI.network.WifiVlan.html">WifiVlan</a></div><div class="sidebar-section-children"><a href="LuCI.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.request.html">request</a></div><div class="sidebar-section-children"><a href="LuCI.request.poll.html">poll</a></div><div class="sidebar-section-children"><a href="LuCI.response.html">response</a></div><div class="sidebar-section-children"><a href="LuCI.rpc.html">rpc</a></div><div class="sidebar-section-children"><a href="LuCI.session.html">session</a></div><div class="sidebar-section-children"><a href="LuCI.uci.html">uci</a></div><div class="sidebar-section-children"><a href="LuCI.ui.html">ui</a></div><div class="sidebar-section-children"><a href="LuCI.ui.AbstractElement.html">AbstractElement</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Checkbox.html">Checkbox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.ComboButton.html">ComboButton</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Combobox.html">Combobox</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Dropdown.html">Dropdown</a></div><div class="sidebar-section-children"><a href="LuCI.ui.DynamicList.html">DynamicList</a></div><div class="sidebar-section-children"><a href="LuCI.ui.FileUpload.html">FileUpload</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Hiddenfield.html">Hiddenfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.RangeSlider.html">RangeSlider</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Select.html">Select</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textarea.html">Textarea</a></div><div class="sidebar-section-children"><a href="LuCI.ui.Textfield.html">Textfield</a></div><div class="sidebar-section-children"><a href="LuCI.ui.changes.html">changes</a></div><div class="sidebar-section-children"><a href="LuCI.ui.menu.html">menu</a></div><div class="sidebar-section-children"><a href="LuCI.ui.tabs.html">tabs</a></div><div class="sidebar-section-children"><a href="LuCI.validation.html">validation</a></div><div class="sidebar-section-children"><a href="LuCI.validation.Validator.html">Validator</a></div><div class="sidebar-section-children"><a href="LuCI.validation.ValidatorFactory.html">ValidatorFactory</a></div><div class="sidebar-section-children"><a href="LuCI.view.html">view</a></div><div class="sidebar-section-children"><a href="LuCI.xhr.html">xhr</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-String.html">String</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html> |