]> git.proxmox.com Git - proxmox-widget-toolkit.git/blob - src/Utils.js
ui: Utils: refactor userid parsing to Utils
[proxmox-widget-toolkit.git] / src / Utils.js
1 Ext.ns('Proxmox');
2 Ext.ns('Proxmox.Setup');
3
4 if (!Ext.isDefined(Proxmox.Setup.auth_cookie_name)) {
5 throw "Proxmox library not initialized";
6 }
7
8 // avoid errors when running without development tools
9 if (!Ext.isDefined(Ext.global.console)) {
10 let console = {
11 dir: function() {
12 // do nothing
13 },
14 log: function() {
15 // do nothing
16 },
17 warn: function() {
18 // do nothing
19 },
20 };
21 Ext.global.console = console;
22 }
23
24 Ext.Ajax.defaultHeaders = {
25 'Accept': 'application/json',
26 };
27
28 Ext.Ajax.on('beforerequest', function(conn, options) {
29 if (Proxmox.CSRFPreventionToken) {
30 if (!options.headers) {
31 options.headers = {};
32 }
33 options.headers.CSRFPreventionToken = Proxmox.CSRFPreventionToken;
34 }
35 let storedAuth = Proxmox.Utils.getStoredAuth();
36 if (storedAuth.token) {
37 options.headers.Authorization = storedAuth.token;
38 }
39 });
40
41 Ext.define('Proxmox.Utils', { // a singleton
42 utilities: {
43
44 yesText: gettext('Yes'),
45 noText: gettext('No'),
46 enabledText: gettext('Enabled'),
47 disabledText: gettext('Disabled'),
48 noneText: gettext('none'),
49 NoneText: gettext('None'),
50 errorText: gettext('Error'),
51 warningsText: gettext('Warnings'),
52 unknownText: gettext('Unknown'),
53 defaultText: gettext('Default'),
54 daysText: gettext('days'),
55 dayText: gettext('day'),
56 runningText: gettext('running'),
57 stoppedText: gettext('stopped'),
58 neverText: gettext('never'),
59 totalText: gettext('Total'),
60 usedText: gettext('Used'),
61 directoryText: gettext('Directory'),
62 stateText: gettext('State'),
63 groupText: gettext('Group'),
64
65 language_map: {
66 ar: 'Arabic',
67 ca: 'Catalan',
68 zh_CN: 'Chinese (Simplified)',
69 zh_TW: 'Chinese (Traditional)',
70 da: 'Danish',
71 nl: 'Dutch',
72 en: 'English',
73 eu: 'Euskera (Basque)',
74 fr: 'French',
75 de: 'German',
76 he: 'Hebrew',
77 it: 'Italian',
78 ja: 'Japanese',
79 kr: 'Korean',
80 nb: 'Norwegian (Bokmal)',
81 nn: 'Norwegian (Nynorsk)',
82 fa: 'Persian (Farsi)',
83 pl: 'Polish',
84 pt_BR: 'Portuguese (Brazil)',
85 ru: 'Russian',
86 sl: 'Slovenian',
87 es: 'Spanish',
88 sv: 'Swedish',
89 tr: 'Turkish',
90 },
91
92 render_language: function(value) {
93 if (!value) {
94 return Proxmox.Utils.defaultText + ' (English)';
95 }
96 let text = Proxmox.Utils.language_map[value];
97 if (text) {
98 return text + ' (' + value + ')';
99 }
100 return value;
101 },
102
103 language_array: function() {
104 let data = [['__default__', Proxmox.Utils.render_language('')]];
105 Ext.Object.each(Proxmox.Utils.language_map, function(key, value) {
106 data.push([key, Proxmox.Utils.render_language(value)]);
107 });
108
109 return data;
110 },
111
112 bond_mode_gettext_map: {
113 '802.3ad': 'LACP (802.3ad)',
114 'lacp-balance-slb': 'LACP (balance-slb)',
115 'lacp-balance-tcp': 'LACP (balance-tcp)',
116 },
117
118 render_bond_mode: value => Proxmox.Utils.bond_mode_gettext_map[value] || value || '',
119
120 bond_mode_array: function(modes) {
121 return modes.map(mode => [mode, Proxmox.Utils.render_bond_mode(mode)]);
122 },
123
124 getNoSubKeyHtml: function(url) {
125 // url http://www.proxmox.com/products/proxmox-ve/subscription-service-plans
126 return Ext.String.format('You do not have a valid subscription for this server. Please visit <a target="_blank" href="{0}">www.proxmox.com</a> to get a list of available options.', url || 'https://www.proxmox.com');
127 },
128
129 format_boolean_with_default: function(value) {
130 if (Ext.isDefined(value) && value !== '__default__') {
131 return value ? Proxmox.Utils.yesText : Proxmox.Utils.noText;
132 }
133 return Proxmox.Utils.defaultText;
134 },
135
136 format_boolean: function(value) {
137 return value ? Proxmox.Utils.yesText : Proxmox.Utils.noText;
138 },
139
140 format_neg_boolean: function(value) {
141 return !value ? Proxmox.Utils.yesText : Proxmox.Utils.noText;
142 },
143
144 format_enabled_toggle: function(value) {
145 return value ? Proxmox.Utils.enabledText : Proxmox.Utils.disabledText;
146 },
147
148 format_expire: function(date) {
149 if (!date) {
150 return Proxmox.Utils.neverText;
151 }
152 return Ext.Date.format(date, "Y-m-d");
153 },
154
155 // somewhat like a human would tell durations, omit zero values and do not
156 // give seconds precision if we talk days already
157 format_duration_human: function(ut) {
158 let seconds = 0, minutes = 0, hours = 0, days = 0;
159
160 if (ut <= 0.1) {
161 return '<0.1s';
162 }
163
164 let remaining = ut;
165 seconds = Number((remaining % 60).toFixed(1));
166 remaining = Math.trunc(remaining / 60);
167 if (remaining > 0) {
168 minutes = remaining % 60;
169 remaining = Math.trunc(remaining / 60);
170 if (remaining > 0) {
171 hours = remaining % 24;
172 remaining = Math.trunc(remaining / 24);
173 if (remaining > 0) {
174 days = remaining;
175 }
176 }
177 }
178
179 let res = [];
180 let add = (t, unit) => {
181 if (t > 0) res.push(t + unit);
182 return t > 0;
183 };
184
185 let addSeconds = !add(days, 'd');
186 add(hours, 'h');
187 add(minutes, 'm');
188 if (addSeconds) {
189 add(seconds, 's');
190 }
191 return res.join(' ');
192 },
193
194 format_duration_long: function(ut) {
195 let days = Math.floor(ut / 86400);
196 ut -= days*86400;
197 let hours = Math.floor(ut / 3600);
198 ut -= hours*3600;
199 let mins = Math.floor(ut / 60);
200 ut -= mins*60;
201
202 let hours_str = '00' + hours.toString();
203 hours_str = hours_str.substr(hours_str.length - 2);
204 let mins_str = "00" + mins.toString();
205 mins_str = mins_str.substr(mins_str.length - 2);
206 let ut_str = "00" + ut.toString();
207 ut_str = ut_str.substr(ut_str.length - 2);
208
209 if (days) {
210 let ds = days > 1 ? Proxmox.Utils.daysText : Proxmox.Utils.dayText;
211 return days.toString() + ' ' + ds + ' ' +
212 hours_str + ':' + mins_str + ':' + ut_str;
213 } else {
214 return hours_str + ':' + mins_str + ':' + ut_str;
215 }
216 },
217
218 format_subscription_level: function(level) {
219 if (level === 'c') {
220 return 'Community';
221 } else if (level === 'b') {
222 return 'Basic';
223 } else if (level === 's') {
224 return 'Standard';
225 } else if (level === 'p') {
226 return 'Premium';
227 } else {
228 return Proxmox.Utils.noneText;
229 }
230 },
231
232 compute_min_label_width: function(text, width) {
233 if (width === undefined) { width = 100; }
234
235 let tm = new Ext.util.TextMetrics();
236 let min = tm.getWidth(text + ':');
237
238 return min < width ? width : min;
239 },
240
241 // returns username + realm
242 parse_userid: function(userid) {
243 if (!Ext.isString(userid)) {
244 return [undefined, undefined];
245 }
246
247 let match = userid.match(/^(.+)@([^@]+)$/);
248 if (match !== null) {
249 return [match[1], match[2]];
250 }
251
252 return [undefined, undefined];
253 },
254
255 render_username: function(userid) {
256 let username = PVE.Utils.parse_userid(userid)[0] || "";
257 return Ext.htmlEncode(username);
258 },
259
260 render_realm: function(userid) {
261 let username = PVE.Utils.parse_userid(userid)[1] || "";
262 return Ext.htmlEncode(username);
263 },
264
265 getStoredAuth: function() {
266 let storedAuth = JSON.parse(window.localStorage.getItem('ProxmoxUser'));
267 return storedAuth || {};
268 },
269
270 setAuthData: function(data) {
271 Proxmox.UserName = data.username;
272 Proxmox.LoggedOut = data.LoggedOut;
273 // creates a session cookie (expire = null)
274 // that way the cookie gets deleted after the browser window is closed
275 if (data.ticket) {
276 Proxmox.CSRFPreventionToken = data.CSRFPreventionToken;
277 Ext.util.Cookies.set(Proxmox.Setup.auth_cookie_name, data.ticket, null, '/', null, true);
278 }
279
280 if (data.token) {
281 window.localStorage.setItem('ProxmoxUser', JSON.stringify(data));
282 }
283 },
284
285 authOK: function() {
286 if (Proxmox.LoggedOut) {
287 return undefined;
288 }
289 let storedAuth = Proxmox.Utils.getStoredAuth();
290 let cookie = Ext.util.Cookies.get(Proxmox.Setup.auth_cookie_name);
291 if ((Proxmox.UserName !== '' && cookie && !cookie.startsWith("PVE:tfa!")) || storedAuth.token) {
292 return cookie || storedAuth.token;
293 } else {
294 return false;
295 }
296 },
297
298 authClear: function() {
299 if (Proxmox.LoggedOut) {
300 return;
301 }
302 Ext.util.Cookies.clear(Proxmox.Setup.auth_cookie_name);
303 window.localStorage.removeItem("ProxmoxUser");
304 },
305
306 // The End-User gets redirected back here after login on the OpenID auth. portal, and in the
307 // redirection URL the state and auth.code are passed as URL GET params, this helper parses those
308 getOpenIDRedirectionAuthorization: function() {
309 const auth = Ext.Object.fromQueryString(window.location.search);
310 if (auth.state !== undefined && auth.code !== undefined) {
311 return auth;
312 }
313 return undefined;
314 },
315
316 // comp.setLoading() is buggy in ExtJS 4.0.7, so we
317 // use el.mask() instead
318 setErrorMask: function(comp, msg) {
319 let el = comp.el;
320 if (!el) {
321 return;
322 }
323 if (!msg) {
324 el.unmask();
325 } else if (msg === true) {
326 el.mask(gettext("Loading..."));
327 } else {
328 el.mask(msg);
329 }
330 },
331
332 getResponseErrorMessage: (err) => {
333 if (!err.statusText) {
334 return gettext('Connection error');
335 }
336 let msg = [`${err.statusText} (${err.status})`];
337 if (err.response && err.response.responseText) {
338 let txt = err.response.responseText;
339 try {
340 let res = JSON.parse(txt);
341 if (res.errors && typeof res.errors === 'object') {
342 for (let [key, value] of Object.entries(res.errors)) {
343 msg.push(Ext.String.htmlEncode(`${key}: ${value}`));
344 }
345 }
346 } catch (e) {
347 // fallback to string
348 msg.push(Ext.String.htmlEncode(txt));
349 }
350 }
351 return msg.join('<br>');
352 },
353
354 monStoreErrors: function(component, store, clearMaskBeforeLoad, errorCallback) {
355 if (clearMaskBeforeLoad) {
356 component.mon(store, 'beforeload', function(s, operation, eOpts) {
357 Proxmox.Utils.setErrorMask(component, false);
358 });
359 } else {
360 component.mon(store, 'beforeload', function(s, operation, eOpts) {
361 if (!component.loadCount) {
362 component.loadCount = 0; // make sure it is nucomponent.ic
363 Proxmox.Utils.setErrorMask(component, true);
364 }
365 });
366 }
367
368 // only works with 'proxmox' proxy
369 component.mon(store.proxy, 'afterload', function(proxy, request, success) {
370 component.loadCount++;
371
372 if (success) {
373 Proxmox.Utils.setErrorMask(component, false);
374 return;
375 }
376
377 let error = request._operation.getError();
378 let msg = Proxmox.Utils.getResponseErrorMessage(error);
379 if (!errorCallback || !errorCallback(error, msg)) {
380 Proxmox.Utils.setErrorMask(component, msg);
381 }
382 });
383 },
384
385 extractRequestError: function(result, verbose) {
386 let msg = gettext('Successful');
387
388 if (!result.success) {
389 msg = gettext("Unknown error");
390 if (result.message) {
391 msg = result.message;
392 if (result.status) {
393 msg += ' (' + result.status + ')';
394 }
395 }
396 if (verbose && Ext.isObject(result.errors)) {
397 msg += "<br>";
398 Ext.Object.each(result.errors, function(prop, desc) {
399 msg += "<br><b>" + Ext.htmlEncode(prop) + "</b>: " +
400 Ext.htmlEncode(desc);
401 });
402 }
403 }
404
405 return msg;
406 },
407
408 // Ext.Ajax.request
409 API2Request: function(reqOpts) {
410 let newopts = Ext.apply({
411 waitMsg: gettext('Please wait...'),
412 }, reqOpts);
413
414 if (!newopts.url.match(/^\/api2/)) {
415 newopts.url = '/api2/extjs' + newopts.url;
416 }
417 delete newopts.callback;
418
419 let createWrapper = function(successFn, callbackFn, failureFn) {
420 Ext.apply(newopts, {
421 success: function(response, options) {
422 if (options.waitMsgTarget) {
423 if (Proxmox.Utils.toolkit === 'touch') {
424 options.waitMsgTarget.setMasked(false);
425 } else {
426 options.waitMsgTarget.setLoading(false);
427 }
428 }
429 let result = Ext.decode(response.responseText);
430 response.result = result;
431 if (!result.success) {
432 response.htmlStatus = Proxmox.Utils.extractRequestError(result, true);
433 Ext.callback(callbackFn, options.scope, [options, false, response]);
434 Ext.callback(failureFn, options.scope, [response, options]);
435 return;
436 }
437 Ext.callback(callbackFn, options.scope, [options, true, response]);
438 Ext.callback(successFn, options.scope, [response, options]);
439 },
440 failure: function(response, options) {
441 if (options.waitMsgTarget) {
442 if (Proxmox.Utils.toolkit === 'touch') {
443 options.waitMsgTarget.setMasked(false);
444 } else {
445 options.waitMsgTarget.setLoading(false);
446 }
447 }
448 response.result = {};
449 try {
450 response.result = Ext.decode(response.responseText);
451 } catch (e) {
452 // ignore
453 }
454 let msg = gettext('Connection error') + ' - server offline?';
455 if (response.aborted) {
456 msg = gettext('Connection error') + ' - aborted.';
457 } else if (response.timedout) {
458 msg = gettext('Connection error') + ' - Timeout.';
459 } else if (response.status && response.statusText) {
460 msg = gettext('Connection error') + ' ' + response.status + ': ' + response.statusText;
461 }
462 response.htmlStatus = msg;
463 Ext.callback(callbackFn, options.scope, [options, false, response]);
464 Ext.callback(failureFn, options.scope, [response, options]);
465 },
466 });
467 };
468
469 createWrapper(reqOpts.success, reqOpts.callback, reqOpts.failure);
470
471 let target = newopts.waitMsgTarget;
472 if (target) {
473 if (Proxmox.Utils.toolkit === 'touch') {
474 target.setMasked({ xtype: 'loadmask', message: newopts.waitMsg });
475 } else {
476 // Note: ExtJS bug - this does not work when component is not rendered
477 target.setLoading(newopts.waitMsg);
478 }
479 }
480 Ext.Ajax.request(newopts);
481 },
482
483 // can be useful for catching displaying errors from the API, e.g.:
484 // Proxmox.Async.api2({
485 // ...
486 // }).catch(Proxmox.Utils.alertResponseFailure);
487 alertResponseFailure: (response) => {
488 Ext.Msg.alert(
489 gettext('Error'),
490 response.htmlStatus || response.result.message,
491 );
492 },
493
494 checked_command: function(orig_cmd) {
495 Proxmox.Utils.API2Request(
496 {
497 url: '/nodes/localhost/subscription',
498 method: 'GET',
499 failure: function(response, opts) {
500 Ext.Msg.alert(gettext('Error'), response.htmlStatus);
501 },
502 success: function(response, opts) {
503 let res = response.result;
504 if (res === null || res === undefined || !res || res
505 .data.status.toLowerCase() !== 'active') {
506 Ext.Msg.show({
507 title: gettext('No valid subscription'),
508 icon: Ext.Msg.WARNING,
509 message: Proxmox.Utils.getNoSubKeyHtml(res.data.url),
510 buttons: Ext.Msg.OK,
511 callback: function(btn) {
512 if (btn !== 'ok') {
513 return;
514 }
515 orig_cmd();
516 },
517 });
518 } else {
519 orig_cmd();
520 }
521 },
522 },
523 );
524 },
525
526 assemble_field_data: function(values, data) {
527 if (!Ext.isObject(data)) {
528 return;
529 }
530 Ext.Object.each(data, function(name, val) {
531 if (Object.prototype.hasOwnProperty.call(values, name)) {
532 let bucket = values[name];
533 if (!Ext.isArray(bucket)) {
534 bucket = values[name] = [bucket];
535 }
536 if (Ext.isArray(val)) {
537 values[name] = bucket.concat(val);
538 } else {
539 bucket.push(val);
540 }
541 } else {
542 values[name] = val;
543 }
544 });
545 },
546
547 updateColumnWidth: function(container) {
548 let mode = Ext.state.Manager.get('summarycolumns') || 'auto';
549 let factor;
550 if (mode !== 'auto') {
551 factor = parseInt(mode, 10);
552 if (Number.isNaN(factor)) {
553 factor = 1;
554 }
555 } else {
556 factor = container.getSize().width < 1600 ? 1 : 2;
557 }
558
559 if (container.oldFactor === factor) {
560 return;
561 }
562
563 let items = container.query('>'); // direct childs
564 factor = Math.min(factor, items.length);
565 container.oldFactor = factor;
566
567 items.forEach((item) => {
568 item.columnWidth = 1 / factor;
569 });
570
571 // we have to update the layout twice, since the first layout change
572 // can trigger the scrollbar which reduces the amount of space left
573 container.updateLayout();
574 container.updateLayout();
575 },
576
577 dialog_title: function(subject, create, isAdd) {
578 if (create) {
579 if (isAdd) {
580 return gettext('Add') + ': ' + subject;
581 } else {
582 return gettext('Create') + ': ' + subject;
583 }
584 } else {
585 return gettext('Edit') + ': ' + subject;
586 }
587 },
588
589 network_iface_types: {
590 eth: gettext("Network Device"),
591 bridge: 'Linux Bridge',
592 bond: 'Linux Bond',
593 vlan: 'Linux VLAN',
594 OVSBridge: 'OVS Bridge',
595 OVSBond: 'OVS Bond',
596 OVSPort: 'OVS Port',
597 OVSIntPort: 'OVS IntPort',
598 },
599
600 render_network_iface_type: function(value) {
601 return Proxmox.Utils.network_iface_types[value] ||
602 Proxmox.Utils.unknownText;
603 },
604
605 // NOTE: only add general, product agnostic, ones here! Else use override helper in product repos
606 task_desc_table: {
607 aptupdate: ['', gettext('Update package database')],
608 diskinit: ['Disk', gettext('Initialize Disk with GPT')],
609 spiceshell: ['', gettext('Shell') + ' (Spice)'],
610 srvreload: ['SRV', gettext('Reload')],
611 srvrestart: ['SRV', gettext('Restart')],
612 srvstart: ['SRV', gettext('Start')],
613 srvstop: ['SRV', gettext('Stop')],
614 termproxy: ['', gettext('Console') + ' (xterm.js)'],
615 vncshell: ['', gettext('Shell')],
616 },
617
618 // to add or change existing for product specific ones
619 override_task_descriptions: function(extra) {
620 for (const [key, value] of Object.entries(extra)) {
621 Proxmox.Utils.task_desc_table[key] = value;
622 }
623 },
624
625 format_task_description: function(type, id) {
626 let farray = Proxmox.Utils.task_desc_table[type];
627 let text;
628 if (!farray) {
629 text = type;
630 if (id) {
631 type += ' ' + id;
632 }
633 return text;
634 } else if (Ext.isFunction(farray)) {
635 return farray(type, id);
636 }
637 let prefix = farray[0];
638 text = farray[1];
639 if (prefix && id !== undefined) {
640 return prefix + ' ' + id + ' - ' + text;
641 }
642 return text;
643 },
644
645 format_size: function(size, useSI) {
646 let units = ['', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'];
647 let order = 0;
648 const baseValue = useSI ? 1000 : 1024;
649 while (size >= baseValue && order < units.length) {
650 size = size / baseValue;
651 order++;
652 }
653
654 let unit = units[order], commaDigits = 2;
655 if (order === 0) {
656 commaDigits = 0;
657 } else if (!useSI) {
658 unit += 'i';
659 }
660 return `${size.toFixed(commaDigits)} ${unit}B`;
661 },
662
663 render_upid: function(value, metaData, record) {
664 let task = record.data;
665 let type = task.type || task.worker_type;
666 let id = task.id || task.worker_id;
667
668 return Proxmox.Utils.format_task_description(type, id);
669 },
670
671 render_uptime: function(value) {
672 let uptime = value;
673
674 if (uptime === undefined) {
675 return '';
676 }
677
678 if (uptime <= 0) {
679 return '-';
680 }
681
682 return Proxmox.Utils.format_duration_long(uptime);
683 },
684
685 systemd_unescape: function(string_value) {
686 const charcode_0 = '0'.charCodeAt(0);
687 const charcode_9 = '9'.charCodeAt(0);
688 const charcode_A = 'A'.charCodeAt(0);
689 const charcode_F = 'F'.charCodeAt(0);
690 const charcode_a = 'a'.charCodeAt(0);
691 const charcode_f = 'f'.charCodeAt(0);
692 const charcode_x = 'x'.charCodeAt(0);
693 const charcode_minus = '-'.charCodeAt(0);
694 const charcode_slash = '/'.charCodeAt(0);
695 const charcode_backslash = '\\'.charCodeAt(0);
696
697 let parse_hex_digit = function(d) {
698 if (d >= charcode_0 && d <= charcode_9) {
699 return d - charcode_0;
700 }
701 if (d >= charcode_A && d <= charcode_F) {
702 return d - charcode_A + 10;
703 }
704 if (d >= charcode_a && d <= charcode_f) {
705 return d - charcode_a + 10;
706 }
707 throw "got invalid hex digit";
708 };
709
710 let value = new TextEncoder().encode(string_value);
711 let result = new Uint8Array(value.length);
712
713 let i = 0;
714 let result_len = 0;
715
716 while (i < value.length) {
717 let c0 = value[i];
718 if (c0 === charcode_minus) {
719 result.set([charcode_slash], result_len);
720 result_len += 1;
721 i += 1;
722 continue;
723 }
724 if ((i + 4) < value.length) {
725 let c1 = value[i+1];
726 if (c0 === charcode_backslash && c1 === charcode_x) {
727 let h1 = parse_hex_digit(value[i+2]);
728 let h0 = parse_hex_digit(value[i+3]);
729 let ord = h1*16+h0;
730 result.set([ord], result_len);
731 result_len += 1;
732 i += 4;
733 continue;
734 }
735 }
736 result.set([c0], result_len);
737 result_len += 1;
738 i += 1;
739 }
740
741 return new TextDecoder().decode(result.slice(0, result.len));
742 },
743
744 parse_task_upid: function(upid) {
745 let task = {};
746
747 let res = upid.match(/^UPID:([^\s:]+):([0-9A-Fa-f]{8}):([0-9A-Fa-f]{8,9}):(([0-9A-Fa-f]{8,16}):)?([0-9A-Fa-f]{8}):([^:\s]+):([^:\s]*):([^:\s]+):$/);
748 if (!res) {
749 throw "unable to parse upid '" + upid + "'";
750 }
751 task.node = res[1];
752 task.pid = parseInt(res[2], 16);
753 task.pstart = parseInt(res[3], 16);
754 if (res[5] !== undefined) {
755 task.task_id = parseInt(res[5], 16);
756 }
757 task.starttime = parseInt(res[6], 16);
758 task.type = res[7];
759 task.id = Proxmox.Utils.systemd_unescape(res[8]);
760 task.user = res[9];
761
762 task.desc = Proxmox.Utils.format_task_description(task.type, task.id);
763
764 return task;
765 },
766
767 parse_task_status: function(status) {
768 if (status === 'OK') {
769 return 'ok';
770 }
771
772 if (status === 'unknown') {
773 return 'unknown';
774 }
775
776 let match = status.match(/^WARNINGS: (.*)$/);
777 if (match) {
778 return 'warning';
779 }
780
781 return 'error';
782 },
783
784 format_task_status: function(status) {
785 let parsed = Proxmox.Utils.parse_task_status(status);
786 switch (parsed) {
787 case 'unknown': return Proxmox.Utils.unknownText;
788 case 'error': return Proxmox.Utils.errorText + ': ' + status;
789 case 'warning': return status.replace('WARNINGS', Proxmox.Utils.warningsText);
790 case 'ok': // fall-through
791 default: return status;
792 }
793 },
794
795 render_duration: function(value) {
796 if (value === undefined) {
797 return '-';
798 }
799 return Proxmox.Utils.format_duration_human(value);
800 },
801
802 render_timestamp: function(value, metaData, record, rowIndex, colIndex, store) {
803 let servertime = new Date(value * 1000);
804 return Ext.Date.format(servertime, 'Y-m-d H:i:s');
805 },
806
807 render_zfs_health: function(value) {
808 if (typeof value === 'undefined') {
809 return "";
810 }
811 var iconCls = 'question-circle';
812 switch (value) {
813 case 'AVAIL':
814 case 'ONLINE':
815 iconCls = 'check-circle good';
816 break;
817 case 'REMOVED':
818 case 'DEGRADED':
819 iconCls = 'exclamation-circle warning';
820 break;
821 case 'UNAVAIL':
822 case 'FAULTED':
823 case 'OFFLINE':
824 iconCls = 'times-circle critical';
825 break;
826 default: //unknown
827 }
828
829 return '<i class="fa fa-' + iconCls + '"></i> ' + value;
830 },
831
832 get_help_info: function(section) {
833 let helpMap;
834 if (typeof proxmoxOnlineHelpInfo !== 'undefined') {
835 helpMap = proxmoxOnlineHelpInfo; // eslint-disable-line no-undef
836 } else if (typeof pveOnlineHelpInfo !== 'undefined') {
837 // be backward compatible with older pve-doc-generators
838 helpMap = pveOnlineHelpInfo; // eslint-disable-line no-undef
839 } else {
840 throw "no global OnlineHelpInfo map declared";
841 }
842
843 if (helpMap[section]) {
844 return helpMap[section];
845 }
846 // try to normalize - and _ separators, to support asciidoc and sphinx
847 // references at the same time.
848 let section_minus_normalized = section.replace(/_/g, '-');
849 if (helpMap[section_minus_normalized]) {
850 return helpMap[section_minus_normalized];
851 }
852 let section_underscore_normalized = section.replace(/-/g, '_');
853 return helpMap[section_underscore_normalized];
854 },
855
856 get_help_link: function(section) {
857 let info = Proxmox.Utils.get_help_info(section);
858 if (!info) {
859 return undefined;
860 }
861 return window.location.origin + info.link;
862 },
863
864 openXtermJsViewer: function(vmtype, vmid, nodename, vmname, cmd) {
865 let url = Ext.Object.toQueryString({
866 console: vmtype, // kvm, lxc, upgrade or shell
867 xtermjs: 1,
868 vmid: vmid,
869 vmname: vmname,
870 node: nodename,
871 cmd: cmd,
872
873 });
874 let nw = window.open("?" + url, '_blank', 'toolbar=no,location=no,status=no,menubar=no,resizable=yes,width=800,height=420');
875 if (nw) {
876 nw.focus();
877 }
878 },
879
880 render_optional_url: function(value) {
881 if (value && value.match(/^https?:\/\//) !== null) {
882 return '<a target="_blank" href="' + value + '">' + value + '</a>';
883 }
884 return value;
885 },
886
887 render_san: function(value) {
888 var names = [];
889 if (Ext.isArray(value)) {
890 value.forEach(function(val) {
891 if (!Ext.isNumber(val)) {
892 names.push(val);
893 }
894 });
895 return names.join('<br>');
896 }
897 return value;
898 },
899
900 render_usage: val => (val * 100).toFixed(2) + '%',
901
902 render_cpu_usage: function(val, max) {
903 return Ext.String.format(
904 `${gettext('{0}% of {1}')} ${gettext('CPU(s)')}`,
905 (val*100).toFixed(2),
906 max,
907 );
908 },
909
910 render_size_usage: function(val, max, useSI) {
911 if (max === 0) {
912 return gettext('N/A');
913 }
914 let fmt = v => Proxmox.Utils.format_size(v, useSI);
915 let ratio = (val * 100 / max).toFixed(2);
916 return ratio + '% (' + Ext.String.format(gettext('{0} of {1}'), fmt(val), fmt(max)) + ')';
917 },
918
919 render_cpu: function(value, metaData, record, rowIndex, colIndex, store) {
920 if (!(record.data.uptime && Ext.isNumeric(value))) {
921 return '';
922 }
923
924 let maxcpu = record.data.maxcpu || 1;
925 if (!Ext.isNumeric(maxcpu) || maxcpu < 1) {
926 return '';
927 }
928 let cpuText = maxcpu > 1 ? 'CPUs' : 'CPU';
929 let ratio = (value * 100).toFixed(1);
930 return `${ratio}% of ${maxcpu.toString()} ${cpuText}`;
931 },
932
933 render_size: function(value, metaData, record, rowIndex, colIndex, store) {
934 if (!Ext.isNumeric(value)) {
935 return '';
936 }
937 return Proxmox.Utils.format_size(value);
938 },
939
940 render_cpu_model: function(cpu) {
941 let socketText = cpu.sockets > 1 ? gettext('Sockets') : gettext('Socket');
942 return `${cpu.cpus} x ${cpu.model} (${cpu.sockets.toString()} ${socketText})`;
943 },
944
945 /* this is different for nodes */
946 render_node_cpu_usage: function(value, record) {
947 return Proxmox.Utils.render_cpu_usage(value, record.cpus);
948 },
949
950 render_node_size_usage: function(record) {
951 return Proxmox.Utils.render_size_usage(record.used, record.total);
952 },
953
954 loadTextFromFile: function(file, callback, maxBytes) {
955 let maxSize = maxBytes || 8192;
956 if (file.size > maxSize) {
957 Ext.Msg.alert(gettext('Error'), gettext("Invalid file size: ") + file.size);
958 return;
959 }
960 let reader = new FileReader();
961 reader.onload = evt => callback(evt.target.result);
962 reader.readAsText(file);
963 },
964
965 parsePropertyString: function(value, defaultKey) {
966 var res = {},
967 error;
968
969 if (typeof value !== 'string' || value === '') {
970 return res;
971 }
972
973 Ext.Array.each(value.split(','), function(p) {
974 var kv = p.split('=', 2);
975 if (Ext.isDefined(kv[1])) {
976 res[kv[0]] = kv[1];
977 } else if (Ext.isDefined(defaultKey)) {
978 if (Ext.isDefined(res[defaultKey])) {
979 error = 'defaultKey may be only defined once in propertyString';
980 return false; // break
981 }
982 res[defaultKey] = kv[0];
983 } else {
984 error = 'invalid propertyString, not a key=value pair and no defaultKey defined';
985 return false; // break
986 }
987 return true;
988 });
989
990 if (error !== undefined) {
991 console.error(error);
992 return undefined;
993 }
994
995 return res;
996 },
997
998 printPropertyString: function(data, defaultKey) {
999 var stringparts = [],
1000 gotDefaultKeyVal = false,
1001 defaultKeyVal;
1002
1003 Ext.Object.each(data, function(key, value) {
1004 if (defaultKey !== undefined && key === defaultKey) {
1005 gotDefaultKeyVal = true;
1006 defaultKeyVal = value;
1007 } else if (Ext.isArray(value)) {
1008 stringparts.push(key + '=' + value.join(';'));
1009 } else if (value !== '') {
1010 stringparts.push(key + '=' + value);
1011 }
1012 });
1013
1014 stringparts = stringparts.sort();
1015 if (gotDefaultKeyVal) {
1016 stringparts.unshift(defaultKeyVal);
1017 }
1018
1019 return stringparts.join(',');
1020 },
1021
1022 acmedomain_count: 5,
1023
1024 parseACMEPluginData: function(data) {
1025 let res = {};
1026 let extradata = [];
1027 data.split('\n').forEach((line) => {
1028 // capture everything after the first = as value
1029 let [key, value] = line.split('=');
1030 if (value !== undefined) {
1031 res[key] = value;
1032 } else {
1033 extradata.push(line);
1034 }
1035 });
1036 return [res, extradata];
1037 },
1038
1039 delete_if_default: function(values, fieldname, default_val, create) {
1040 if (values[fieldname] === '' || values[fieldname] === default_val) {
1041 if (!create) {
1042 if (values.delete) {
1043 if (Ext.isArray(values.delete)) {
1044 values.delete.push(fieldname);
1045 } else {
1046 values.delete += ',' + fieldname;
1047 }
1048 } else {
1049 values.delete = fieldname;
1050 }
1051 }
1052
1053 delete values[fieldname];
1054 }
1055 },
1056
1057 printACME: function(value) {
1058 if (Ext.isArray(value.domains)) {
1059 value.domains = value.domains.join(';');
1060 }
1061 return Proxmox.Utils.printPropertyString(value);
1062 },
1063
1064 parseACME: function(value) {
1065 if (!value) {
1066 return {};
1067 }
1068
1069 var res = {};
1070 var error;
1071
1072 Ext.Array.each(value.split(','), function(p) {
1073 var kv = p.split('=', 2);
1074 if (Ext.isDefined(kv[1])) {
1075 res[kv[0]] = kv[1];
1076 } else {
1077 error = 'Failed to parse key-value pair: '+p;
1078 return false;
1079 }
1080 return true;
1081 });
1082
1083 if (error !== undefined) {
1084 console.error(error);
1085 return undefined;
1086 }
1087
1088 if (res.domains !== undefined) {
1089 res.domains = res.domains.split(/;/);
1090 }
1091
1092 return res;
1093 },
1094
1095 add_domain_to_acme: function(acme, domain) {
1096 if (acme.domains === undefined) {
1097 acme.domains = [domain];
1098 } else {
1099 acme.domains.push(domain);
1100 acme.domains = acme.domains.filter((value, index, self) => self.indexOf(value) === index);
1101 }
1102 return acme;
1103 },
1104
1105 remove_domain_from_acme: function(acme, domain) {
1106 if (acme.domains !== undefined) {
1107 acme.domains = acme.domains.filter(
1108 (value, index, self) => self.indexOf(value) === index && value !== domain,
1109 );
1110 }
1111 return acme;
1112 },
1113
1114 updateColumns: function(container) {
1115 let mode = Ext.state.Manager.get('summarycolumns') || 'auto';
1116 let factor;
1117 if (mode !== 'auto') {
1118 factor = parseInt(mode, 10);
1119 if (Number.isNaN(factor)) {
1120 factor = 1;
1121 }
1122 } else {
1123 factor = container.getSize().width < 1400 ? 1 : 2;
1124 }
1125
1126 if (container.oldFactor === factor) {
1127 return;
1128 }
1129
1130 let items = container.query('>'); // direct childs
1131 factor = Math.min(factor, items.length);
1132 container.oldFactor = factor;
1133
1134 items.forEach((item) => {
1135 item.columnWidth = 1 / factor;
1136 });
1137
1138 // we have to update the layout twice, since the first layout change
1139 // can trigger the scrollbar which reduces the amount of space left
1140 container.updateLayout();
1141 container.updateLayout();
1142 },
1143 },
1144
1145 singleton: true,
1146 constructor: function() {
1147 let me = this;
1148 Ext.apply(me, me.utilities);
1149
1150 let IPV4_OCTET = "(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])";
1151 let IPV4_REGEXP = "(?:(?:" + IPV4_OCTET + "\\.){3}" + IPV4_OCTET + ")";
1152 let IPV6_H16 = "(?:[0-9a-fA-F]{1,4})";
1153 let IPV6_LS32 = "(?:(?:" + IPV6_H16 + ":" + IPV6_H16 + ")|" + IPV4_REGEXP + ")";
1154 let IPV4_CIDR_MASK = "([0-9]{1,2})";
1155 let IPV6_CIDR_MASK = "([0-9]{1,3})";
1156
1157
1158 me.IP4_match = new RegExp("^(?:" + IPV4_REGEXP + ")$");
1159 me.IP4_cidr_match = new RegExp("^(?:" + IPV4_REGEXP + ")/" + IPV4_CIDR_MASK + "$");
1160
1161 /* eslint-disable no-useless-concat,no-multi-spaces */
1162 let IPV6_REGEXP = "(?:" +
1163 "(?:(?:" + "(?:" + IPV6_H16 + ":){6})" + IPV6_LS32 + ")|" +
1164 "(?:(?:" + "::" + "(?:" + IPV6_H16 + ":){5})" + IPV6_LS32 + ")|" +
1165 "(?:(?:(?:" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){4})" + IPV6_LS32 + ")|" +
1166 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,1}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){3})" + IPV6_LS32 + ")|" +
1167 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,2}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){2})" + IPV6_LS32 + ")|" +
1168 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,3}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){1})" + IPV6_LS32 + ")|" +
1169 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,4}" + IPV6_H16 + ")?::" + ")" + IPV6_LS32 + ")|" +
1170 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,5}" + IPV6_H16 + ")?::" + ")" + IPV6_H16 + ")|" +
1171 "(?:(?:(?:(?:" + IPV6_H16 + ":){0,7}" + IPV6_H16 + ")?::" + ")" + ")" +
1172 ")";
1173 /* eslint-enable no-useless-concat,no-multi-spaces */
1174
1175 me.IP6_match = new RegExp("^(?:" + IPV6_REGEXP + ")$");
1176 me.IP6_cidr_match = new RegExp("^(?:" + IPV6_REGEXP + ")/" + IPV6_CIDR_MASK + "$");
1177 me.IP6_bracket_match = new RegExp("^\\[(" + IPV6_REGEXP + ")\\]");
1178
1179 me.IP64_match = new RegExp("^(?:" + IPV6_REGEXP + "|" + IPV4_REGEXP + ")$");
1180 me.IP64_cidr_match = new RegExp("^(?:" + IPV6_REGEXP + "/" + IPV6_CIDR_MASK + ")|(?:" + IPV4_REGEXP + "/" + IPV4_CIDR_MASK + ")$");
1181
1182 let DnsName_REGEXP = "(?:(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9\\-]*[a-zA-Z0-9])?)\\.)*(?:[A-Za-z0-9](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?))";
1183 me.DnsName_match = new RegExp("^" + DnsName_REGEXP + "$");
1184
1185 me.HostPort_match = new RegExp("^(" + IPV4_REGEXP + "|" + DnsName_REGEXP + ")(?::(\\d+))?$");
1186 me.HostPortBrackets_match = new RegExp("^\\[(" + IPV6_REGEXP + "|" + IPV4_REGEXP + "|" + DnsName_REGEXP + ")\\](?::(\\d+))?$");
1187 me.IP6_dotnotation_match = new RegExp("^(" + IPV6_REGEXP + ")(?:\\.(\\d+))?$");
1188 me.Vlan_match = /^vlan(\d+)/;
1189 me.VlanInterface_match = /(\w+)\.(\d+)/;
1190 },
1191 });
1192
1193 Ext.define('Proxmox.Async', {
1194 singleton: true,
1195
1196 // Returns a Promise resolving to the result of an `API2Request` or rejecting to the error
1197 // repsonse on failure
1198 api2: function(reqOpts) {
1199 return new Promise((resolve, reject) => {
1200 delete reqOpts.callback; // not allowed in this api
1201 reqOpts.success = response => resolve(response);
1202 reqOpts.failure = response => reject(response);
1203 Proxmox.Utils.API2Request(reqOpts);
1204 });
1205 },
1206
1207 // Delay for a number of milliseconds.
1208 sleep: function(millis) {
1209 return new Promise((resolve, _reject) => setTimeout(resolve, millis));
1210 },
1211 });