mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 19:01:56 +00:00
1079 lines
51 KiB
HTML
1079 lines
51 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="themes/luci-theme-bootstrap/htdocs/luci-static/bootstrap/logo.svg"><link type="text/css" rel="stylesheet" href="extra.css"><title>Source: uci.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">uci.js</h1></header><article><pre class="prettyprint source lang-js"><code>'use strict';
|
|
'require rpc';
|
|
'require baseclass';
|
|
|
|
/**
|
|
* Determine whether an object is empty.
|
|
* @param {object} object object to enumerate.
|
|
* @param {string} ignore property to ignore.
|
|
* @returns {boolean}
|
|
*/
|
|
function isEmpty(object, ignore) {
|
|
for (const property in object)
|
|
if (object.hasOwnProperty(property) && property != ignore)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @class uci
|
|
* @memberof LuCI
|
|
* @hideconstructor
|
|
* @classdesc
|
|
*
|
|
* The `LuCI.uci` class utilizes {@link LuCI.rpc} to declare low level
|
|
* remote UCI `ubus` procedures and implements a local caching and data
|
|
* manipulation layer on top to allow for synchronous operations on
|
|
* UCI configuration data.
|
|
*/
|
|
return baseclass.extend(/** @lends LuCI.uci.prototype */ {
|
|
__init__() {
|
|
this.state = {
|
|
newidx: 0,
|
|
values: { },
|
|
creates: { },
|
|
changes: { },
|
|
deletes: { },
|
|
reorder: { }
|
|
};
|
|
|
|
this.loaded = {};
|
|
},
|
|
|
|
callLoad: rpc.declare({
|
|
object: 'uci',
|
|
method: 'get',
|
|
params: [ 'config' ],
|
|
expect: { values: { } },
|
|
reject: true
|
|
}),
|
|
|
|
callOrder: rpc.declare({
|
|
object: 'uci',
|
|
method: 'order',
|
|
params: [ 'config', 'sections' ],
|
|
reject: true
|
|
}),
|
|
|
|
callAdd: rpc.declare({
|
|
object: 'uci',
|
|
method: 'add',
|
|
params: [ 'config', 'type', 'name', 'values' ],
|
|
expect: { section: '' },
|
|
reject: true
|
|
}),
|
|
|
|
callSet: rpc.declare({
|
|
object: 'uci',
|
|
method: 'set',
|
|
params: [ 'config', 'section', 'values' ],
|
|
reject: true
|
|
}),
|
|
|
|
callDelete: rpc.declare({
|
|
object: 'uci',
|
|
method: 'delete',
|
|
params: [ 'config', 'section', 'options' ],
|
|
reject: true
|
|
}),
|
|
|
|
callApply: rpc.declare({
|
|
object: 'uci',
|
|
method: 'apply',
|
|
params: [ 'timeout', 'rollback' ],
|
|
reject: true
|
|
}),
|
|
|
|
callConfirm: rpc.declare({
|
|
object: 'uci',
|
|
method: 'confirm',
|
|
reject: true
|
|
}),
|
|
|
|
|
|
/**
|
|
* Generates a new, unique section ID for the given configuration.
|
|
*
|
|
* Note that the generated ID is temporary, it will get replaced by an
|
|
* identifier in the form `cfgXXXXXX` once the configuration is saved
|
|
* by the remote `ubus` UCI api.
|
|
*
|
|
* @param {string} conf
|
|
* The configuration to generate the new section ID for.
|
|
*
|
|
* @returns {string}
|
|
* A newly generated, unique section ID in the form `newXXXXXX`
|
|
* where `X` denotes a hexadecimal digit.
|
|
*/
|
|
createSID(conf) {
|
|
const v = this.state.values;
|
|
const n = this.state.creates;
|
|
let sid;
|
|
|
|
do {
|
|
sid = "new%06x".format(Math.random() * 0xFFFFFF);
|
|
} while ((n[conf]?.[sid]) || (v[conf]?.[sid]));
|
|
|
|
return sid;
|
|
},
|
|
|
|
/**
|
|
* Resolves a given section ID in extended notation to the internal
|
|
* section ID value.
|
|
*
|
|
* @param {string} conf
|
|
* The configuration to resolve the section ID for.
|
|
*
|
|
* @param {string} sid
|
|
* The section ID to resolve. If the ID is in the form `@typename[#]`,
|
|
* it will get resolved to an internal anonymous ID in the forms
|
|
* `cfgXXXXXX`/`newXXXXXX` or to the name of a section in case it points
|
|
* to a named section. When the given ID is not in extended notation,
|
|
* it will be returned as-is.
|
|
*
|
|
* @returns {string|null}
|
|
* Returns the resolved section ID or the original given ID if it was
|
|
* not in extended notation. Returns `null` when an extended ID could
|
|
* not be resolved to existing section ID.
|
|
*/
|
|
resolveSID(conf, sid) {
|
|
if (typeof(sid) != 'string')
|
|
return sid;
|
|
|
|
const m = /^@([a-zA-Z0-9_-]+)\[(-?[0-9]+)\]$/.exec(sid);
|
|
|
|
if (m) {
|
|
const type = m[1];
|
|
const pos = +m[2];
|
|
const sections = this.sections(conf, type);
|
|
const section = sections[pos >= 0 ? pos : sections.length + pos];
|
|
|
|
return section?.['.name'] ?? null;
|
|
}
|
|
|
|
return sid;
|
|
},
|
|
|
|
/* private */
|
|
reorderSections() {
|
|
const v = this.state.values;
|
|
const n = this.state.creates;
|
|
const d = this.state.deletes;
|
|
const r = this.state.reorder;
|
|
const tasks = [];
|
|
|
|
if (Object.keys(r).length === 0)
|
|
return Promise.resolve();
|
|
|
|
/*
|
|
gather all created and existing sections, sort them according
|
|
to their index value and issue an uci order call
|
|
*/
|
|
for (const c in r) {
|
|
const o = [ ];
|
|
|
|
// skip deletes within re-orders
|
|
if (d[c])
|
|
continue;
|
|
|
|
// push creates
|
|
if (n[c])
|
|
for (const s in n[c])
|
|
o.push(n[c][s]);
|
|
|
|
// push values
|
|
for (const s in v[c])
|
|
o.push(v[c][s]);
|
|
|
|
if (o.length > 0) {
|
|
o.sort((a, b) => a['.index'] - b['.index']);
|
|
|
|
const sids = [ ];
|
|
|
|
for (let i = 0; i < o.length; i++)
|
|
sids.push(o[i]['.name']);
|
|
|
|
tasks.push(this.callOrder(c, sids));
|
|
}
|
|
}
|
|
|
|
this.state.reorder = { };
|
|
return Promise.all(tasks);
|
|
},
|
|
|
|
/* private */
|
|
loadPackage(packageName) {
|
|
if (this.loaded[packageName] == null)
|
|
return (this.loaded[packageName] = this.callLoad(packageName));
|
|
|
|
return Promise.resolve(this.loaded[packageName]);
|
|
},
|
|
|
|
/**
|
|
* Loads the given UCI configurations from the remote `ubus` api.
|
|
*
|
|
* Loaded configurations are cached and only loaded once. Subsequent
|
|
* load operations of the same configurations will return the cached
|
|
* data.
|
|
*
|
|
* To force reloading a configuration, it has to be unloaded with
|
|
* {@link LuCI.uci#unload uci.unload()} first.
|
|
*
|
|
* @param {string|string[]} packages
|
|
* The name of the configuration or an array of configuration
|
|
* names to load.
|
|
*
|
|
* @returns {Promise<string[]>}
|
|
* Returns a promise resolving to the names of the configurations
|
|
* that have been successfully loaded.
|
|
*/
|
|
load(packages) {
|
|
const self = this;
|
|
const pkgs = [ ];
|
|
const tasks = [];
|
|
|
|
if (!Array.isArray(packages))
|
|
packages = [ packages ];
|
|
|
|
for (let i = 0; i < packages.length; i++)
|
|
if (!self.state.values[packages[i]]) {
|
|
pkgs.push(packages[i]);
|
|
tasks.push(self.loadPackage(packages[i]));
|
|
}
|
|
|
|
return Promise.all(tasks).then(responses => {
|
|
for (let i = 0; i < responses.length; i++)
|
|
self.state.values[pkgs[i]] = responses[i];
|
|
|
|
if (responses.length)
|
|
document.dispatchEvent(new CustomEvent('uci-loaded'));
|
|
|
|
return pkgs;
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Unloads the given UCI configurations from the local cache.
|
|
*
|
|
* @param {string|string[]} packages
|
|
* The name of the configuration or an array of configuration
|
|
* names to unload.
|
|
*/
|
|
unload(packages) {
|
|
if (!Array.isArray(packages))
|
|
packages = [ packages ];
|
|
|
|
for (let i = 0; i < packages.length; i++) {
|
|
delete this.state.values[packages[i]];
|
|
delete this.state.creates[packages[i]];
|
|
delete this.state.changes[packages[i]];
|
|
delete this.state.deletes[packages[i]];
|
|
|
|
delete this.loaded[packages[i]];
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Adds a new section of the given type to the given configuration,
|
|
* optionally named according to the given name.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to add the section to.
|
|
*
|
|
* @param {string} type
|
|
* The type of the section to add.
|
|
*
|
|
* @param {string} [name]
|
|
* The name of the section to add. If the name is omitted, an anonymous
|
|
* section will be added instead.
|
|
*
|
|
* @returns {string}
|
|
* Returns the section ID of the newly added section which is equivalent
|
|
* to the given name for non-anonymous sections.
|
|
*/
|
|
add(conf, type, name) {
|
|
const n = this.state.creates;
|
|
const sid = name || this.createSID(conf);
|
|
|
|
n[conf] ??= { };
|
|
n[conf][sid] = {
|
|
'.type': type,
|
|
'.name': sid,
|
|
'.create': name,
|
|
'.anonymous': !name,
|
|
'.index': 1000 + this.state.newidx++
|
|
};
|
|
|
|
return sid;
|
|
},
|
|
|
|
/**
|
|
* Clones an existing section of the given type to the given configuration,
|
|
* optionally named according to the given name.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration into which to clone the section.
|
|
*
|
|
* @param {string} type
|
|
* The type of the section to clone.
|
|
*
|
|
* @param {string} srcsid
|
|
* The source section id to clone.
|
|
*
|
|
* @param {boolean} [put_next]
|
|
* Whether to put the cloned item next (true) or last (false: default).
|
|
*
|
|
* @param {string} [name]
|
|
* The name of the new cloned section. If the name is omitted, an anonymous
|
|
* section will be created instead.
|
|
*
|
|
* @returns {string}
|
|
* Returns the section ID of the newly cloned section which is equivalent
|
|
* to the given name for non-anonymous sections.
|
|
*/
|
|
clone(conf, type, srcsid, put_next, name) {
|
|
let n = this.state.creates;
|
|
let sid = this.createSID(conf);
|
|
let v = this.state.values;
|
|
put_next = put_next || false;
|
|
|
|
if (!n[conf])
|
|
n[conf] = { };
|
|
|
|
n[conf][sid] = {
|
|
...v[conf][srcsid],
|
|
'.type': type,
|
|
'.name': sid,
|
|
'.create': name,
|
|
'.anonymous': !name,
|
|
'.index': 1000 + this.state.newidx++
|
|
};
|
|
|
|
if (put_next)
|
|
this.move(conf, sid, srcsid, put_next);
|
|
return sid;
|
|
},
|
|
|
|
/**
|
|
* Removes the section with the given ID from the given configuration.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to remove the section from.
|
|
*
|
|
* @param {string} sid
|
|
* The ID of the section to remove.
|
|
*/
|
|
remove(conf, sid) {
|
|
const v = this.state.values;
|
|
const n = this.state.creates;
|
|
const c = this.state.changes;
|
|
const d = this.state.deletes;
|
|
|
|
/* requested deletion of a just created section */
|
|
if (n[conf]?.[sid]) {
|
|
delete n[conf][sid];
|
|
}
|
|
else if (v[conf]?.[sid]) {
|
|
delete c[conf]?.[sid];
|
|
|
|
d[conf] ??= { };
|
|
d[conf][sid] = true;
|
|
}
|
|
},
|
|
|
|
/* eslint-disable jsdoc/check-property-names */
|
|
/**
|
|
* A section object represents the options and their corresponding values
|
|
* enclosed within a configuration section, as well as some additional
|
|
* meta data such as sort indexes and internal ID.
|
|
*
|
|
* Any internal metadata fields are prefixed with a dot which isn't
|
|
* an allowed character for normal option names.
|
|
*
|
|
* @typedef {Object<string, boolean|number|string|string[]>} SectionObject
|
|
* @memberof LuCI.uci
|
|
*
|
|
* @property {boolean} ".anonymous"
|
|
* The `.anonymous` property specifies whether the configuration is
|
|
* anonymous (`true`) or named (`false`).
|
|
*
|
|
* @property {number} ".index"
|
|
* The `.index` property specifies the sort order of the section.
|
|
*
|
|
* @property {string} ".name"
|
|
* The `.name` property holds the name of the section object. It may be
|
|
* either an anonymous ID in the form `cfgXXXXXX` or `newXXXXXX` with `X`
|
|
* being a hexadecimal digit or a string holding the name of the section.
|
|
*
|
|
* @property {string} ".type"
|
|
* The `.type` property contains the type of the corresponding uci
|
|
* section.
|
|
*
|
|
* @property {string|string[]} *
|
|
* A section object may contain an arbitrary number of further properties
|
|
* representing the uci option enclosed in the section.
|
|
*
|
|
* All option property names will be in the form `[A-Za-z0-9_]+` and
|
|
* either contain a string value or an array of strings, in case the
|
|
* underlying option is an UCI list.
|
|
*/
|
|
/* eslint-enable jsdoc/check-property-names */
|
|
|
|
/**
|
|
* The sections callback is invoked for each section found within
|
|
* the given configuration and receives the section object and its
|
|
* associated name as arguments.
|
|
*
|
|
* @callback LuCI.uci.sections
|
|
*
|
|
* @param {LuCI.uci.SectionObject} section
|
|
* The section object.
|
|
*
|
|
* @param {string} sid
|
|
* The name or ID of the section.
|
|
*/
|
|
|
|
/**
|
|
* Enumerates the sections of the given configuration, optionally
|
|
* filtered by type.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to enumerate the sections for.
|
|
*
|
|
* @param {string} [type]
|
|
* Enumerate only sections of the given type. If omitted, enumerate
|
|
* all sections.
|
|
*
|
|
* @param {LuCI.uci.sections} [cb]
|
|
* An optional callback to invoke for each enumerated section.
|
|
*
|
|
* @returns {Array<LuCI.uci.SectionObject>}
|
|
* Returns a sorted array of the section objects within the given
|
|
* configuration, filtered by type, if a type has been specified.
|
|
*/
|
|
sections(conf, type, cb) {
|
|
const sa = [ ];
|
|
const v = this.state.values[conf];
|
|
const n = this.state.creates[conf];
|
|
const c = this.state.changes[conf];
|
|
const d = this.state.deletes[conf];
|
|
|
|
if (!v)
|
|
return sa;
|
|
|
|
for (const s in v)
|
|
if (!d || d[s] !== true)
|
|
if (!type || v[s]['.type'] == type)
|
|
sa.push(Object.assign({ }, v[s], c ? c[s] : null));
|
|
|
|
if (n)
|
|
for (const s in n)
|
|
if (!type || n[s]['.type'] == type)
|
|
sa.push(Object.assign({ }, n[s]));
|
|
|
|
sa.sort((a, b) => {
|
|
return a['.index'] - b['.index'];
|
|
});
|
|
|
|
for (let i = 0; i < sa.length; i++)
|
|
sa[i]['.index'] = i;
|
|
|
|
if (typeof(cb) == 'function')
|
|
for (let i = 0; i < sa.length; i++)
|
|
cb.call(this, sa[i], sa[i]['.name']);
|
|
|
|
return sa;
|
|
},
|
|
|
|
/**
|
|
* Gets the value of the given option within the specified section
|
|
* of the given configuration or the entire section object if the
|
|
* option name is omitted.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to read the value from.
|
|
*
|
|
* @param {string} sid
|
|
* The name or ID of the section to read.
|
|
*
|
|
* @param {string} [opt]
|
|
* The option name to read the value from. If the option name is
|
|
* omitted or `null`, the entire section is returned instead.
|
|
*
|
|
* @returns {null|string|string[]|LuCI.uci.SectionObject}
|
|
* - Returns a string containing the option value in case of a
|
|
* plain UCI option.
|
|
* - Returns an array of strings containing the option values in
|
|
* case of `option` pointing to an UCI list.
|
|
* - Returns a {@link LuCI.uci.SectionObject section object} if
|
|
* the `option` argument has been omitted or is `null`.
|
|
* - Returns `null` if the config, section or option has not been
|
|
* found or if the corresponding configuration is not loaded.
|
|
*/
|
|
get(conf, sid, opt) {
|
|
const v = this.state.values;
|
|
const n = this.state.creates;
|
|
const c = this.state.changes;
|
|
const d = this.state.deletes;
|
|
|
|
sid = this.resolveSID(conf, sid);
|
|
|
|
if (sid == null)
|
|
return null;
|
|
|
|
/* requested option in a just created section */
|
|
if (n[conf]?.[sid]) {
|
|
if (opt == null)
|
|
return n[conf][sid];
|
|
|
|
return n[conf][sid][opt];
|
|
}
|
|
|
|
/* requested an option value */
|
|
if (opt != null) {
|
|
/* check whether option was deleted */
|
|
if (d[conf]?.[sid])
|
|
if (d[conf][sid] === true || d[conf][sid][opt])
|
|
return null;
|
|
|
|
/* check whether option was changed */
|
|
if (c[conf]?.[sid]?.[opt] != null)
|
|
return c[conf][sid][opt];
|
|
|
|
/* return base value */
|
|
if (v[conf]?.[sid])
|
|
return v[conf][sid][opt];
|
|
|
|
return null;
|
|
}
|
|
|
|
/* requested an entire section */
|
|
if (v[conf]) {
|
|
/* check whether entire section was deleted */
|
|
if (d[conf]?.[sid] === true)
|
|
return null;
|
|
|
|
const s = v[conf][sid] || null;
|
|
|
|
if (s) {
|
|
/* merge changes */
|
|
if (c[conf]?.[sid])
|
|
for (const opt in c[conf][sid])
|
|
if (c[conf][sid][opt] != null)
|
|
s[opt] = c[conf][sid][opt];
|
|
|
|
/* merge deletions */
|
|
if (d[conf]?.[sid])
|
|
for (const opt in d[conf][sid])
|
|
delete s[opt];
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Sets the value of the given option within the specified section
|
|
* of the given configuration.
|
|
*
|
|
* If either config, section or option is null, or if `option` begins
|
|
* with a dot, the function will do nothing.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to set the option value in.
|
|
*
|
|
* @param {string} sid
|
|
* The name or ID of the section to set the option value in.
|
|
*
|
|
* @param {string} opt
|
|
* The option name to set the value for.
|
|
*
|
|
* @param {null|string|string[]} val
|
|
* The option value to set. If the value is `null` or an empty string,
|
|
* the option will be removed, otherwise it will be set or overwritten
|
|
* with the given value.
|
|
*/
|
|
set(conf, sid, opt, val) {
|
|
const v = this.state.values;
|
|
const n = this.state.creates;
|
|
const c = this.state.changes;
|
|
const d = this.state.deletes;
|
|
|
|
sid = this.resolveSID(conf, sid);
|
|
|
|
if (sid == null || opt == null || opt.charAt(0) == '.')
|
|
return;
|
|
|
|
if (n[conf]?.[sid]) {
|
|
if (val != null)
|
|
n[conf][sid][opt] = val;
|
|
else
|
|
delete n[conf][sid][opt];
|
|
}
|
|
else if (val != null && val !== '') {
|
|
/* do not set within deleted section */
|
|
if (d[conf] && d[conf][sid] === true)
|
|
return;
|
|
|
|
/* only set in existing sections */
|
|
if (!v[conf]?.[sid])
|
|
return;
|
|
|
|
c[conf] ??= {};
|
|
c[conf][sid] ??= {};
|
|
|
|
/* undelete option */
|
|
if (d[conf]?.[sid]) {
|
|
if (isEmpty(d[conf][sid], opt))
|
|
delete d[conf][sid];
|
|
else
|
|
delete d[conf][sid][opt];
|
|
}
|
|
|
|
c[conf][sid][opt] = val;
|
|
}
|
|
else {
|
|
/* revert any change for to-be-deleted option */
|
|
if (c[conf]?.[sid]) {
|
|
if (isEmpty(c[conf][sid], opt))
|
|
delete c[conf][sid];
|
|
else
|
|
delete c[conf][sid][opt];
|
|
}
|
|
|
|
/* only delete existing options */
|
|
if (v[conf]?.[sid]?.hasOwnProperty(opt)) {
|
|
d[conf] ??= { };
|
|
d[conf][sid] ??= { };
|
|
|
|
if (d[conf][sid] !== true)
|
|
d[conf][sid][opt] = true;
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Remove the given option within the specified section of the given
|
|
* configuration.
|
|
*
|
|
* This function is a convenience wrapper around
|
|
* `uci.set(config, section, option, null)`.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to remove the option from.
|
|
*
|
|
* @param {string} sid
|
|
* The name or ID of the section to remove the option from.
|
|
*
|
|
* @param {string} opt
|
|
* The name of the option to remove.
|
|
* @returns {null}
|
|
*/
|
|
unset(conf, sid, opt) {
|
|
return this.set(conf, sid, opt, null);
|
|
},
|
|
|
|
/**
|
|
* Gets the value of the given option or the entire section object of
|
|
* the first found section of the specified type or the first found
|
|
* section of the entire configuration if no type is specified.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to read the value from.
|
|
*
|
|
* @param {string} [type]
|
|
* The type of the first section to find. If it is `null`, the first
|
|
* section of the entire config is read, otherwise the first section
|
|
* matching the given type.
|
|
*
|
|
* @param {string} [opt]
|
|
* The option name to read the value from. If the option name is
|
|
* omitted or `null`, the entire section is returned instead.
|
|
*
|
|
* @returns {null|string|string[]|LuCI.uci.SectionObject}
|
|
* - Returns a string containing the option value in case of a
|
|
* plain UCI option.
|
|
* - Returns an array of strings containing the option values in
|
|
* case of `option` pointing to an UCI list.
|
|
* - Returns a {@link LuCI.uci.SectionObject section object} if
|
|
* the `option` argument has been omitted or is `null`.
|
|
* - Returns `null` if the config, section or option has not been
|
|
* found or if the corresponding configuration is not loaded.
|
|
*/
|
|
get_first(conf, type, opt) {
|
|
let sid = null;
|
|
|
|
this.sections(conf, type, s => {
|
|
sid ??= s['.name'];
|
|
});
|
|
|
|
return this.get(conf, sid, opt);
|
|
},
|
|
|
|
/**
|
|
* A special case of `get` that always returns either `true` or
|
|
* `false`.
|
|
*
|
|
* Many configuration files contain boolean settings, such as
|
|
* `enabled` or `advanced_mode`, where there is no consistent
|
|
* definition for the values. This function allows users to
|
|
* enter any of the values `"yes"`, `"on"`, `"true"`, `"enabled"`
|
|
* or `1` in their config files and we return the expected boolean
|
|
* result.
|
|
*
|
|
* Character case is not significant, so for example, any of
|
|
* "YES", "Yes" or "yes" will be interpreted as a `true` value.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to read.
|
|
*
|
|
* @param {string} type
|
|
* The section type to read.
|
|
*
|
|
* @param {string} [opt]
|
|
* The option name from which to read the value. If the option
|
|
* name is omitted or `null`, the value `false` is returned.
|
|
*
|
|
* @returns {boolean}
|
|
* - Returns boolean `true` if the configuration value is defined
|
|
* and looks like a true value, otherwise returns `false`.
|
|
*
|
|
* See the
|
|
* {@link https://openwrt.org/docs/guide-developer/config-scripting#reading_booleans|Developers Guide}
|
|
* for more.
|
|
*/
|
|
get_bool(conf, type, opt) {
|
|
let value = this.get(conf, type, opt);
|
|
if (typeof(value) == 'string')
|
|
return ['1', 'on', 'true', 'yes', 'enabled'].includes(value.toLowerCase());
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Sets the value of the given option within the first found section
|
|
* of the given configuration matching the specified type or within
|
|
* the first section of the entire config when no type has is specified.
|
|
*
|
|
* If either config, type or option is null, or if `option` begins
|
|
* with a dot, the function will do nothing.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to set the option value in.
|
|
*
|
|
* @param {string} [type]
|
|
* The type of the first section to find. If it is `null`, the first
|
|
* section of the entire config is written to, otherwise the first
|
|
* section matching the given type is used.
|
|
*
|
|
* @param {string} opt
|
|
* The option name to set the value for.
|
|
*
|
|
* @param {null|string|string[]} val
|
|
* The option value to set. If the value is `null` or an empty string,
|
|
* the option will be removed, otherwise it will be set or overwritten
|
|
* with the given value.
|
|
* @returns {null}
|
|
*/
|
|
set_first(conf, type, opt, val) {
|
|
let sid = null;
|
|
|
|
this.sections(conf, type, s => {
|
|
sid ??= s['.name'];
|
|
});
|
|
|
|
return this.set(conf, sid, opt, val);
|
|
},
|
|
|
|
/**
|
|
* Removes the given option within the first found section of the given
|
|
* configuration matching the specified type or within the first section
|
|
* of the entire config when no type has is specified.
|
|
*
|
|
* This function is a convenience wrapper around
|
|
* `uci.set_first(config, type, option, null)`.
|
|
*
|
|
* @param {string} conf
|
|
* The name of the configuration to set the option value in.
|
|
*
|
|
* @param {string} [type]
|
|
* The type of the first section to find. If it is `null`, the first
|
|
* section of the entire config is written to, otherwise the first
|
|
* section matching the given type is used.
|
|
*
|
|
* @param {string} opt
|
|
* The option name to set the value for.
|
|
*
|
|
* @returns {null}
|
|
*/
|
|
unset_first(conf, type, opt) {
|
|
return this.set_first(conf, type, opt, null);
|
|
},
|
|
|
|
/**
|
|
* Move the first specified section within the given configuration
|
|
* before or after the second specified section.
|
|
*
|
|
* @param {string} conf
|
|
* The configuration to move the section within.
|
|
*
|
|
* @param {string} sid1
|
|
* The ID of the section to move within the configuration.
|
|
*
|
|
* @param {string} [sid2]
|
|
* The ID of the target section for the move operation. If the
|
|
* `after` argument is `false` or not specified, the section named by
|
|
* `sid1` will be moved before this target section, if the `after`
|
|
* argument is `true`, the `sid1` section will be moved after this
|
|
* section.
|
|
*
|
|
* When the `sid2` argument is `null`, the section specified by `sid1`
|
|
* is moved to the end of the configuration.
|
|
*
|
|
* @param {boolean} [after=false]
|
|
* When `true`, the section `sid1` is moved after the section `sid2`,
|
|
* when `false`, the section `sid1` is moved before `sid2`.
|
|
*
|
|
* If `sid2` is null, then this parameter has no effect and the section
|
|
* `sid1` is moved to the end of the configuration instead.
|
|
*
|
|
* @returns {boolean}
|
|
* Returns `true` when the section was successfully moved, or `false`
|
|
* when either the section specified by `sid1` or by `sid2` is not found.
|
|
*/
|
|
move(conf, sid1, sid2, after) {
|
|
const sa = this.sections(conf);
|
|
let s1 = null;
|
|
let s2 = null;
|
|
|
|
sid1 = this.resolveSID(conf, sid1);
|
|
sid2 = this.resolveSID(conf, sid2);
|
|
|
|
for (let i = 0; i < sa.length; i++) {
|
|
if (sa[i]['.name'] != sid1)
|
|
continue;
|
|
|
|
s1 = sa[i];
|
|
sa.splice(i, 1);
|
|
break;
|
|
}
|
|
|
|
if (s1 == null)
|
|
return false;
|
|
|
|
if (sid2 == null) {
|
|
sa.push(s1);
|
|
}
|
|
else {
|
|
for (let i = 0; i < sa.length; i++) {
|
|
if (sa[i]['.name'] != sid2)
|
|
continue;
|
|
|
|
s2 = sa[i];
|
|
sa.splice(i + !!after, 0, s1);
|
|
break;
|
|
}
|
|
|
|
if (s2 == null)
|
|
return false;
|
|
}
|
|
|
|
for (let i = 0; i < sa.length; i++)
|
|
this.get(conf, sa[i]['.name'])['.index'] = i;
|
|
|
|
if (this.state)
|
|
this.state.reorder[conf] = true;
|
|
|
|
return true;
|
|
},
|
|
|
|
/**
|
|
* Submits all local configuration changes to the remove `ubus` api,
|
|
* adds, removes and reorders remote sections as needed and reloads
|
|
* all loaded configurations to resynchronize the local state with
|
|
* the remote configuration values.
|
|
*
|
|
* @returns {string[]}
|
|
* Returns a promise resolving to an array of configuration names which
|
|
* have been reloaded by the save operation.
|
|
*/
|
|
save() {
|
|
const n = this.state.creates;
|
|
const c = this.state.changes;
|
|
const d = this.state.deletes;
|
|
const r = this.state.reorder;
|
|
const self = this;
|
|
const snew = [ ];
|
|
let pkgs = { };
|
|
const tasks = [];
|
|
|
|
if (d)
|
|
for (const conf in d) {
|
|
for (const sid in d[conf]) {
|
|
const o = d[conf][sid];
|
|
|
|
if (o === true)
|
|
tasks.push(self.callDelete(conf, sid, null));
|
|
else
|
|
tasks.push(self.callDelete(conf, sid, Object.keys(o)));
|
|
}
|
|
|
|
pkgs[conf] = true;
|
|
}
|
|
|
|
if (n)
|
|
for (const conf in n) {
|
|
for (const sid in n[conf]) {
|
|
const p = {
|
|
config: conf,
|
|
values: { }
|
|
};
|
|
|
|
for (const k in n[conf][sid]) {
|
|
if (k == '.type')
|
|
p.type = n[conf][sid][k];
|
|
else if (k == '.create')
|
|
p.name = n[conf][sid][k];
|
|
else if (k.charAt(0) != '.')
|
|
p.values[k] = n[conf][sid][k];
|
|
}
|
|
|
|
snew.push(n[conf][sid]);
|
|
tasks.push(self.callAdd(p.config, p.type, p.name, p.values));
|
|
}
|
|
|
|
pkgs[conf] = true;
|
|
}
|
|
|
|
if (c)
|
|
for (const conf in c) {
|
|
for (const sid in c[conf])
|
|
tasks.push(self.callSet(conf, sid, c[conf][sid]));
|
|
|
|
pkgs[conf] = true;
|
|
}
|
|
|
|
if (r)
|
|
for (const conf in r)
|
|
pkgs[conf] = true;
|
|
|
|
return Promise.all(tasks).then(responses => {
|
|
/*
|
|
array "snew" holds references to the created uci sections,
|
|
use it to assign the returned names of the new sections
|
|
*/
|
|
for (let i = 0; i < snew.length; i++)
|
|
snew[i]['.name'] = responses[i];
|
|
|
|
return self.reorderSections();
|
|
}).then(() => {
|
|
pkgs = Object.keys(pkgs);
|
|
|
|
self.unload(pkgs);
|
|
|
|
return self.load(pkgs);
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Instructs the remote `ubus` UCI api to commit all saved changes with
|
|
* rollback protection and attempts to confirm the pending commit
|
|
* operation to cancel the rollback timer.
|
|
*
|
|
* @param {number} [timeout=10]
|
|
* Override the confirmation timeout after which a rollback is triggered.
|
|
*
|
|
* @returns {Promise<number>}
|
|
* Returns a promise resolving/rejecting with the `ubus` RPC status code.
|
|
*/
|
|
apply(timeout) {
|
|
const self = this;
|
|
const date = new Date();
|
|
|
|
if (typeof(timeout) != 'number' || timeout < 1)
|
|
timeout = 10;
|
|
|
|
return self.callApply(timeout, true).then(rv => {
|
|
if (rv != 0)
|
|
return Promise.reject(rv);
|
|
|
|
const try_deadline = date.getTime() + 1000 * timeout;
|
|
const try_confirm = () => {
|
|
return self.callConfirm().then(rv => {
|
|
if (rv != 0) {
|
|
if (date.getTime() < try_deadline)
|
|
window.setTimeout(try_confirm, 250);
|
|
else
|
|
return Promise.reject(rv);
|
|
}
|
|
|
|
return rv;
|
|
});
|
|
};
|
|
|
|
window.setTimeout(try_confirm, 1000);
|
|
});
|
|
},
|
|
|
|
/**
|
|
* An UCI change record is a plain array containing the change operation
|
|
* name as first element, the affected section ID as second argument
|
|
* and an optional third and fourth argument whose meanings depend on
|
|
* the operation.
|
|
*
|
|
* @typedef {string[]} ChangeRecord
|
|
* @memberof LuCI.uci
|
|
*
|
|
* @property {string} operation
|
|
* The operation name - may be one of `add`, `set`, `remove`, `order`,
|
|
* `list-add`, `list-del` or `rename`.
|
|
*
|
|
* @property {string} section_id
|
|
* The section ID targeted by the operation.
|
|
*
|
|
* @property {string} parameter
|
|
* The meaning of the third element depends on the operation.
|
|
* - For `add` it is type of the section that has been added
|
|
* - For `set` it either is the option name if a fourth element exists,
|
|
* or the type of a named section which has been added when the change
|
|
* entry only contains three elements.
|
|
* - For `remove` it contains the name of the option that has been
|
|
* removed.
|
|
* - For `order` it specifies the new sort index of the section.
|
|
* - For `list-add` it contains the name of the list option a new value
|
|
* has been added to.
|
|
* - For `list-del` it contains the name of the list option a value has
|
|
* been removed from.
|
|
* - For `rename` it contains the name of the option that has been
|
|
* renamed if a fourth element exists, else it contains the new name
|
|
* a section has been renamed to if the change entry only contains
|
|
* three elements.
|
|
*
|
|
* @property {string=} value
|
|
* The meaning of the fourth element depends on the operation.
|
|
* - For `set` it is the value an option has been set to.
|
|
* - For `list-add` it is the new value that has been added to a
|
|
* list option.
|
|
* - For `rename` it is the new name of an option that has been
|
|
* renamed.
|
|
*/
|
|
|
|
/**
|
|
* Fetches uncommitted UCI changes from the remote `ubus` RPC api.
|
|
*
|
|
* @function
|
|
* @returns {Promise<Object<string, Array<LuCI.uci.ChangeRecord>>>}
|
|
* Returns a promise resolving to an object containing the configuration
|
|
* names as keys and arrays of related change records as values.
|
|
*/
|
|
changes: rpc.declare({
|
|
object: 'uci',
|
|
method: 'changes',
|
|
expect: { changes: { } }
|
|
})
|
|
});
|
|
</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> |