mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 19:01:56 +00:00
446 lines
35 KiB
HTML
446 lines
35 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: fs.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">fs.js</h1></header><article><pre class="prettyprint source lang-js"><code>'use strict';
|
|
'require rpc';
|
|
'require request';
|
|
'require baseclass';
|
|
|
|
/**
|
|
* @typedef {Object} FileStatEntry
|
|
* @memberof LuCI.fs
|
|
*
|
|
* @property {string} name - Name of the directory entry
|
|
* @property {string} type - Type of the entry, one of `block`, `char`, `directory`, `fifo`, `symlink`, `file`, `socket` or `unknown`
|
|
* @property {number} size - Size in bytes
|
|
* @property {number} mode - Access permissions
|
|
* @property {number} atime - Last access time in seconds since epoch
|
|
* @property {number} mtime - Last modification time in seconds since epoch
|
|
* @property {number} ctime - Last change time in seconds since epoch
|
|
* @property {number} inode - Inode number
|
|
* @property {number} uid - Numeric owner id
|
|
* @property {number} gid - Numeric group id
|
|
*/
|
|
|
|
/**
|
|
* @typedef {Object} FileExecResult
|
|
* @memberof LuCI.fs
|
|
*
|
|
* @property {number} code - The exit code of the invoked command
|
|
* @property {string} [stdout] - The stdout produced by the command, if any
|
|
* @property {string} [stderr] - The stderr produced by the command, if any
|
|
*/
|
|
|
|
const callFileList = rpc.declare({
|
|
object: 'file',
|
|
method: 'list',
|
|
params: [ 'path' ]
|
|
});
|
|
|
|
const callFileStat = rpc.declare({
|
|
object: 'file',
|
|
method: 'stat',
|
|
params: [ 'path' ]
|
|
});
|
|
|
|
const callFileRead = rpc.declare({
|
|
object: 'file',
|
|
method: 'read',
|
|
params: [ 'path' ]
|
|
});
|
|
|
|
const callFileWrite = rpc.declare({
|
|
object: 'file',
|
|
method: 'write',
|
|
params: [ 'path', 'data', 'mode' ]
|
|
});
|
|
|
|
const callFileRemove = rpc.declare({
|
|
object: 'file',
|
|
method: 'remove',
|
|
params: [ 'path' ]
|
|
});
|
|
|
|
const callFileExec = rpc.declare({
|
|
object: 'file',
|
|
method: 'exec',
|
|
params: [ 'command', 'params', 'env' ]
|
|
});
|
|
|
|
const rpcErrors = [
|
|
null,
|
|
'InvalidCommandError',
|
|
'InvalidArgumentError',
|
|
'MethodNotFoundError',
|
|
'NotFoundError',
|
|
'NoDataError',
|
|
'PermissionError',
|
|
'TimeoutError',
|
|
'UnsupportedError'
|
|
];
|
|
|
|
/**
|
|
* Handle an RPC reply.
|
|
* @param {object} expect
|
|
* @param {number} rc
|
|
* @throws {Error}
|
|
* @returns {number}
|
|
*/
|
|
function handleRpcReply(expect, rc) {
|
|
if (typeof(rc) == 'number' && rc != 0) {
|
|
let e = new Error(rpc.getStatusText(rc)); e.name = rpcErrors[rc] || 'Error';
|
|
throw e;
|
|
}
|
|
|
|
if (expect) {
|
|
const type = Object.prototype.toString;
|
|
|
|
for (let key in expect) {
|
|
if (rc != null && key != '')
|
|
rc = rc[key];
|
|
|
|
if (rc == null || type.call(rc) != type.call(expect[key])) {
|
|
let e = new Error(_('Unexpected reply data format')); e.name = 'TypeError';
|
|
throw e;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* Handle a CGI-IO reply.
|
|
* @param {object} res
|
|
* @throws {Error}
|
|
* @returns {string}
|
|
*/
|
|
function handleCgiIoReply(res) {
|
|
if (!res.ok || res.status != 200) {
|
|
var e = new Error(res.statusText);
|
|
switch (res.status) {
|
|
case 400:
|
|
e.name = 'InvalidArgumentError';
|
|
break;
|
|
|
|
case 403:
|
|
e.name = 'PermissionError';
|
|
break;
|
|
|
|
case 404:
|
|
e.name = 'NotFoundError';
|
|
break;
|
|
|
|
default:
|
|
e.name = 'Error';
|
|
}
|
|
throw e;
|
|
}
|
|
|
|
switch (this.type) {
|
|
case 'blob':
|
|
return res.blob();
|
|
|
|
case 'json':
|
|
return res.json();
|
|
|
|
default:
|
|
return res.text();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @class fs
|
|
* @memberof LuCI
|
|
* @hideconstructor
|
|
* @classdesc
|
|
*
|
|
* Provides high level utilities to wrap file system related RPC calls.
|
|
* To import the class in views, use `'require fs'`, to import it in
|
|
* external JavaScript, use `L.require("fs").then(...)`.
|
|
*/
|
|
var FileSystem = baseclass.extend(/** @lends LuCI.fs.prototype */ {
|
|
/**
|
|
* Obtains a listing of the specified directory.
|
|
*
|
|
* @param {string} path
|
|
* The directory path to list.
|
|
*
|
|
* @returns {Promise<LuCI.fs.FileStatEntry[]>}
|
|
* Returns a promise resolving to an array of stat detail objects or
|
|
* rejecting with an error stating the failure reason.
|
|
*/
|
|
list(path) {
|
|
return callFileList(path).then(handleRpcReply.bind(this, { entries: [] }));
|
|
},
|
|
|
|
/**
|
|
* Return file stat information on the specified path.
|
|
*
|
|
* @param {string} path
|
|
* The filesystem path to stat.
|
|
*
|
|
* @returns {Promise<LuCI.fs.FileStatEntry>}
|
|
* Returns a promise resolving to a stat detail object or
|
|
* rejecting with an error stating the failure reason.
|
|
*/
|
|
stat(path) {
|
|
return callFileStat(path).then(handleRpcReply.bind(this, { '': {} }));
|
|
},
|
|
|
|
/**
|
|
* Read the contents of the given file and return them.
|
|
* Note: this function is unsuitable for obtaining binary data.
|
|
*
|
|
* @param {string} path
|
|
* The file path to read.
|
|
*
|
|
* @returns {Promise<string>}
|
|
* Returns a promise resolving to a string containing the file contents or
|
|
* rejecting with an error stating the failure reason.
|
|
*/
|
|
read(path) {
|
|
return callFileRead(path).then(handleRpcReply.bind(this, { data: '' }));
|
|
},
|
|
|
|
/**
|
|
* Write the given data to the specified file path.
|
|
* If the specified file path does not exist, it will be created, given
|
|
* sufficient permissions.
|
|
*
|
|
* Note: `data` will be converted to a string using `String(data)` or to
|
|
* `''` when it is `null`.
|
|
*
|
|
* @param {string} path
|
|
* The file path to write to.
|
|
*
|
|
* @param {*} [data]
|
|
* The file data to write. If it is null, it will be set to an empty
|
|
* string.
|
|
*
|
|
* @param {number} [mode]
|
|
* The permissions to use on file creation. Default is 420 (0644).
|
|
*
|
|
* @returns {Promise<number>}
|
|
* Returns a promise resolving to `0` or rejecting with an error stating
|
|
* the failure reason.
|
|
*/
|
|
write(path, data, mode) {
|
|
data = (data != null) ? String(data) : '';
|
|
mode = (mode != null) ? mode : 420; // 0644
|
|
return callFileWrite(path, data, mode).then(handleRpcReply.bind(this, { '': 0 }));
|
|
},
|
|
|
|
/**
|
|
* Unlink the given file.
|
|
*
|
|
* @param {string} path
|
|
* The file path to remove.
|
|
*
|
|
* @returns {Promise<number>}
|
|
* Returns a promise resolving to `0` or rejecting with an error stating
|
|
* the failure reason.
|
|
*/
|
|
remove(path) {
|
|
return callFileRemove(path).then(handleRpcReply.bind(this, { '': 0 }));
|
|
},
|
|
|
|
/**
|
|
* Execute the specified command, optionally passing params and
|
|
* environment variables.
|
|
*
|
|
* Note: The `command` must be either the path to an executable,
|
|
* or a basename without arguments in which case it will be searched
|
|
* in $PATH. If specified, the values given in `params` will be passed
|
|
* as arguments to the command.
|
|
*
|
|
* The key/value pairs in the optional `env` table are translated to
|
|
* `setenv()` calls prior to running the command.
|
|
*
|
|
* @param {string} command
|
|
* The command to invoke.
|
|
*
|
|
* @param {string[]} [params]
|
|
* The arguments to pass to the command.
|
|
*
|
|
* @param {Object.<string, string>} [env]
|
|
* Environment variables to set.
|
|
*
|
|
* @returns {Promise<LuCI.fs.FileExecResult>}
|
|
* Returns a promise resolving to an object describing the execution
|
|
* results or rejecting with an error stating the failure reason.
|
|
*/
|
|
exec(command, params, env) {
|
|
if (!Array.isArray(params))
|
|
params = null;
|
|
|
|
if (!L.isObject(env))
|
|
env = null;
|
|
|
|
return callFileExec(command, params, env).then(handleRpcReply.bind(this, { '': {} }));
|
|
},
|
|
|
|
/**
|
|
* Read the contents of the given file, trim leading and trailing white
|
|
* space and return the trimmed result. In case of errors, return an empty
|
|
* string instead.
|
|
*
|
|
* Note: this function is useful to read single-value files in `/sys`
|
|
* or `/proc`.
|
|
*
|
|
* This function is guaranteed to not reject its promises, on failure,
|
|
* an empty string will be returned.
|
|
*
|
|
* @param {string} path
|
|
* The file path to read.
|
|
*
|
|
* @returns {Promise<string>}
|
|
* Returns a promise resolving to the file contents or the empty string
|
|
* on failure.
|
|
*/
|
|
trimmed(path) {
|
|
return L.resolveDefault(this.read(path), '').then(function(s) {
|
|
return s.trim();
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Read the contents of the given file, split it into lines, trim
|
|
* leading and trailing white space of each line and return the
|
|
* resulting array.
|
|
*
|
|
* This function is guaranteed to not reject its promises, on failure,
|
|
* an empty array will be returned.
|
|
*
|
|
* @param {string} path
|
|
* The file path to read.
|
|
*
|
|
* @returns {Promise<string[]>}
|
|
* Returns a promise resolving to an array containing the stripped lines
|
|
* of the given file or `[]` on failure.
|
|
*/
|
|
lines(path) {
|
|
return L.resolveDefault(this.read(path), '').then(function(s) {
|
|
var lines = [];
|
|
|
|
s = s.trim();
|
|
|
|
if (s != '') {
|
|
var l = s.split(/\n/);
|
|
|
|
for (var i = 0; i < l.length; i++)
|
|
lines.push(l[i].trim());
|
|
}
|
|
|
|
return lines;
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Read the contents of the given file and return them, bypassing ubus.
|
|
*
|
|
* This function will read the requested file through the cgi-io
|
|
* helper applet at `/cgi-bin/cgi-download` which bypasses the ubus rpc
|
|
* transport. This is useful to fetch large file contents which might
|
|
* exceed the ubus message size limits or which contain binary data.
|
|
*
|
|
* The cgi-io helper will enforce the same access permission rules as
|
|
* the ubus based read call.
|
|
*
|
|
* @param {string} path
|
|
* The file path to read.
|
|
*
|
|
* @param {"blob"|"text"|"json"} [type=text]
|
|
* The expected type of read file contents. Valid values are `text` to
|
|
* interpret the contents as string, `json` to parse the contents as JSON
|
|
* or `blob` to return the contents as Blob instance.
|
|
*
|
|
* @returns {Promise<*>}
|
|
* Returns a promise resolving with the file contents interpreted according
|
|
* to the specified type or rejecting with an error stating the failure
|
|
* reason.
|
|
*/
|
|
read_direct(path, type) {
|
|
var postdata = 'sessionid=%s&path=%s'
|
|
.format(encodeURIComponent(L.env.sessionid), encodeURIComponent(path));
|
|
|
|
return request.post(L.env.cgi_base + '/cgi-download', postdata, {
|
|
headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
|
|
responseType: (type == 'blob') ? 'blob' : 'text'
|
|
}).then(handleCgiIoReply.bind({ type: type }));
|
|
},
|
|
|
|
/**
|
|
* Execute the specified command, bypassing ubus.
|
|
*
|
|
* Note: The `command` must be either the path to an executable,
|
|
* or a basename without arguments in which case it will be searched
|
|
* in $PATH. If specified, the values given in `params` will be passed
|
|
* as arguments to the command.
|
|
*
|
|
* This function will invoke the requested commands through the cgi-io
|
|
* helper applet at `/cgi-bin/cgi-exec` which bypasses the ubus rpc
|
|
* transport. This is useful to fetch large command outputs which might
|
|
* exceed the ubus message size limits or which contain binary data.
|
|
*
|
|
* The cgi-io helper will enforce the same access permission rules as
|
|
* the ubus based exec call.
|
|
*
|
|
* @param {string} command
|
|
* The command to invoke.
|
|
*
|
|
* @param {string[]} [params]
|
|
* The arguments to pass to the command.
|
|
*
|
|
* @param {"blob"|"text"|"json"} [type=text]
|
|
* The expected output type of the invoked program. Valid values are
|
|
* `text` to interpret the output as string, `json` to parse the output
|
|
* as JSON or `blob` to return the output as Blob instance.
|
|
*
|
|
* @param {boolean} [latin1=false]
|
|
* Whether to encode the command line as Latin1 instead of UTF-8. This
|
|
* is usually not needed but can be useful for programs that cannot
|
|
* handle UTF-8 input.
|
|
*
|
|
* @param {boolean} [stderr=false]
|
|
* Whether to include stderr output in command output. This is usually
|
|
* not needed but can be useful to execute a command and get full output.
|
|
*
|
|
* @param {function()} [responseProgress=null]
|
|
* An optional request callback function which receives ProgressEvent
|
|
* instances as sole argument during the HTTP response transfer. This is
|
|
* usually not needed but can be useful to receive realtime command
|
|
* output before command exit.
|
|
*
|
|
* @returns {Promise<*>}
|
|
* Returns a promise resolving with the command stdout output interpreted
|
|
* according to the specified type or rejecting with an error stating the
|
|
* failure reason.
|
|
*/
|
|
exec_direct(command, params, type, latin1, stderr, responseProgress) {
|
|
var cmdstr = String(command)
|
|
.replace(/\\/g, '\\\\').replace(/(\s)/g, '\\$1');
|
|
|
|
if (Array.isArray(params))
|
|
for (var i = 0; i < params.length; i++)
|
|
cmdstr += ' ' + String(params[i])
|
|
.replace(/\\/g, '\\\\').replace(/(\s)/g, '\\$1');
|
|
|
|
if (latin1)
|
|
cmdstr = escape(cmdstr).replace(/\+/g, '%2b');
|
|
else
|
|
cmdstr = encodeURIComponent(cmdstr);
|
|
|
|
var postdata = 'sessionid=%s&command=%s&stderr=%d'
|
|
.format(encodeURIComponent(L.env.sessionid), cmdstr, stderr ? 1 : 0);
|
|
|
|
return request.post(L.env.cgi_base + '/cgi-exec', postdata, {
|
|
headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
|
|
responseType: (type == 'blob') ? 'blob' : 'text', responseProgress
|
|
}).then(handleCgiIoReply.bind({ type: type }));
|
|
}
|
|
});
|
|
|
|
return FileSystem;
|
|
</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> |