5 * This is the LuCI base class. It is automatically instantiated and
6 * accessible using the global `L` variable.
9 * The environment settings to use for the LuCI runtime.
12 (function(window, document, undefined) {
17 /* Object.assign polyfill for IE */
18 if (typeof Object.assign !== 'function') {
19 Object.defineProperty(Object, 'assign', {
20 value: function assign(target, varArgs) {
22 throw new TypeError('Cannot convert undefined or null to object');
24 var to = Object(target);
26 for (var index = 1; index < arguments.length; index++)
27 if (arguments[index] != null)
28 for (var nextKey in arguments[index])
29 if (Object.prototype.hasOwnProperty.call(arguments[index], nextKey))
30 to[nextKey] = arguments[index][nextKey];
39 /* Promise.finally polyfill */
40 if (typeof Promise.prototype.finally !== 'function') {
41 Promise.prototype.finally = function(fn) {
42 var onFinally = function(cb) {
43 return Promise.resolve(fn.call(this)).then(cb);
47 function(result) { return onFinally.call(this, function() { return result }) },
48 function(reason) { return onFinally.call(this, function() { return Promise.reject(reason) }) }
54 * Class declaration and inheritance helper
57 var toCamelCase = function(s) {
58 return s.replace(/(?:^|[\. -])(.)/g, function(m0, m1) { return m1.toUpperCase() });
67 * `LuCI.baseclass` is the abstract base class all LuCI classes inherit from.
69 * It provides simple means to create subclasses of given classes and
70 * implements prototypal inheritance.
72 var superContext = {}, classIndex = 0, Class = Object.assign(function() {}, {
74 * Extends this base class with the properties described in
75 * `properties` and returns a new subclassed Class instance
77 * @memberof LuCI.baseclass
79 * @param {Object<string, *>} properties
80 * An object describing the properties to add to the new
83 * @returns {LuCI.baseclass}
84 * Returns a new LuCI.baseclass sublassed from this class, extended
85 * by the given properties and with its prototype set to this base
86 * class to enable inheritance. The resulting value represents a
87 * class constructor and can be instantiated with `new`.
89 extend: function(properties) {
91 __id__: { value: classIndex },
92 __base__: { value: this.prototype },
93 __name__: { value: properties.__name__ || 'anonymous' + classIndex++ }
96 var ClassConstructor = function() {
97 if (!(this instanceof ClassConstructor))
98 throw new TypeError('Constructor must not be called without "new"');
100 if (Object.getPrototypeOf(this).hasOwnProperty('__init__')) {
101 if (typeof(this.__init__) != 'function')
102 throw new TypeError('Class __init__ member is not a function');
104 this.__init__.apply(this, arguments)
107 this.super('__init__', arguments);
111 for (var key in properties)
112 if (!props[key] && properties.hasOwnProperty(key))
113 props[key] = { value: properties[key], writable: true };
115 ClassConstructor.prototype = Object.create(this.prototype, props);
116 ClassConstructor.prototype.constructor = ClassConstructor;
117 Object.assign(ClassConstructor, this);
118 ClassConstructor.displayName = toCamelCase(props.__name__.value + 'Class');
120 return ClassConstructor;
124 * Extends this base class with the properties described in
125 * `properties`, instantiates the resulting subclass using
126 * the additional optional arguments passed to this function
127 * and returns the resulting subclassed Class instance.
129 * This function serves as a convenience shortcut for
130 * {@link LuCI.baseclass.extend Class.extend()} and subsequent
133 * @memberof LuCI.baseclass
135 * @param {Object<string, *>} properties
136 * An object describing the properties to add to the new
139 * @param {...*} [new_args]
140 * Specifies arguments to be passed to the subclass constructor
141 * as-is in order to instantiate the new subclass.
143 * @returns {LuCI.baseclass}
144 * Returns a new LuCI.baseclass instance extended by the given
145 * properties with its prototype set to this base class to
146 * enable inheritance.
148 singleton: function(properties /*, ... */) {
149 return Class.extend(properties)
150 .instantiate(Class.prototype.varargs(arguments, 1));
154 * Calls the class constructor using `new` with the given argument
155 * array being passed as variadic parameters to the constructor.
157 * @memberof LuCI.baseclass
159 * @param {Array<*>} params
160 * An array of arbitrary values which will be passed as arguments
161 * to the constructor function.
163 * @param {...*} [new_args]
164 * Specifies arguments to be passed to the subclass constructor
165 * as-is in order to instantiate the new subclass.
167 * @returns {LuCI.baseclass}
168 * Returns a new LuCI.baseclass instance extended by the given
169 * properties with its prototype set to this base class to
170 * enable inheritance.
172 instantiate: function(args) {
173 return new (Function.prototype.bind.apply(this,
174 Class.prototype.varargs(args, 0, null)))();
178 call: function(self, method) {
179 if (typeof(this.prototype[method]) != 'function')
180 throw new ReferenceError(method + ' is not defined in class');
182 return this.prototype[method].apply(self, self.varargs(arguments, 1));
186 * Checks whether the given class value is a subclass of this class.
188 * @memberof LuCI.baseclass
190 * @param {LuCI.baseclass} classValue
191 * The class object to test.
194 * Returns `true` when the given `classValue` is a subclass of this
195 * class or `false` if the given value is not a valid class or not
196 * a subclass of this class'.
198 isSubclass: function(classValue) {
199 return (classValue != null &&
200 typeof(classValue) == 'function' &&
201 classValue.prototype instanceof this);
206 * Extract all values from the given argument array beginning from
207 * `offset` and prepend any further given optional parameters to
208 * the beginning of the resulting array copy.
210 * @memberof LuCI.baseclass
213 * @param {Array<*>} args
214 * The array to extract the values from.
216 * @param {number} offset
217 * The offset from which to extract the values. An offset of `0`
218 * would copy all values till the end.
220 * @param {...*} [extra_args]
221 * Extra arguments to add to prepend to the resultung array.
223 * @returns {Array<*>}
224 * Returns a new array consisting of the optional extra arguments
225 * and the values extracted from the `args` array beginning with
228 varargs: function(args, offset /*, ... */) {
229 return Array.prototype.slice.call(arguments, 2)
230 .concat(Array.prototype.slice.call(args, offset));
234 * Walks up the parent class chain and looks for a class member
235 * called `key` in any of the parent classes this class inherits
236 * from. Returns the member value of the superclass or calls the
237 * member as function and returns its return value when the
238 * optional `callArgs` array is given.
240 * This function has two signatures and is sensitive to the
241 * amount of arguments passed to it:
243 * Returns the value of `key` when found within one of the
245 * - `super('key', ['arg1', 'arg2'])` -
246 * Calls the `key()` method with parameters `arg1` and `arg2`
247 * when found within one of the parent classes.
249 * @memberof LuCI.baseclass
252 * @param {string} key
253 * The name of the superclass member to retrieve.
255 * @param {Array<*>} [callArgs]
256 * An optional array of function call parameters to use. When
257 * this parameter is specified, the found member value is called
258 * as function using the values of this array as arguments.
260 * @throws {ReferenceError}
261 * Throws a `ReferenceError` when `callArgs` are specified and
262 * the found member named by `key` is not a function value.
265 * Returns the value of the found member or the return value of
266 * the call to the found method. Returns `null` when no member
267 * was found in the parent class chain or when the call to the
268 * superclass method returned `null`.
270 super: function(key, callArgs) {
274 var slotIdx = this.__id__ + '.' + key,
275 symStack = superContext[slotIdx],
278 for (protoCtx = Object.getPrototypeOf(symStack ? symStack[0] : Object.getPrototypeOf(this));
279 protoCtx != null && !protoCtx.hasOwnProperty(key);
280 protoCtx = Object.getPrototypeOf(protoCtx)) {}
282 if (protoCtx == null)
285 var res = protoCtx[key];
287 if (arguments.length > 1) {
288 if (typeof(res) != 'function')
289 throw new ReferenceError(key + ' is not a function in base class');
291 if (typeof(callArgs) != 'object')
292 callArgs = this.varargs(arguments, 1);
295 symStack.unshift(protoCtx);
297 superContext[slotIdx] = [ protoCtx ];
299 res = res.apply(this, callArgs);
301 if (symStack && symStack.length > 1)
302 symStack.shift(protoCtx);
304 delete superContext[slotIdx];
311 * Returns a string representation of this class.
314 * Returns a string representation of this class containing the
315 * constructor functions `displayName` and describing the class
316 * members and their respective types.
318 toString: function() {
319 var s = '[' + this.constructor.displayName + ']', f = true;
320 for (var k in this) {
321 if (this.hasOwnProperty(k)) {
322 s += (f ? ' {\n' : '') + ' ' + k + ': ' + typeof(this[k]) + '\n';
326 return s + (f ? '' : '}');
338 * The `Headers` class is an internal utility class exposed in HTTP
339 * response objects using the `response.headers` property.
341 var Headers = Class.extend(/** @lends LuCI.headers.prototype */ {
342 __name__: 'LuCI.headers',
343 __init__: function(xhr) {
344 var hdrs = this.headers = {};
345 xhr.getAllResponseHeaders().split(/\r\n/).forEach(function(line) {
346 var m = /^([^:]+):(.*)$/.exec(line);
348 hdrs[m[1].trim().toLowerCase()] = m[2].trim();
353 * Checks whether the given header name is present.
354 * Note: Header-Names are case-insensitive.
357 * @memberof LuCI.headers
358 * @param {string} name
359 * The header name to check
362 * Returns `true` if the header name is present, `false` otherwise
364 has: function(name) {
365 return this.headers.hasOwnProperty(String(name).toLowerCase());
369 * Returns the value of the given header name.
370 * Note: Header-Names are case-insensitive.
373 * @memberof LuCI.headers
374 * @param {string} name
375 * The header name to read
377 * @returns {string|null}
378 * The value of the given header name or `null` if the header isn't present.
380 get: function(name) {
381 var key = String(name).toLowerCase();
382 return this.headers.hasOwnProperty(key) ? this.headers[key] : null;
392 * The `Response` class is an internal utility class representing HTTP responses.
394 var Response = Class.extend({
395 __name__: 'LuCI.response',
396 __init__: function(xhr, url, duration, headers, content) {
398 * Describes whether the response is successful (status codes `200..299`) or not
400 * @memberof LuCI.response
404 this.ok = (xhr.status >= 200 && xhr.status <= 299);
407 * The numeric HTTP status code of the response
409 * @memberof LuCI.response
413 this.status = xhr.status;
416 * The HTTP status description message of the response
418 * @memberof LuCI.response
422 this.statusText = xhr.statusText;
425 * The HTTP headers of the response
427 * @memberof LuCI.response
429 * @type {LuCI.headers}
431 this.headers = (headers != null) ? headers : new Headers(xhr);
434 * The total duration of the HTTP request in milliseconds
436 * @memberof LuCI.response
440 this.duration = duration;
443 * The final URL of the request, i.e. after following redirects.
445 * @memberof LuCI.response
454 if (content instanceof Blob) {
455 this.responseBlob = content;
456 this.responseJSON = null;
457 this.responseText = null;
459 else if (content != null && typeof(content) == 'object') {
460 this.responseBlob = null;
461 this.responseJSON = content;
462 this.responseText = null;
464 else if (content != null) {
465 this.responseBlob = null;
466 this.responseJSON = null;
467 this.responseText = String(content);
470 this.responseJSON = null;
472 if (xhr.responseType == 'blob') {
473 this.responseBlob = xhr.response;
474 this.responseText = null;
477 this.responseBlob = null;
478 this.responseText = xhr.responseText;
484 * Clones the given response object, optionally overriding the content
485 * of the cloned instance.
488 * @memberof LuCI.response
489 * @param {*} [content]
490 * Override the content of the cloned response. Object values will be
491 * treated as JSON response data, all other types will be converted
492 * using `String()` and treated as response text.
494 * @returns {LuCI.response}
495 * The cloned `Response` instance.
497 clone: function(content) {
498 var copy = new Response(this.xhr, this.url, this.duration, this.headers, content);
501 copy.status = this.status;
502 copy.statusText = this.statusText;
508 * Access the response content as JSON data.
511 * @memberof LuCI.response
512 * @throws {SyntaxError}
513 * Throws `SyntaxError` if the content isn't valid JSON.
516 * The parsed JSON data.
519 if (this.responseJSON == null)
520 this.responseJSON = JSON.parse(this.responseText);
522 return this.responseJSON;
526 * Access the response content as string.
529 * @memberof LuCI.response
531 * The response content.
534 if (this.responseText == null && this.responseJSON != null)
535 this.responseText = JSON.stringify(this.responseJSON);
537 return this.responseText;
541 * Access the response content as blob.
544 * @memberof LuCI.response
546 * The response content as blob.
549 return this.responseBlob;
554 var requestQueue = [];
556 function isQueueableRequest(opt) {
560 if (opt.method != 'POST' || typeof(opt.content) != 'object')
563 if (opt.nobatch === true)
566 var rpcBaseURL = Request.expandURL(classes.rpc.getBaseURL());
568 return (rpcBaseURL != null && opt.url.indexOf(rpcBaseURL) == 0);
571 function flushRequestQueue() {
572 if (!requestQueue.length)
575 var reqopt = Object.assign({}, requestQueue[0][0], { content: [], nobatch: true }),
578 for (var i = 0; i < requestQueue.length; i++) {
579 batch[i] = requestQueue[i];
580 reqopt.content[i] = batch[i][0].content;
583 requestQueue.length = 0;
585 Request.request(rpcBaseURL, reqopt).then(function(reply) {
586 var json = null, req = null;
588 try { json = reply.json() }
591 while ((req = batch.shift()) != null)
592 if (Array.isArray(json) && json.length)
593 req[2].call(reqopt, reply.clone(json.shift()));
595 req[1].call(reqopt, new Error('No related RPC reply'));
596 }).catch(function(error) {
599 while ((req = batch.shift()) != null)
600 req[1].call(reqopt, error);
610 * The `Request` class allows initiating HTTP requests and provides utilities
611 * for dealing with responses.
613 var Request = Class.singleton(/** @lends LuCI.request.prototype */ {
614 __name__: 'LuCI.request',
619 * Turn the given relative URL into an absolute URL if necessary.
622 * @memberof LuCI.request
623 * @param {string} url
624 * The URL to convert.
627 * The absolute URL derived from the given one, or the original URL
628 * if it already was absolute.
630 expandURL: function(url) {
631 if (!/^(?:[^/]+:)?\/\//.test(url))
632 url = location.protocol + '//' + location.host + url;
638 * @typedef {Object} RequestOptions
639 * @memberof LuCI.request
641 * @property {string} [method=GET]
642 * The HTTP method to use, e.g. `GET` or `POST`.
644 * @property {Object<string, Object|string>} [query]
645 * Query string data to append to the URL. Non-string values of the
646 * given object will be converted to JSON.
648 * @property {boolean} [cache=false]
649 * Specifies whether the HTTP response may be retrieved from cache.
651 * @property {string} [username]
652 * Provides a username for HTTP basic authentication.
654 * @property {string} [password]
655 * Provides a password for HTTP basic authentication.
657 * @property {number} [timeout]
658 * Specifies the request timeout in seconds.
660 * @property {boolean} [credentials=false]
661 * Whether to include credentials such as cookies in the request.
663 * @property {string} [responseType=text]
664 * Overrides the request response type. Valid values or `text` to
665 * interpret the response as UTF-8 string or `blob` to handle the
666 * response as binary `Blob` data.
668 * @property {*} [content]
669 * Specifies the HTTP message body to send along with the request.
670 * If the value is a function, it is invoked and the return value
671 * used as content, if it is a FormData instance, it is used as-is,
672 * if it is an object, it will be converted to JSON, in all other
673 * cases it is converted to a string.
675 * @property {Object<string, string>} [header]
676 * Specifies HTTP headers to set for the request.
678 * @property {function} [progress]
679 * An optional request callback function which receives ProgressEvent
680 * instances as sole argument during the HTTP request transfer.
684 * Initiate an HTTP request to the given target.
687 * @memberof LuCI.request
688 * @param {string} target
689 * The URL to request.
691 * @param {LuCI.request.RequestOptions} [options]
692 * Additional options to configure the request.
694 * @returns {Promise<LuCI.response>}
695 * The resulting HTTP response.
697 request: function(target, options) {
698 var state = { xhr: new XMLHttpRequest(), url: this.expandURL(target), start: Date.now() },
699 opt = Object.assign({}, options, state),
702 callback = this.handleReadyStateChange;
704 return new Promise(function(resolveFn, rejectFn) {
705 opt.xhr.onreadystatechange = callback.bind(opt, resolveFn, rejectFn);
706 opt.method = String(opt.method || 'GET').toUpperCase();
708 if ('query' in opt) {
709 var q = (opt.query != null) ? Object.keys(opt.query).map(function(k) {
710 if (opt.query[k] != null) {
711 var v = (typeof(opt.query[k]) == 'object')
712 ? JSON.stringify(opt.query[k])
713 : String(opt.query[k]);
715 return '%s=%s'.format(encodeURIComponent(k), encodeURIComponent(v));
718 return encodeURIComponent(k);
723 switch (opt.method) {
727 opt.url += ((/\?/).test(opt.url) ? '&' : '?') + q;
731 if (content == null) {
733 contenttype = 'application/x-www-form-urlencoded';
740 opt.url += ((/\?/).test(opt.url) ? '&' : '?') + (new Date()).getTime();
742 if (isQueueableRequest(opt)) {
743 requestQueue.push([opt, rejectFn, resolveFn]);
744 requestAnimationFrame(flushRequestQueue);
748 if ('username' in opt && 'password' in opt)
749 opt.xhr.open(opt.method, opt.url, true, opt.username, opt.password);
751 opt.xhr.open(opt.method, opt.url, true);
753 opt.xhr.responseType = opt.responseType || 'text';
755 if ('overrideMimeType' in opt.xhr)
756 opt.xhr.overrideMimeType('application/octet-stream');
758 if ('timeout' in opt)
759 opt.xhr.timeout = +opt.timeout;
761 if ('credentials' in opt)
762 opt.xhr.withCredentials = !!opt.credentials;
764 if (opt.content != null) {
765 switch (typeof(opt.content)) {
767 content = opt.content(xhr);
771 if (!(opt.content instanceof FormData)) {
772 content = JSON.stringify(opt.content);
773 contenttype = 'application/json';
776 content = opt.content;
781 content = String(opt.content);
785 if ('headers' in opt)
786 for (var header in opt.headers)
787 if (opt.headers.hasOwnProperty(header)) {
788 if (header.toLowerCase() != 'content-type')
789 opt.xhr.setRequestHeader(header, opt.headers[header]);
791 contenttype = opt.headers[header];
794 if ('progress' in opt && 'upload' in opt.xhr)
795 opt.xhr.upload.addEventListener('progress', opt.progress);
797 if (contenttype != null)
798 opt.xhr.setRequestHeader('Content-Type', contenttype);
801 opt.xhr.send(content);
804 rejectFn.call(opt, e);
809 handleReadyStateChange: function(resolveFn, rejectFn, ev) {
811 duration = Date.now() - this.start;
813 if (xhr.readyState !== 4)
816 if (xhr.status === 0 && xhr.statusText === '') {
817 if (duration >= this.timeout)
818 rejectFn.call(this, new Error('XHR request timed out'));
820 rejectFn.call(this, new Error('XHR request aborted by browser'));
823 var response = new Response(
824 xhr, xhr.responseURL || this.url, duration);
826 Promise.all(Request.interceptors.map(function(fn) { return fn(response) }))
827 .then(resolveFn.bind(this, response))
828 .catch(rejectFn.bind(this));
833 * Initiate an HTTP GET request to the given target.
836 * @memberof LuCI.request
837 * @param {string} target
838 * The URL to request.
840 * @param {LuCI.request.RequestOptions} [options]
841 * Additional options to configure the request.
843 * @returns {Promise<LuCI.response>}
844 * The resulting HTTP response.
846 get: function(url, options) {
847 return this.request(url, Object.assign({ method: 'GET' }, options));
851 * Initiate an HTTP POST request to the given target.
854 * @memberof LuCI.request
855 * @param {string} target
856 * The URL to request.
859 * The request data to send, see {@link LuCI.request.RequestOptions} for details.
861 * @param {LuCI.request.RequestOptions} [options]
862 * Additional options to configure the request.
864 * @returns {Promise<LuCI.response>}
865 * The resulting HTTP response.
867 post: function(url, data, options) {
868 return this.request(url, Object.assign({ method: 'POST', content: data }, options));
872 * Interceptor functions are invoked whenever an HTTP reply is received, in the order
873 * these functions have been registered.
874 * @callback LuCI.request.interceptorFn
875 * @param {LuCI.response} res
876 * The HTTP response object
880 * Register an HTTP response interceptor function. Interceptor
881 * functions are useful to perform default actions on incoming HTTP
882 * responses, such as checking for expired authentication or for
883 * implementing request retries before returning a failure.
886 * @memberof LuCI.request
887 * @param {LuCI.request.interceptorFn} interceptorFn
888 * The interceptor function to register.
890 * @returns {LuCI.request.interceptorFn}
891 * The registered function.
893 addInterceptor: function(interceptorFn) {
894 if (typeof(interceptorFn) == 'function')
895 this.interceptors.push(interceptorFn);
896 return interceptorFn;
900 * Remove an HTTP response interceptor function. The passed function
901 * value must be the very same value that was used to register the
905 * @memberof LuCI.request
906 * @param {LuCI.request.interceptorFn} interceptorFn
907 * The interceptor function to remove.
910 * Returns `true` if any function has been removed, else `false`.
912 removeInterceptor: function(interceptorFn) {
913 var oldlen = this.interceptors.length, i = oldlen;
915 if (this.interceptors[i] === interceptorFn)
916 this.interceptors.splice(i, 1);
917 return (this.interceptors.length < oldlen);
922 * @memberof LuCI.request
926 * The `Request.poll` class provides some convience wrappers around
927 * {@link LuCI.poll} mainly to simplify registering repeating HTTP
928 * request calls as polling functions.
932 * The callback function is invoked whenever an HTTP reply to a
933 * polled request is received or when the polled request timed
936 * @callback LuCI.request.poll~callbackFn
937 * @param {LuCI.response} res
938 * The HTTP response object.
941 * The response JSON if the response could be parsed as such,
944 * @param {number} duration
945 * The total duration of the request in milliseconds.
949 * Register a repeating HTTP request with an optional callback
950 * to invoke whenever a response for the request is received.
953 * @memberof LuCI.request.poll
954 * @param {number} interval
955 * The poll interval in seconds.
957 * @param {string} url
958 * The URL to request on each poll.
960 * @param {LuCI.request.RequestOptions} [options]
961 * Additional options to configure the request.
963 * @param {LuCI.request.poll~callbackFn} [callback]
964 * {@link LuCI.request.poll~callbackFn Callback} function to
965 * invoke for each HTTP reply.
967 * @throws {TypeError}
968 * Throws `TypeError` when an invalid interval was passed.
970 * @returns {function}
971 * Returns the internally created poll function.
973 add: function(interval, url, options, callback) {
974 if (isNaN(interval) || interval <= 0)
975 throw new TypeError('Invalid poll interval');
977 var ival = interval >>> 0,
978 opts = Object.assign({}, options, { timeout: ival * 1000 - 5 });
980 var fn = function() {
981 return Request.request(url, options).then(function(res) {
986 callback(res, res.json(), res.duration);
989 callback(res, null, res.duration);
994 return (Poll.add(fn, ival) ? fn : null);
998 * Remove a polling request that has been previously added using `add()`.
999 * This function is essentially a wrapper around
1000 * {@link LuCI.poll.remove LuCI.poll.remove()}.
1003 * @memberof LuCI.request.poll
1004 * @param {function} entry
1005 * The poll function returned by {@link LuCI.request.poll#add add()}.
1007 * @returns {boolean}
1008 * Returns `true` if any function has been removed, else `false`.
1010 remove: function(entry) { return Poll.remove(entry) },
1013 * Alias for {@link LuCI.poll.start LuCI.poll.start()}.
1016 * @memberof LuCI.request.poll
1018 start: function() { return Poll.start() },
1021 * Alias for {@link LuCI.poll.stop LuCI.poll.stop()}.
1024 * @memberof LuCI.request.poll
1026 stop: function() { return Poll.stop() },
1029 * Alias for {@link LuCI.poll.active LuCI.poll.active()}.
1032 * @memberof LuCI.request.poll
1034 active: function() { return Poll.active() }
1044 * The `Poll` class allows registering and unregistering poll actions,
1045 * as well as starting, stopping and querying the state of the polling
1048 var Poll = Class.singleton(/** @lends LuCI.poll.prototype */ {
1049 __name__: 'LuCI.poll',
1054 * Add a new operation to the polling loop. If the polling loop is not
1055 * already started at this point, it will be implicitely started.
1058 * @memberof LuCI.poll
1059 * @param {function} fn
1060 * The function to invoke on each poll interval.
1062 * @param {number} interval
1063 * The poll interval in seconds.
1065 * @throws {TypeError}
1066 * Throws `TypeError` when an invalid interval was passed.
1068 * @returns {boolean}
1069 * Returns `true` if the function has been added or `false` if it
1070 * already is registered.
1072 add: function(fn, interval) {
1073 if (interval == null || interval <= 0)
1074 interval = env.pollinterval || null;
1076 if (isNaN(interval) || typeof(fn) != 'function')
1077 throw new TypeError('Invalid argument to LuCI.poll.add()');
1079 for (var i = 0; i < this.queue.length; i++)
1080 if (this.queue[i].fn === fn)
1091 if (this.tick != null && !this.active())
1098 * Remove an operation from the polling loop. If no further operatons
1099 * are registered, the polling loop is implicitely stopped.
1102 * @memberof LuCI.poll
1103 * @param {function} fn
1104 * The function to remove.
1106 * @throws {TypeError}
1107 * Throws `TypeError` when the given argument isn't a function.
1109 * @returns {boolean}
1110 * Returns `true` if the function has been removed or `false` if it
1113 remove: function(fn) {
1114 if (typeof(fn) != 'function')
1115 throw new TypeError('Invalid argument to LuCI.poll.remove()');
1117 var len = this.queue.length;
1119 for (var i = len; i > 0; i--)
1120 if (this.queue[i-1].fn === fn)
1121 this.queue.splice(i-1, 1);
1123 if (!this.queue.length && this.stop())
1126 return (this.queue.length != len);
1130 * (Re)start the polling loop. Dispatches a custom `poll-start` event
1131 * to the `document` object upon successful start.
1134 * @memberof LuCI.poll
1135 * @returns {boolean}
1136 * Returns `true` if polling has been started (or if no functions
1137 * where registered) or `false` when the polling loop already runs.
1145 if (this.queue.length) {
1146 this.timer = window.setInterval(this.step, 1000);
1148 document.dispatchEvent(new CustomEvent('poll-start'));
1155 * Stop the polling loop. Dispatches a custom `poll-stop` event
1156 * to the `document` object upon successful stop.
1159 * @memberof LuCI.poll
1160 * @returns {boolean}
1161 * Returns `true` if polling has been stopped or `false` if it din't
1162 * run to begin with.
1168 document.dispatchEvent(new CustomEvent('poll-stop'));
1169 window.clearInterval(this.timer);
1177 for (var i = 0, e = null; (e = Poll.queue[i]) != null; i++) {
1178 if ((Poll.tick % e.i) != 0)
1186 Promise.resolve(e.fn()).finally((function() { this.r = true }).bind(e));
1189 Poll.tick = (Poll.tick + 1) % Math.pow(2, 32);
1193 * Test whether the polling loop is running.
1196 * @memberof LuCI.poll
1197 * @returns {boolean} - Returns `true` if polling is active, else `false`.
1199 active: function() {
1200 return (this.timer != null);
1210 * The `dom` class provides convenience method for creating and
1211 * manipulating DOM elements.
1213 * To import the class in views, use `'require dom'`, to import it in
1214 * external JavaScript, use `L.require("dom").then(...)`.
1216 var DOM = Class.singleton(/** @lends LuCI.dom.prototype */ {
1217 __name__: 'LuCI.dom',
1220 * Tests whether the given argument is a valid DOM `Node`.
1223 * @memberof LuCI.dom
1225 * The value to test.
1227 * @returns {boolean}
1228 * Returns `true` if the value is a DOM `Node`, else `false`.
1231 return (e != null && typeof(e) == 'object' && 'nodeType' in e);
1235 * Parses a given string as HTML and returns the first child node.
1238 * @memberof LuCI.dom
1240 * A string containing an HTML fragment to parse. Note that only
1241 * the first result of the resulting structure is returned, so an
1242 * input value of `<div>foo</div> <div>bar</div>` will only return
1243 * the first `div` element node.
1246 * Returns the first DOM `Node` extracted from the HTML fragment or
1247 * `null` on parsing failures or if no element could be found.
1249 parse: function(s) {
1253 domParser = domParser || new DOMParser();
1254 elem = domParser.parseFromString(s, 'text/html').body.firstChild;
1260 dummyElem = dummyElem || document.createElement('div');
1261 dummyElem.innerHTML = s;
1262 elem = dummyElem.firstChild;
1267 return elem || null;
1271 * Tests whether a given `Node` matches the given query selector.
1273 * This function is a convenience wrapper around the standard
1274 * `Node.matches("selector")` function with the added benefit that
1275 * the `node` argument may be a non-`Node` value, in which case
1276 * this function simply returns `false`.
1279 * @memberof LuCI.dom
1281 * The `Node` argument to test the selector against.
1283 * @param {string} [selector]
1284 * The query selector expression to test against the given node.
1286 * @returns {boolean}
1287 * Returns `true` if the given node matches the specified selector
1288 * or `false` when the node argument is no valid DOM `Node` or the
1289 * selector didn't match.
1291 matches: function(node, selector) {
1292 var m = this.elem(node) ? node.matches || node.msMatchesSelector : null;
1293 return m ? m.call(node, selector) : false;
1297 * Returns the closest parent node that matches the given query
1298 * selector expression.
1300 * This function is a convenience wrapper around the standard
1301 * `Node.closest("selector")` function with the added benefit that
1302 * the `node` argument may be a non-`Node` value, in which case
1303 * this function simply returns `null`.
1306 * @memberof LuCI.dom
1308 * The `Node` argument to find the closest parent for.
1310 * @param {string} [selector]
1311 * The query selector expression to test against each parent.
1313 * @returns {Node|null}
1314 * Returns the closest parent node matching the selector or
1315 * `null` when the node argument is no valid DOM `Node` or the
1316 * selector didn't match any parent.
1318 parent: function(node, selector) {
1319 if (this.elem(node) && node.closest)
1320 return node.closest(selector);
1322 while (this.elem(node))
1323 if (this.matches(node, selector))
1326 node = node.parentNode;
1332 * Appends the given children data to the given node.
1335 * @memberof LuCI.dom
1337 * The `Node` argument to append the children to.
1339 * @param {*} [children]
1340 * The childrens to append to the given node.
1342 * When `children` is an array, then each item of the array
1343 * will be either appended as child element or text node,
1344 * depending on whether the item is a DOM `Node` instance or
1345 * some other non-`null` value. Non-`Node`, non-`null` values
1346 * will be converted to strings first before being passed as
1347 * argument to `createTextNode()`.
1349 * When `children` is a function, it will be invoked with
1350 * the passed `node` argument as sole parameter and the `append`
1351 * function will be invoked again, with the given `node` argument
1352 * as first and the return value of the `children` function as
1355 * When `children` is is a DOM `Node` instance, it will be
1356 * appended to the given `node`.
1358 * When `children` is any other non-`null` value, it will be
1359 * converted to a string and appened to the `innerHTML` property
1360 * of the given `node`.
1362 * @returns {Node|null}
1363 * Returns the last children `Node` appended to the node or `null`
1364 * if either the `node` argument was no valid DOM `node` or if the
1365 * `children` was `null` or didn't result in further DOM nodes.
1367 append: function(node, children) {
1368 if (!this.elem(node))
1371 if (Array.isArray(children)) {
1372 for (var i = 0; i < children.length; i++)
1373 if (this.elem(children[i]))
1374 node.appendChild(children[i]);
1375 else if (children !== null && children !== undefined)
1376 node.appendChild(document.createTextNode('' + children[i]));
1378 return node.lastChild;
1380 else if (typeof(children) === 'function') {
1381 return this.append(node, children(node));
1383 else if (this.elem(children)) {
1384 return node.appendChild(children);
1386 else if (children !== null && children !== undefined) {
1387 node.innerHTML = '' + children;
1388 return node.lastChild;
1395 * Replaces the content of the given node with the given children.
1397 * This function first removes any children of the given DOM
1398 * `Node` and then adds the given given children following the
1399 * rules outlined below.
1402 * @memberof LuCI.dom
1404 * The `Node` argument to replace the children of.
1406 * @param {*} [children]
1407 * The childrens to replace into the given node.
1409 * When `children` is an array, then each item of the array
1410 * will be either appended as child element or text node,
1411 * depending on whether the item is a DOM `Node` instance or
1412 * some other non-`null` value. Non-`Node`, non-`null` values
1413 * will be converted to strings first before being passed as
1414 * argument to `createTextNode()`.
1416 * When `children` is a function, it will be invoked with
1417 * the passed `node` argument as sole parameter and the `append`
1418 * function will be invoked again, with the given `node` argument
1419 * as first and the return value of the `children` function as
1422 * When `children` is is a DOM `Node` instance, it will be
1423 * appended to the given `node`.
1425 * When `children` is any other non-`null` value, it will be
1426 * converted to a string and appened to the `innerHTML` property
1427 * of the given `node`.
1429 * @returns {Node|null}
1430 * Returns the last children `Node` appended to the node or `null`
1431 * if either the `node` argument was no valid DOM `node` or if the
1432 * `children` was `null` or didn't result in further DOM nodes.
1434 content: function(node, children) {
1435 if (!this.elem(node))
1438 var dataNodes = node.querySelectorAll('[data-idref]');
1440 for (var i = 0; i < dataNodes.length; i++)
1441 delete this.registry[dataNodes[i].getAttribute('data-idref')];
1443 while (node.firstChild)
1444 node.removeChild(node.firstChild);
1446 return this.append(node, children);
1450 * Sets attributes or registers event listeners on element nodes.
1453 * @memberof LuCI.dom
1455 * The `Node` argument to set the attributes or add the event
1456 * listeners for. When the given `node` value is not a valid
1457 * DOM `Node`, the function returns and does nothing.
1459 * @param {string|Object<string, *>} key
1460 * Specifies either the attribute or event handler name to use,
1461 * or an object containing multiple key, value pairs which are
1462 * each added to the node as either attribute or event handler,
1463 * depending on the respective value.
1466 * Specifies the attribute value or event handler function to add.
1467 * If the `key` parameter is an `Object`, this parameter will be
1470 * When `val` is of type function, it will be registered as event
1471 * handler on the given `node` with the `key` parameter being the
1474 * When `val` is of type object, it will be serialized as JSON and
1475 * added as attribute to the given `node`, using the given `key`
1476 * as attribute name.
1478 * When `val` is of any other type, it will be added as attribute
1479 * to the given `node` as-is, with the underlying `setAttribute()`
1480 * call implicitely turning it into a string.
1482 attr: function(node, key, val) {
1483 if (!this.elem(node))
1488 if (typeof(key) === 'object' && key !== null)
1490 else if (typeof(key) === 'string')
1491 attr = {}, attr[key] = val;
1494 if (!attr.hasOwnProperty(key) || attr[key] == null)
1497 switch (typeof(attr[key])) {
1499 node.addEventListener(key, attr[key]);
1503 node.setAttribute(key, JSON.stringify(attr[key]));
1507 node.setAttribute(key, attr[key]);
1513 * Creates a new DOM `Node` from the given `html`, `attr` and
1514 * `data` parameters.
1516 * This function has multiple signatures, it can be either invoked
1517 * in the form `create(html[, attr[, data]])` or in the form
1518 * `create(html[, data])`. The used variant is determined from the
1519 * type of the second argument.
1522 * @memberof LuCI.dom
1524 * Describes the node to create.
1526 * When the value of `html` is of type array, a `DocumentFragment`
1527 * node is created and each item of the array is first converted
1528 * to a DOM `Node` by passing it through `create()` and then added
1529 * as child to the fragment.
1531 * When the value of `html` is a DOM `Node` instance, no new
1532 * element will be created but the node will be used as-is.
1534 * When the value of `html` is a string starting with `<`, it will
1535 * be passed to `dom.parse()` and the resulting value is used.
1537 * When the value of `html` is any other string, it will be passed
1538 * to `document.createElement()` for creating a new DOM `Node` of
1541 * @param {Object<string, *>} [attr]
1542 * Specifies an Object of key, value pairs to set as attributes
1543 * or event handlers on the created node. Refer to
1544 * {@link LuCI.dom#attr dom.attr()} for details.
1547 * Specifies children to append to the newly created element.
1548 * Refer to {@link LuCI.dom#append dom.append()} for details.
1550 * @throws {InvalidCharacterError}
1551 * Throws an `InvalidCharacterError` when the given `html`
1552 * argument contained malformed markup (such as not escaped
1553 * `&` characters in XHTML mode) or when the given node name
1554 * in `html` contains characters which are not legal in DOM
1555 * element names, such as spaces.
1558 * Returns the newly created `Node`.
1560 create: function() {
1561 var html = arguments[0],
1562 attr = arguments[1],
1563 data = arguments[2],
1566 if (!(attr instanceof Object) || Array.isArray(attr))
1567 data = attr, attr = null;
1569 if (Array.isArray(html)) {
1570 elem = document.createDocumentFragment();
1571 for (var i = 0; i < html.length; i++)
1572 elem.appendChild(this.create(html[i]));
1574 else if (this.elem(html)) {
1577 else if (html.charCodeAt(0) === 60) {
1578 elem = this.parse(html);
1581 elem = document.createElement(html);
1587 this.attr(elem, attr);
1588 this.append(elem, data);
1596 * Attaches or detaches arbitrary data to and from a DOM `Node`.
1598 * This function is useful to attach non-string values or runtime
1599 * data that is not serializable to DOM nodes. To decouple data
1600 * from the DOM, values are not added directly to nodes, but
1601 * inserted into a registry instead which is then referenced by a
1602 * string key stored as `data-idref` attribute in the node.
1604 * This function has multiple signatures and is sensitive to the
1605 * number of arguments passed to it.
1607 * - `dom.data(node)` -
1608 * Fetches all data associated with the given node.
1609 * - `dom.data(node, key)` -
1610 * Fetches a specific key associated with the given node.
1611 * - `dom.data(node, key, val)` -
1612 * Sets a specific key to the given value associated with the
1614 * - `dom.data(node, null)` -
1615 * Clears any data associated with the node.
1616 * - `dom.data(node, key, null)` -
1617 * Clears the given key associated with the node.
1620 * @memberof LuCI.dom
1621 * @param {Node} node
1622 * The DOM `Node` instance to set or retrieve the data for.
1624 * @param {string|null} [key]
1625 * This is either a string specifying the key to retrieve, or
1626 * `null` to unset the entire node data.
1628 * @param {*|null} [val]
1629 * This is either a non-`null` value to set for a given key or
1630 * `null` to remove the given `key` from the specified node.
1633 * Returns the get or set value, or `null` when no value could
1636 data: function(node, key, val) {
1637 if (!node || !node.getAttribute)
1640 var id = node.getAttribute('data-idref');
1642 /* clear all data */
1643 if (arguments.length > 1 && key == null) {
1645 node.removeAttribute('data-idref');
1646 val = this.registry[id]
1647 delete this.registry[id];
1655 else if (arguments.length > 2 && key != null && val == null) {
1657 val = this.registry[id][key];
1658 delete this.registry[id][key];
1666 else if (arguments.length > 2 && key != null && val != null) {
1668 do { id = Math.floor(Math.random() * 0xffffffff).toString(16) }
1669 while (this.registry.hasOwnProperty(id));
1671 node.setAttribute('data-idref', id);
1672 this.registry[id] = {};
1675 return (this.registry[id][key] = val);
1679 else if (arguments.length == 1) {
1681 return this.registry[id];
1687 else if (arguments.length == 2) {
1689 return this.registry[id][key];
1696 * Binds the given class instance ot the specified DOM `Node`.
1698 * This function uses the `dom.data()` facility to attach the
1699 * passed instance of a Class to a node. This is needed for
1700 * complex widget elements or similar where the corresponding
1701 * class instance responsible for the element must be retrieved
1702 * from DOM nodes obtained by `querySelector()` or similar means.
1705 * @memberof LuCI.dom
1706 * @param {Node} node
1707 * The DOM `Node` instance to bind the class to.
1709 * @param {Class} inst
1710 * The Class instance to bind to the node.
1712 * @throws {TypeError}
1713 * Throws a `TypeError` when the given instance argument isn't
1714 * a valid Class instance.
1717 * Returns the bound class instance.
1719 bindClassInstance: function(node, inst) {
1720 if (!(inst instanceof Class))
1721 L.error('TypeError', 'Argument must be a class instance');
1723 return this.data(node, '_class', inst);
1727 * Finds a bound class instance on the given node itself or the
1728 * first bound instance on its closest parent node.
1731 * @memberof LuCI.dom
1732 * @param {Node} node
1733 * The DOM `Node` instance to start from.
1735 * @returns {Class|null}
1736 * Returns the founds class instance if any or `null` if no bound
1737 * class could be found on the node itself or any of its parents.
1739 findClassInstance: function(node) {
1743 inst = this.data(node, '_class');
1744 node = node.parentNode;
1746 while (!(inst instanceof Class) && node != null);
1752 * Finds a bound class instance on the given node itself or the
1753 * first bound instance on its closest parent node and invokes
1754 * the specified method name on the found class instance.
1757 * @memberof LuCI.dom
1758 * @param {Node} node
1759 * The DOM `Node` instance to start from.
1761 * @param {string} method
1762 * The name of the method to invoke on the found class instance.
1764 * @param {...*} params
1765 * Additional arguments to pass to the invoked method as-is.
1768 * Returns the return value of the invoked method if a class
1769 * instance and method has been found. Returns `null` if either
1770 * no bound class instance could be found, or if the found
1771 * instance didn't have the requested `method`.
1773 callClassMethod: function(node, method /*, ... */) {
1774 var inst = this.findClassInstance(node);
1776 if (inst == null || typeof(inst[method]) != 'function')
1779 return inst[method].apply(inst, inst.varargs(arguments, 2));
1783 * The ignore callback function is invoked by `isEmpty()` for each
1784 * child node to decide whether to ignore a child node or not.
1786 * When this function returns `false`, the node passed to it is
1787 * ignored, else not.
1789 * @callback LuCI.dom~ignoreCallbackFn
1790 * @param {Node} node
1791 * The child node to test.
1793 * @returns {boolean}
1794 * Boolean indicating whether to ignore the node or not.
1798 * Tests whether a given DOM `Node` instance is empty or appears
1801 * Any element child nodes which have the CSS class `hidden` set
1802 * or for which the optionally passed `ignoreFn` callback function
1803 * returns `false` are ignored.
1806 * @memberof LuCI.dom
1807 * @param {Node} node
1808 * The DOM `Node` instance to test.
1810 * @param {LuCI.dom~ignoreCallbackFn} [ignoreFn]
1811 * Specifies an optional function which is invoked for each child
1812 * node to decide whether the child node should be ignored or not.
1814 * @returns {boolean}
1815 * Returns `true` if the node does not have any children or if
1816 * any children node either has a `hidden` CSS class or a `false`
1817 * result when testing it using the given `ignoreFn`.
1819 isEmpty: function(node, ignoreFn) {
1820 for (var child = node.firstElementChild; child != null; child = child.nextElementSibling)
1821 if (!child.classList.contains('hidden') && (!ignoreFn || !ignoreFn(child)))
1834 * The `session` class provides various session related functionality.
1836 var Session = Class.singleton(/** @lends LuCI.session.prototype */ {
1837 __name__: 'LuCI.session',
1840 * Retrieve the current session ID.
1843 * Returns the current session ID.
1846 return env.sessionid || '00000000000000000000000000000000';
1850 * Retrieve the current session token.
1852 * @returns {string|null}
1853 * Returns the current session token or `null` if not logged in.
1855 getToken: function() {
1856 return env.token || null;
1860 * Retrieve data from the local session storage.
1862 * @param {string} [key]
1863 * The key to retrieve from the session data store. If omitted, all
1864 * session data will be returned.
1867 * Returns the stored session data or `null` if the given key wasn't
1870 getLocalData: function(key) {
1872 var sid = this.getID(),
1873 item = 'luci-session-store',
1874 data = JSON.parse(window.sessionStorage.getItem(item));
1876 if (!LuCI.prototype.isObject(data) || !data.hasOwnProperty(sid)) {
1882 return data[sid].hasOwnProperty(key) ? data[sid][key] : null;
1887 return (key != null) ? null : {};
1892 * Set data in the local session storage.
1894 * @param {string} key
1895 * The key to set in the session data store.
1898 * The value to store. It will be internally converted to JSON before
1899 * being put in the session store.
1901 * @returns {boolean}
1902 * Returns `true` if the data could be stored or `false` on error.
1904 setLocalData: function(key, value) {
1909 var sid = this.getID(),
1910 item = 'luci-session-store',
1911 data = JSON.parse(window.sessionStorage.getItem(item));
1913 if (!LuCI.prototype.isObject(data) || !data.hasOwnProperty(sid)) {
1919 data[sid][key] = value;
1921 delete data[sid][key];
1923 window.sessionStorage.setItem(item, JSON.stringify(data));
1939 * The `view` class forms the basis of views and provides a standard
1940 * set of methods to inherit from.
1942 var View = Class.extend(/** @lends LuCI.view.prototype */ {
1943 __name__: 'LuCI.view',
1945 __init__: function() {
1946 var vp = document.getElementById('view');
1948 DOM.content(vp, E('div', { 'class': 'spinning' }, _('Loading view…')));
1950 return Promise.resolve(this.load())
1951 .then(L.bind(this.render, this))
1952 .then(L.bind(function(nodes) {
1953 var vp = document.getElementById('view');
1955 DOM.content(vp, nodes);
1956 DOM.append(vp, this.addFooter());
1957 }, this)).catch(L.error);
1961 * The load function is invoked before the view is rendered.
1963 * The invocation of this function is wrapped by
1964 * `Promise.resolve()` so it may return Promises if needed.
1966 * The return value of the function (or the resolved values
1967 * of the promise returned by it) will be passed as first
1968 * argument to `render()`.
1970 * This function is supposed to be overwritten by subclasses,
1971 * the default implementation does nothing.
1975 * @memberof LuCI.view
1977 * @returns {*|Promise<*>}
1978 * May return any value or a Promise resolving to any value.
1980 load: function() {},
1983 * The render function is invoked after the
1984 * {@link LuCI.view#load load()} function and responsible
1985 * for setting up the view contents. It must return a DOM
1986 * `Node` or `DocumentFragment` holding the contents to
1987 * insert into the view area.
1989 * The invocation of this function is wrapped by
1990 * `Promise.resolve()` so it may return Promises if needed.
1992 * The return value of the function (or the resolved values
1993 * of the promise returned by it) will be inserted into the
1994 * main content area using
1995 * {@link LuCI.dom#append dom.append()}.
1997 * This function is supposed to be overwritten by subclasses,
1998 * the default implementation does nothing.
2002 * @memberof LuCI.view
2003 * @param {*|null} load_results
2004 * This function will receive the return value of the
2005 * {@link LuCI.view#load view.load()} function as first
2008 * @returns {Node|Promise<Node>}
2009 * Should return a DOM `Node` value or a `Promise` resolving
2010 * to a `Node` value.
2012 render: function() {},
2015 * The handleSave function is invoked when the user clicks
2016 * the `Save` button in the page action footer.
2018 * The default implementation should be sufficient for most
2019 * views using {@link form#Map form.Map()} based forms - it
2020 * will iterate all forms present in the view and invoke
2021 * the {@link form#Map#save Map.save()} method on each form.
2023 * Views not using `Map` instances or requiring other special
2024 * logic should overwrite `handleSave()` with a custom
2027 * To disable the `Save` page footer button, views extending
2028 * this base class should overwrite the `handleSave` function
2031 * The invocation of this function is wrapped by
2032 * `Promise.resolve()` so it may return Promises if needed.
2035 * @memberof LuCI.view
2037 * The DOM event that triggered the function.
2039 * @returns {*|Promise<*>}
2040 * Any return values of this function are discarded, but
2041 * passed through `Promise.resolve()` to ensure that any
2042 * returned promise runs to completion before the button
2045 handleSave: function(ev) {
2048 document.getElementById('maincontent')
2049 .querySelectorAll('.cbi-map').forEach(function(map) {
2050 tasks.push(DOM.callClassMethod(map, 'save'));
2053 return Promise.all(tasks);
2057 * The handleSaveApply function is invoked when the user clicks
2058 * the `Save & Apply` button in the page action footer.
2060 * The default implementation should be sufficient for most
2061 * views using {@link form#Map form.Map()} based forms - it
2063 * {@link LuCI.view.handleSave view.handleSave()} and then
2064 * call {@link ui#changes#apply ui.changes.apply()} to start the
2065 * modal config apply and page reload flow.
2067 * Views not using `Map` instances or requiring other special
2068 * logic should overwrite `handleSaveApply()` with a custom
2071 * To disable the `Save & Apply` page footer button, views
2072 * extending this base class should overwrite the
2073 * `handleSaveApply` function with `null`.
2075 * The invocation of this function is wrapped by
2076 * `Promise.resolve()` so it may return Promises if needed.
2079 * @memberof LuCI.view
2081 * The DOM event that triggered the function.
2083 * @returns {*|Promise<*>}
2084 * Any return values of this function are discarded, but
2085 * passed through `Promise.resolve()` to ensure that any
2086 * returned promise runs to completion before the button
2089 handleSaveApply: function(ev, mode) {
2090 return this.handleSave(ev).then(function() {
2091 L.ui.changes.apply(mode == '0');
2096 * The handleReset function is invoked when the user clicks
2097 * the `Reset` button in the page action footer.
2099 * The default implementation should be sufficient for most
2100 * views using {@link form#Map form.Map()} based forms - it
2101 * will iterate all forms present in the view and invoke
2102 * the {@link form#Map#save Map.reset()} method on each form.
2104 * Views not using `Map` instances or requiring other special
2105 * logic should overwrite `handleReset()` with a custom
2108 * To disable the `Reset` page footer button, views extending
2109 * this base class should overwrite the `handleReset` function
2112 * The invocation of this function is wrapped by
2113 * `Promise.resolve()` so it may return Promises if needed.
2116 * @memberof LuCI.view
2118 * The DOM event that triggered the function.
2120 * @returns {*|Promise<*>}
2121 * Any return values of this function are discarded, but
2122 * passed through `Promise.resolve()` to ensure that any
2123 * returned promise runs to completion before the button
2126 handleReset: function(ev) {
2129 document.getElementById('maincontent')
2130 .querySelectorAll('.cbi-map').forEach(function(map) {
2131 tasks.push(DOM.callClassMethod(map, 'reset'));
2134 return Promise.all(tasks);
2138 * Renders a standard page action footer if any of the
2139 * `handleSave()`, `handleSaveApply()` or `handleReset()`
2140 * functions are defined.
2142 * The default implementation should be sufficient for most
2143 * views - it will render a standard page footer with action
2144 * buttons labeled `Save`, `Save & Apply` and `Reset`
2145 * triggering the `handleSave()`, `handleSaveApply()` and
2146 * `handleReset()` functions respectively.
2148 * When any of these `handle*()` functions is overwritten
2149 * with `null` by a view extending this class, the
2150 * corresponding button will not be rendered.
2153 * @memberof LuCI.view
2154 * @returns {DocumentFragment}
2155 * Returns a `DocumentFragment` containing the footer bar
2156 * with buttons for each corresponding `handle*()` action
2157 * or an empty `DocumentFragment` if all three `handle*()`
2158 * methods are overwritten with `null`.
2160 addFooter: function() {
2163 var saveApplyBtn = this.handleSaveApply ? new L.ui.ComboButton('0', {
2164 0: [ _('Save & Apply') ],
2165 1: [ _('Apply unchecked') ]
2168 0: 'btn cbi-button cbi-button-apply important',
2169 1: 'btn cbi-button cbi-button-negative important'
2171 click: L.ui.createHandlerFn(this, 'handleSaveApply')
2172 }).render() : E([]);
2174 if (this.handleSaveApply || this.handleSave || this.handleReset) {
2175 footer.appendChild(E('div', { 'class': 'cbi-page-actions control-group' }, [
2177 this.handleSave ? E('button', {
2178 'class': 'cbi-button cbi-button-save',
2179 'click': L.ui.createHandlerFn(this, 'handleSave')
2180 }, [ _('Save') ]) : '', ' ',
2181 this.handleReset ? E('button', {
2182 'class': 'cbi-button cbi-button-reset',
2183 'click': L.ui.createHandlerFn(this, 'handleReset')
2184 }, [ _('Reset') ]) : ''
2193 var dummyElem = null,
2195 originalCBIInit = null,
2198 preloadClasses = null;
2200 /* "preload" builtin classes to make the available via require */
2210 var LuCI = Class.extend(/** @lends LuCI.prototype */ {
2212 __init__: function(setenv) {
2214 document.querySelectorAll('script[src*="/luci.js"]').forEach(function(s) {
2215 if (setenv.base_url == null || setenv.base_url == '') {
2216 var m = (s.getAttribute('src') || '').match(/^(.*)\/luci\.js(?:\?v=([^?]+))?$/);
2218 setenv.base_url = m[1];
2219 setenv.resource_version = m[2];
2224 if (setenv.base_url == null)
2225 this.error('InternalError', 'Cannot find url of luci.js');
2227 setenv.cgi_base = setenv.scriptname.replace(/\/[^\/]+$/, '');
2229 Object.assign(env, setenv);
2231 document.addEventListener('poll-start', function(ev) {
2232 document.querySelectorAll('[id^="xhr_poll_status"]').forEach(function(e) {
2233 e.style.display = (e.id == 'xhr_poll_status_off') ? 'none' : '';
2237 document.addEventListener('poll-stop', function(ev) {
2238 document.querySelectorAll('[id^="xhr_poll_status"]').forEach(function(e) {
2239 e.style.display = (e.id == 'xhr_poll_status_on') ? 'none' : '';
2243 var domReady = new Promise(function(resolveFn, rejectFn) {
2244 document.addEventListener('DOMContentLoaded', resolveFn);
2250 this.require('rpc'),
2251 this.require('form'),
2252 this.probeRPCBaseURL()
2253 ]).then(this.setupDOM.bind(this)).catch(this.error);
2255 originalCBIInit = window.cbi_init;
2256 window.cbi_init = function() {};
2260 * Captures the current stack trace and throws an error of the
2261 * specified type as a new exception. Also logs the exception as
2262 * error to the debug console if it is available.
2267 * @param {Error|string} [type=Error]
2268 * Either a string specifying the type of the error to throw or an
2269 * existing `Error` instance to copy.
2271 * @param {string} [fmt=Unspecified error]
2272 * A format string which is used to form the error message, together
2273 * with all subsequent optional arguments.
2275 * @param {...*} [args]
2276 * Zero or more variable arguments to the supplied format string.
2279 * Throws the created error object with the captured stack trace
2280 * appended to the message and the type set to the given type
2281 * argument or copied from the given error instance.
2283 raise: function(type, fmt /*, ...*/) {
2285 msg = fmt ? String.prototype.format.apply(fmt, this.varargs(arguments, 2)) : null,
2288 if (type instanceof Error) {
2292 e.message = msg + ': ' + e.message;
2295 try { throw new Error('stacktrace') }
2296 catch (e2) { stack = (e2.stack || '').split(/\n/) }
2298 e = new (window[type || 'Error'] || Error)(msg || 'Unspecified error');
2299 e.name = type || 'Error';
2302 stack = (stack || []).map(function(frame) {
2303 frame = frame.replace(/(.*?)@(.+):(\d+):(\d+)/g, 'at $1 ($2:$3:$4)').trim();
2304 return frame ? ' ' + frame : '';
2307 if (!/^ at /.test(stack[0]))
2310 if (/\braise /.test(stack[0]))
2313 if (/\berror /.test(stack[0]))
2317 e.message += '\n' + stack.join('\n');
2319 if (window.console && console.debug)
2326 * A wrapper around {@link LuCI#raise raise()} which also renders
2327 * the error either as modal overlay when `ui.js` is already loaed
2328 * or directly into the view body.
2333 * @param {Error|string} [type=Error]
2334 * Either a string specifying the type of the error to throw or an
2335 * existing `Error` instance to copy.
2337 * @param {string} [fmt=Unspecified error]
2338 * A format string which is used to form the error message, together
2339 * with all subsequent optional arguments.
2341 * @param {...*} [args]
2342 * Zero or more variable arguments to the supplied format string.
2345 * Throws the created error object with the captured stack trace
2346 * appended to the message and the type set to the given type
2347 * argument or copied from the given error instance.
2349 error: function(type, fmt /*, ...*/) {
2351 L.raise.apply(L, Array.prototype.slice.call(arguments));
2356 L.ui.addNotification(e.name || _('Runtime error'),
2357 E('pre', {}, e.message), 'danger');
2359 DOM.content(document.querySelector('#maincontent'),
2360 E('pre', { 'class': 'alert-message error' }, e.message));
2370 * Return a bound function using the given `self` as `this` context
2371 * and any further arguments as parameters to the bound function.
2376 * @param {function} fn
2377 * The function to bind.
2380 * The value to bind as `this` context to the specified function.
2382 * @param {...*} [args]
2383 * Zero or more variable arguments which are bound to the function
2386 * @returns {function}
2387 * Returns the bound function.
2389 bind: function(fn, self /*, ... */) {
2390 return Function.prototype.bind.apply(fn, this.varargs(arguments, 2, self));
2394 * Load an additional LuCI JavaScript class and its dependencies,
2395 * instantiate it and return the resulting class instance. Each
2396 * class is only loaded once. Subsequent attempts to load the same
2397 * class will return the already instantiated class.
2402 * @param {string} name
2403 * The name of the class to load in dotted notation. Dots will
2404 * be replaced by spaces and joined with the runtime-determined
2405 * base URL of LuCI.js to form an absolute URL to load the class
2408 * @throws {DependencyError}
2409 * Throws a `DependencyError` when the class to load includes
2410 * circular dependencies.
2412 * @throws {NetworkError}
2413 * Throws `NetworkError` when the underlying {@link LuCI.request}
2416 * @throws {SyntaxError}
2417 * Throws `SyntaxError` when the loaded class file code cannot
2418 * be interpreted by `eval`.
2420 * @throws {TypeError}
2421 * Throws `TypeError` when the class file could be loaded and
2422 * interpreted, but when invoking its code did not yield a valid
2425 * @returns {Promise<LuCI.baseclass>}
2426 * Returns the instantiated class.
2428 require: function(name, from) {
2429 var L = this, url = null, from = from || [];
2431 /* Class already loaded */
2432 if (classes[name] != null) {
2433 /* Circular dependency */
2434 if (from.indexOf(name) != -1)
2435 L.raise('DependencyError',
2436 'Circular dependency: class "%s" depends on "%s"',
2437 name, from.join('" which depends on "'));
2439 return Promise.resolve(classes[name]);
2442 url = '%s/%s.js%s'.format(env.base_url, name.replace(/\./g, '/'), (env.resource_version ? '?v=' + env.resource_version : ''));
2443 from = [ name ].concat(from);
2445 var compileClass = function(res) {
2447 L.raise('NetworkError',
2448 'HTTP error %d while loading class file "%s"', res.status, url);
2450 var source = res.text(),
2451 requirematch = /^require[ \t]+(\S+)(?:[ \t]+as[ \t]+([a-zA-Z_]\S*))?$/,
2452 strictmatch = /^use[ \t]+strict$/,
2456 /* find require statements in source */
2457 for (var i = 0, off = -1, quote = -1, esc = false; i < source.length; i++) {
2458 var chr = source.charCodeAt(i);
2463 else if (chr == 92) {
2466 else if (chr == quote) {
2467 var s = source.substring(off, i),
2468 m = requirematch.exec(s);
2471 var dep = m[1], as = m[2] || dep.replace(/[^a-zA-Z0-9_]/g, '_');
2472 depends.push(L.require(dep, from));
2475 else if (!strictmatch.exec(s)) {
2482 else if (quote == -1 && (chr == 34 || chr == 39)) {
2488 /* load dependencies and instantiate class */
2489 return Promise.all(depends).then(function(instances) {
2490 var _factory, _class;
2494 '(function(window, document, L%s) { %s })\n\n//# sourceURL=%s\n'
2495 .format(args, source, res.url));
2498 L.raise('SyntaxError', '%s\n in %s:%s',
2499 error.message, res.url, error.lineNumber || '?');
2502 _factory.displayName = toCamelCase(name + 'ClassFactory');
2503 _class = _factory.apply(_factory, [window, document, L].concat(instances));
2505 if (!Class.isSubclass(_class))
2506 L.error('TypeError', '"%s" factory yields invalid constructor', name);
2508 if (_class.displayName == 'AnonymousClass')
2509 _class.displayName = toCamelCase(name + 'Class');
2511 var ptr = Object.getPrototypeOf(L),
2512 parts = name.split(/\./),
2513 instance = new _class();
2515 for (var i = 0; ptr && i < parts.length - 1; i++)
2516 ptr = ptr[parts[i]];
2519 ptr[parts[i]] = instance;
2521 classes[name] = instance;
2527 /* Request class file */
2528 classes[name] = Request.get(url, { cache: true }).then(compileClass);
2530 return classes[name];
2534 probeRPCBaseURL: function() {
2535 if (rpcBaseURL == null)
2536 rpcBaseURL = Session.getLocalData('rpcBaseURL');
2538 if (rpcBaseURL == null) {
2539 var rpcFallbackURL = this.url('admin/ubus');
2541 rpcBaseURL = Request.get(env.ubuspath).then(function(res) {
2542 return (rpcBaseURL = (res.status == 400) ? env.ubuspath : rpcFallbackURL);
2544 return (rpcBaseURL = rpcFallbackURL);
2545 }).then(function(url) {
2546 Session.setLocalData('rpcBaseURL', url);
2551 return Promise.resolve(rpcBaseURL);
2554 probeSystemFeatures: function() {
2555 if (sysFeatures == null)
2556 sysFeatures = Session.getLocalData('features');
2558 if (!this.isObject(sysFeatures)) {
2559 sysFeatures = classes.rpc.declare({
2561 method: 'getFeatures',
2563 })().then(function(features) {
2564 Session.setLocalData('features', features);
2565 sysFeatures = features;
2571 return Promise.resolve(sysFeatures);
2574 probePreloadClasses: function() {
2575 if (preloadClasses == null)
2576 preloadClasses = Session.getLocalData('preload');
2578 if (!Array.isArray(preloadClasses)) {
2579 preloadClasses = this.resolveDefault(classes.rpc.declare({
2583 expect: { 'entries': [] }
2584 })(this.fspath(this.resource('preload'))), []).then(function(entries) {
2587 for (var i = 0; i < entries.length; i++) {
2588 if (entries[i].type != 'file')
2591 var m = entries[i].name.match(/(.+)\.js$/);
2594 classes.push('preload.%s'.format(m[1]));
2597 Session.setLocalData('preload', classes);
2598 preloadClasses = classes;
2604 return Promise.resolve(preloadClasses);
2608 * Test whether a particular system feature is available, such as
2609 * hostapd SAE support or an installed firewall. The features are
2610 * queried once at the beginning of the LuCI session and cached in
2611 * `SessionStorage` throughout the lifetime of the associated tab or
2617 * @param {string} feature
2618 * The feature to test. For detailed list of known feature flags,
2619 * see `/modules/luci-base/root/usr/libexec/rpcd/luci`.
2621 * @param {string} [subfeature]
2622 * Some feature classes like `hostapd` provide sub-feature flags,
2623 * such as `sae` or `11w` support. The `subfeature` argument can
2624 * be used to query these.
2626 * @return {boolean|null}
2627 * Return `true` if the queried feature (and sub-feature) is available
2628 * or `false` if the requested feature isn't present or known.
2629 * Return `null` when a sub-feature was queried for a feature which
2630 * has no sub-features.
2632 hasSystemFeature: function() {
2633 var ft = sysFeatures[arguments[0]];
2635 if (arguments.length == 2)
2636 return this.isObject(ft) ? ft[arguments[1]] : null;
2638 return (ft != null && ft != false);
2642 notifySessionExpiry: function() {
2645 L.ui.showModal(_('Session expired'), [
2646 E('div', { class: 'alert-message warning' },
2647 _('A new login is required since the authentication session expired.')),
2648 E('div', { class: 'right' },
2650 class: 'btn primary',
2652 var loc = window.location;
2653 window.location = loc.protocol + '//' + loc.host + loc.pathname + loc.search;
2655 }, _('To login…')))
2658 L.raise('SessionError', 'Login session is expired');
2662 setupDOM: function(res) {
2667 rpcBaseURL = res[4];
2669 rpcClass.setBaseURL(rpcBaseURL);
2671 rpcClass.addInterceptor(function(msg, req) {
2672 if (!L.isObject(msg) || !L.isObject(msg.error) || msg.error.code != -32002)
2675 if (!L.isObject(req) || (req.object == 'session' && req.method == 'access'))
2678 return rpcClass.declare({
2679 'object': 'session',
2681 'params': [ 'scope', 'object', 'function' ],
2682 'expect': { access: true }
2683 })('uci', 'luci', 'read').catch(L.notifySessionExpiry);
2686 Request.addInterceptor(function(res) {
2687 var isDenied = false;
2689 if (res.status == 403 && res.headers.get('X-LuCI-Login-Required') == 'yes')
2695 L.notifySessionExpiry();
2698 return Promise.all([
2699 this.probeSystemFeatures(),
2700 this.probePreloadClasses()
2701 ]).finally(L.bind(function() {
2704 if (Array.isArray(preloadClasses))
2705 for (var i = 0; i < preloadClasses.length; i++)
2706 tasks.push(this.require(preloadClasses[i]));
2708 return Promise.all(tasks);
2709 }, this)).finally(this.initDOM);
2713 initDOM: function() {
2716 document.dispatchEvent(new CustomEvent('luci-loaded'));
2720 * The `env` object holds environment settings used by LuCI, such
2721 * as request timeouts, base URLs etc.
2729 * Construct an absolute filesystem path relative to the server
2735 * @param {...string} [parts]
2736 * An array of parts to join into a path.
2739 * Return the joined path.
2741 fspath: function(/* ... */) {
2742 var path = env.documentroot;
2744 for (var i = 0; i < arguments.length; i++)
2745 path += '/' + arguments[i];
2747 var p = path.replace(/\/+$/, '').replace(/\/+/g, '/').split(/\//),
2750 for (var i = 0; i < p.length; i++)
2753 else if (p[i] != '.')
2756 return res.join('/');
2760 * Construct a relative URL path from the given prefix and parts.
2761 * The resulting URL is guaranteed to only contain the characters
2762 * `a-z`, `A-Z`, `0-9`, `_`, `.`, `%`, `,`, `;`, and `-` as well
2763 * as `/` for the path separator.
2768 * @param {string} [prefix]
2769 * The prefix to join the given parts with. If the `prefix` is
2770 * omitted, it defaults to an empty string.
2772 * @param {string[]} [parts]
2773 * An array of parts to join into an URL path. Parts may contain
2774 * slashes and any of the other characters mentioned above.
2777 * Return the joined URL path.
2779 path: function(prefix, parts) {
2780 var url = [ prefix || '' ];
2782 for (var i = 0; i < parts.length; i++)
2783 if (/^(?:[a-zA-Z0-9_.%,;-]+\/)*[a-zA-Z0-9_.%,;-]+$/.test(parts[i]))
2784 url.push('/', parts[i]);
2786 if (url.length === 1)
2789 return url.join('');
2793 * Construct an URL pathrelative to the script path of the server
2794 * side LuCI application (usually `/cgi-bin/luci`).
2796 * The resulting URL is guaranteed to only contain the characters
2797 * `a-z`, `A-Z`, `0-9`, `_`, `.`, `%`, `,`, `;`, and `-` as well
2798 * as `/` for the path separator.
2803 * @param {string[]} [parts]
2804 * An array of parts to join into an URL path. Parts may contain
2805 * slashes and any of the other characters mentioned above.
2808 * Returns the resulting URL path.
2811 return this.path(env.scriptname, arguments);
2815 * Construct an URL path relative to the global static resource path
2816 * of the LuCI ui (usually `/luci-static/resources`).
2818 * The resulting URL is guaranteed to only contain the characters
2819 * `a-z`, `A-Z`, `0-9`, `_`, `.`, `%`, `,`, `;`, and `-` as well
2820 * as `/` for the path separator.
2825 * @param {string[]} [parts]
2826 * An array of parts to join into an URL path. Parts may contain
2827 * slashes and any of the other characters mentioned above.
2830 * Returns the resulting URL path.
2832 resource: function() {
2833 return this.path(env.resource, arguments);
2837 * Construct an URL path relative to the media resource path of the
2838 * LuCI ui (usually `/luci-static/$theme_name`).
2840 * The resulting URL is guaranteed to only contain the characters
2841 * `a-z`, `A-Z`, `0-9`, `_`, `.`, `%`, `,`, `;`, and `-` as well
2842 * as `/` for the path separator.
2847 * @param {string[]} [parts]
2848 * An array of parts to join into an URL path. Parts may contain
2849 * slashes and any of the other characters mentioned above.
2852 * Returns the resulting URL path.
2855 return this.path(env.media, arguments);
2859 * Return the complete URL path to the current view.
2865 * Returns the URL path to the current view.
2867 location: function() {
2868 return this.path(env.scriptname, env.requestpath);
2873 * Tests whether the passed argument is a JavaScript object.
2874 * This function is meant to be an object counterpart to the
2875 * standard `Array.isArray()` function.
2884 * Returns `true` if the given value is of type object and
2885 * not `null`, else returns `false`.
2887 isObject: function(val) {
2888 return (val != null && typeof(val) == 'object');
2892 * Return an array of sorted object keys, optionally sorted by
2893 * a different key or a different sorting mode.
2898 * @param {object} obj
2899 * The object to extract the keys from. If the given value is
2900 * not an object, the function will return an empty array.
2902 * @param {string} [key]
2903 * Specifies the key to order by. This is mainly useful for
2904 * nested objects of objects or objects of arrays when sorting
2905 * shall not be performed by the primary object keys but by
2906 * some other key pointing to a value within the nested values.
2908 * @param {string} [sortmode]
2909 * May be either `addr` or `num` to override the natural
2910 * lexicographic sorting with a sorting suitable for IP/MAC style
2911 * addresses or numeric values respectively.
2913 * @return {string[]}
2914 * Returns an array containing the sorted keys of the given object.
2916 sortedKeys: function(obj, key, sortmode) {
2917 if (obj == null || typeof(obj) != 'object')
2920 return Object.keys(obj).map(function(e) {
2921 var v = (key != null) ? obj[e][key] : e;
2925 v = (v != null) ? v.replace(/(?:^|[.:])([0-9a-fA-F]{1,4})/g,
2926 function(m0, m1) { return ('000' + m1.toLowerCase()).substr(-4) }) : null;
2930 v = (v != null) ? +v : null;
2935 }).filter(function(e) {
2936 return (e[1] != null);
2937 }).sort(function(a, b) {
2938 return (a[1] > b[1]);
2939 }).map(function(e) {
2945 * Converts the given value to an array. If the given value is of
2946 * type array, it is returned as-is, values of type object are
2947 * returned as one-element array containing the object, empty
2948 * strings and `null` values are returned as empty array, all other
2949 * values are converted using `String()`, trimmed, split on white
2950 * space and returned as array.
2956 * The value to convert into an array.
2958 * @return {Array<*>}
2959 * Returns the resulting array.
2961 toArray: function(val) {
2964 else if (Array.isArray(val))
2966 else if (typeof(val) == 'object')
2969 var s = String(val).trim();
2974 return s.split(/\s+/);
2978 * Returns a promise resolving with either the given value or or with
2979 * the given default in case the input value is a rejecting promise.
2985 * The value to resolve the promise with.
2987 * @param {*} defvalue
2988 * The default value to resolve the promise with in case the given
2989 * input value is a rejecting promise.
2991 * @returns {Promise<*>}
2992 * Returns a new promise resolving either to the given input value or
2993 * to the given default value on error.
2995 resolveDefault: function(value, defvalue) {
2996 return Promise.resolve(value).catch(function() { return defvalue });
3000 * The request callback function is invoked whenever an HTTP
3001 * reply to a request made using the `L.get()`, `L.post()` or
3002 * `L.poll()` function is timed out or received successfully.
3007 * @callback LuCI.requestCallbackFn
3008 * @param {XMLHTTPRequest} xhr
3009 * The XMLHTTPRequest instance used to make the request.
3012 * The response JSON if the response could be parsed as such,
3015 * @param {number} duration
3016 * The total duration of the request in milliseconds.
3020 * Issues a GET request to the given url and invokes the specified
3021 * callback function. The function is a wrapper around
3022 * {@link LuCI.request#request Request.request()}.
3028 * @param {string} url
3029 * The URL to request.
3031 * @param {Object<string, string>} [args]
3032 * Additional query string arguments to append to the URL.
3034 * @param {LuCI.requestCallbackFn} cb
3035 * The callback function to invoke when the request finishes.
3037 * @return {Promise<null>}
3038 * Returns a promise resolving to `null` when concluded.
3040 get: function(url, args, cb) {
3041 return this.poll(null, url, args, cb, false);
3045 * Issues a POST request to the given url and invokes the specified
3046 * callback function. The function is a wrapper around
3047 * {@link LuCI.request#request Request.request()}. The request is
3048 * sent using `application/x-www-form-urlencoded` encoding and will
3049 * contain a field `token` with the current value of `LuCI.env.token`
3056 * @param {string} url
3057 * The URL to request.
3059 * @param {Object<string, string>} [args]
3060 * Additional post arguments to append to the request body.
3062 * @param {LuCI.requestCallbackFn} cb
3063 * The callback function to invoke when the request finishes.
3065 * @return {Promise<null>}
3066 * Returns a promise resolving to `null` when concluded.
3068 post: function(url, args, cb) {
3069 return this.poll(null, url, args, cb, true);
3073 * Register a polling HTTP request that invokes the specified
3074 * callback function. The function is a wrapper around
3075 * {@link LuCI.request.poll#add Request.poll.add()}.
3081 * @param {number} interval
3082 * The poll interval to use. If set to a value less than or equal
3083 * to `0`, it will default to the global poll interval configured
3084 * in `LuCI.env.pollinterval`.
3086 * @param {string} url
3087 * The URL to request.
3089 * @param {Object<string, string>} [args]
3090 * Specifies additional arguments for the request. For GET requests,
3091 * the arguments are appended to the URL as query string, for POST
3092 * requests, they'll be added to the request body.
3094 * @param {LuCI.requestCallbackFn} cb
3095 * The callback function to invoke whenever a request finishes.
3097 * @param {boolean} [post=false]
3098 * When set to `false` or not specified, poll requests will be made
3099 * using the GET method. When set to `true`, POST requests will be
3100 * issued. In case of POST requests, the request body will contain
3101 * an argument `token` with the current value of `LuCI.env.token` by
3102 * default, regardless of the parameters specified with `args`.
3104 * @return {function}
3105 * Returns the internally created function that has been passed to
3106 * {@link LuCI.request.poll#add Request.poll.add()}. This value can
3107 * be passed to {@link LuCI.poll.remove Poll.remove()} to remove the
3110 poll: function(interval, url, args, cb, post) {
3111 if (interval !== null && interval <= 0)
3112 interval = env.pollinterval;
3114 var data = post ? { token: env.token } : null,
3115 method = post ? 'POST' : 'GET';
3117 if (!/^(?:\/|\S+:\/\/)/.test(url))
3118 url = this.url(url);
3121 data = Object.assign(data || {}, args);
3123 if (interval !== null)
3124 return Request.poll.add(interval, url, { method: method, query: data }, cb);
3126 return Request.request(url, { method: method, query: data })
3127 .then(function(res) {
3129 if (/^application\/json\b/.test(res.headers.get('Content-Type')))
3130 try { json = res.json() } catch(e) {}
3131 cb(res.xhr, json, res.duration);
3136 * Check whether a view has sufficient permissions.
3138 * @return {boolean|null}
3139 * Returns `null` if the current session has no permission at all to
3140 * load resources required by the view. Returns `false` if readonly
3141 * permissions are granted or `true` if at least one required ACL
3142 * group is granted with write permissions.
3144 hasViewPermission: function() {
3145 if (!this.isObject(env.nodespec) || !env.nodespec.satisfied)
3148 return !env.nodespec.readonly;
3152 * Deprecated wrapper around {@link LuCI.poll.remove Poll.remove()}.
3158 * @param {function} entry
3159 * The polling function to remove.
3162 * Returns `true` when the function has been removed or `false` if
3163 * it could not be found.
3165 stop: function(entry) { return Poll.remove(entry) },
3168 * Deprecated wrapper around {@link LuCI.poll.stop Poll.stop()}.
3175 * Returns `true` when the polling loop has been stopped or `false`
3176 * when it didn't run to begin with.
3178 halt: function() { return Poll.stop() },
3181 * Deprecated wrapper around {@link LuCI.poll.start Poll.start()}.
3188 * Returns `true` when the polling loop has been started or `false`
3189 * when it was already running.
3191 run: function() { return Poll.start() },
3194 * Legacy `L.dom` class alias. New view code should use `'require dom';`
3195 * to request the `LuCI.dom` class.
3204 * Legacy `L.view` class alias. New view code should use `'require view';`
3205 * to request the `LuCI.view` class.
3214 * Legacy `L.Poll` class alias. New view code should use `'require poll';`
3215 * to request the `LuCI.poll` class.
3224 * Legacy `L.Request` class alias. New view code should use `'require request';`
3225 * to request the `LuCI.request` class.
3234 * Legacy `L.Class` class alias. New view code should use `'require baseclass';`
3235 * to request the `LuCI.baseclass` class.
3250 * The `LuCI.xhr` class is a legacy compatibility shim for the
3251 * functionality formerly provided by `xhr.js`. It is registered as global
3252 * `window.XHR` symbol for compatibility with legacy code.
3254 * New code should use {@link LuCI.request} instead to implement HTTP
3257 var XHR = Class.extend(/** @lends LuCI.xhr.prototype */ {
3258 __name__: 'LuCI.xhr',
3259 __init__: function() {
3260 if (window.console && console.debug)
3261 console.debug('Direct use XHR() is deprecated, please use L.Request instead');
3264 _response: function(cb, res, json, duration) {
3266 cb(res, json, duration);
3271 * This function is a legacy wrapper around
3272 * {@link LuCI#get LuCI.get()}.
3276 * @memberof LuCI.xhr
3278 * @param {string} url
3279 * The URL to request
3281 * @param {Object} [data]
3282 * Additional query string data
3284 * @param {LuCI.requestCallbackFn} [callback]
3285 * Callback function to invoke on completion
3287 * @param {number} [timeout]
3288 * Request timeout to use
3290 * @return {Promise<null>}
3292 get: function(url, data, callback, timeout) {
3294 L.get(url, data, this._response.bind(this, callback), timeout);
3298 * This function is a legacy wrapper around
3299 * {@link LuCI#post LuCI.post()}.
3303 * @memberof LuCI.xhr
3305 * @param {string} url
3306 * The URL to request
3308 * @param {Object} [data]
3309 * Additional data to append to the request body.
3311 * @param {LuCI.requestCallbackFn} [callback]
3312 * Callback function to invoke on completion
3314 * @param {number} [timeout]
3315 * Request timeout to use
3317 * @return {Promise<null>}
3319 post: function(url, data, callback, timeout) {
3321 L.post(url, data, this._response.bind(this, callback), timeout);
3325 * Cancels a running request.
3327 * This function does not actually cancel the underlying
3328 * `XMLHTTPRequest` request but it sets a flag which prevents the
3329 * invocation of the callback function when the request eventually
3330 * finishes or timed out.
3334 * @memberof LuCI.xhr
3336 cancel: function() { delete this.active },
3339 * Checks the running state of the request.
3343 * @memberof LuCI.xhr
3345 * @returns {boolean}
3346 * Returns `true` if the request is still running or `false` if it
3347 * already completed.
3349 busy: function() { return (this.active === true) },
3352 * Ignored for backwards compatibility.
3354 * This function does nothing.
3358 * @memberof LuCI.xhr
3360 abort: function() {},
3363 * Existing for backwards compatibility.
3365 * This function simply throws an `InternalError` when invoked.
3369 * @memberof LuCI.xhr
3371 * @throws {InternalError}
3372 * Throws an `InternalError` with the message `Not implemented`
3375 send_form: function() { L.error('InternalError', 'Not implemented') },
3378 XHR.get = function() { return window.L.get.apply(window.L, arguments) };
3379 XHR.post = function() { return window.L.post.apply(window.L, arguments) };
3380 XHR.poll = function() { return window.L.poll.apply(window.L, arguments) };
3381 XHR.stop = Request.poll.remove.bind(Request.poll);
3382 XHR.halt = Request.poll.stop.bind(Request.poll);
3383 XHR.run = Request.poll.start.bind(Request.poll);
3384 XHR.running = Request.poll.active.bind(Request.poll);
3388 })(window, document);