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 = Proxmox.Utils.parse_userid(userid)[0] || "";
 257         return Ext.htmlEncode(username);
 258     },
 259
 260     render_realm: function(userid) {
 261         let username = Proxmox.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, thresholdWidth) {
 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             thresholdWidth = (thresholdWidth || 1400) + 1;
 557             factor = Math.ceil(container.getSize().width / thresholdWidth);
 558         }
 559
 560         if (container.oldFactor === factor) {
 561             return;
 562         }
 563
 564         let items = container.query('>'); // direct childs
 565         factor = Math.min(factor, items.length);
 566         container.oldFactor = factor;
 567
 568         items.forEach((item) => {
 569             item.columnWidth = 1 / factor;
 570         });
 571
 572         // we have to update the layout twice, since the first layout change
 573         // can trigger the scrollbar which reduces the amount of space left
 574         container.updateLayout();
 575         container.updateLayout();
 576     },
 577
 578     // NOTE: depreacated, use updateColumnWidth
 579     updateColumns: container => Proxmox.Utils.updateColumnWidth(container),
 580
 581     dialog_title: function(subject, create, isAdd) {
 582         if (create) {
 583             if (isAdd) {
 584                 return gettext('Add') + ': ' + subject;
 585             } else {
 586                 return gettext('Create') + ': ' + subject;
 587             }
 588         } else {
 589             return gettext('Edit') + ': ' + subject;
 590         }
 591     },
 592
 593     network_iface_types: {
 594         eth: gettext("Network Device"),
 595         bridge: 'Linux Bridge',
 596         bond: 'Linux Bond',
 597         vlan: 'Linux VLAN',
 598         OVSBridge: 'OVS Bridge',
 599         OVSBond: 'OVS Bond',
 600         OVSPort: 'OVS Port',
 601         OVSIntPort: 'OVS IntPort',
 602     },
 603
 604     render_network_iface_type: function(value) {
 605         return Proxmox.Utils.network_iface_types[value] ||
 606             Proxmox.Utils.unknownText;
 607     },
 608
 609     // NOTE: only add general, product agnostic, ones here! Else use override helper in product repos
 610     task_desc_table: {
 611         aptupdate: ['', gettext('Update package database')],
 612         diskinit: ['Disk', gettext('Initialize Disk with GPT')],
 613         spiceshell: ['', gettext('Shell') + ' (Spice)'],
 614         srvreload: ['SRV', gettext('Reload')],
 615         srvrestart: ['SRV', gettext('Restart')],
 616         srvstart: ['SRV', gettext('Start')],
 617         srvstop: ['SRV', gettext('Stop')],
 618         termproxy: ['', gettext('Console') + ' (xterm.js)'],
 619         vncshell: ['', gettext('Shell')],
 620     },
 621
 622     // to add or change existing for product specific ones
 623     override_task_descriptions: function(extra) {
 624         for (const [key, value] of Object.entries(extra)) {
 625             Proxmox.Utils.task_desc_table[key] = value;
 626         }
 627     },
 628
 629     format_task_description: function(type, id) {
 630         let farray = Proxmox.Utils.task_desc_table[type];
 631         let text;
 632         if (!farray) {
 633             text = type;
 634             if (id) {
 635                 type += ' ' + id;
 636             }
 637             return text;
 638         } else if (Ext.isFunction(farray)) {
 639             return farray(type, id);
 640         }
 641         let prefix = farray[0];
 642         text = farray[1];
 643         if (prefix && id !== undefined) {
 644             return prefix + ' ' + id + ' - ' + text;
 645         }
 646         return text;
 647     },
 648
 649     format_size: function(size, useSI) {
 650         let units = ['', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'];
 651         let order = 0;
 652         const baseValue = useSI ? 1000 : 1024;
 653         while (size >= baseValue && order < units.length) {
 654             size = size / baseValue;
 655             order++;
 656         }
 657
 658         let unit = units[order], commaDigits = 2;
 659         if (order === 0) {
 660             commaDigits = 0;
 661         } else if (!useSI) {
 662             unit += 'i';
 663         }
 664         return `${size.toFixed(commaDigits)} ${unit}B`;
 665     },
 666
 667     render_upid: function(value, metaData, record) {
 668         let task = record.data;
 669         let type = task.type || task.worker_type;
 670         let id = task.id || task.worker_id;
 671
 672         return Proxmox.Utils.format_task_description(type, id);
 673     },
 674
 675     render_uptime: function(value) {
 676         let uptime = value;
 677
 678         if (uptime === undefined) {
 679             return '';
 680         }
 681
 682         if (uptime <= 0) {
 683             return '-';
 684         }
 685
 686         return Proxmox.Utils.format_duration_long(uptime);
 687     },
 688
 689     systemd_unescape: function(string_value) {
 690         const charcode_0 = '0'.charCodeAt(0);
 691         const charcode_9 = '9'.charCodeAt(0);
 692         const charcode_A = 'A'.charCodeAt(0);
 693         const charcode_F = 'F'.charCodeAt(0);
 694         const charcode_a = 'a'.charCodeAt(0);
 695         const charcode_f = 'f'.charCodeAt(0);
 696         const charcode_x = 'x'.charCodeAt(0);
 697         const charcode_minus = '-'.charCodeAt(0);
 698         const charcode_slash = '/'.charCodeAt(0);
 699         const charcode_backslash = '\\'.charCodeAt(0);
 700
 701         let parse_hex_digit = function(d) {
 702             if (d >= charcode_0 && d <= charcode_9) {
 703                 return d - charcode_0;
 704             }
 705             if (d >= charcode_A && d <= charcode_F) {
 706                 return d - charcode_A + 10;
 707             }
 708             if (d >= charcode_a && d <= charcode_f) {
 709                 return d - charcode_a + 10;
 710             }
 711             throw "got invalid hex digit";
 712         };
 713
 714         let value = new TextEncoder().encode(string_value);
 715         let result = new Uint8Array(value.length);
 716
 717         let i = 0;
 718         let result_len = 0;
 719
 720         while (i < value.length) {
 721             let c0 = value[i];
 722             if (c0 === charcode_minus) {
 723                 result.set([charcode_slash], result_len);
 724                 result_len += 1;
 725                 i += 1;
 726                 continue;
 727             }
 728             if ((i + 4) < value.length) {
 729                 let c1 = value[i+1];
 730                 if (c0 === charcode_backslash && c1 === charcode_x) {
 731                     let h1 = parse_hex_digit(value[i+2]);
 732                     let h0 = parse_hex_digit(value[i+3]);
 733                     let ord = h1*16+h0;
 734                     result.set([ord], result_len);
 735                     result_len += 1;
 736                     i += 4;
 737                     continue;
 738                 }
 739             }
 740             result.set([c0], result_len);
 741             result_len += 1;
 742             i += 1;
 743         }
 744
 745         return new TextDecoder().decode(result.slice(0, result.len));
 746     },
 747
 748     parse_task_upid: function(upid) {
 749         let task = {};
 750
 751         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]+):$/);
 752         if (!res) {
 753             throw "unable to parse upid '" + upid + "'";
 754         }
 755         task.node = res[1];
 756         task.pid = parseInt(res[2], 16);
 757         task.pstart = parseInt(res[3], 16);
 758         if (res[5] !== undefined) {
 759             task.task_id = parseInt(res[5], 16);
 760         }
 761         task.starttime = parseInt(res[6], 16);
 762         task.type = res[7];
 763         task.id = Proxmox.Utils.systemd_unescape(res[8]);
 764         task.user = res[9];
 765
 766         task.desc = Proxmox.Utils.format_task_description(task.type, task.id);
 767
 768         return task;
 769     },
 770
 771     parse_task_status: function(status) {
 772         if (status === 'OK') {
 773             return 'ok';
 774         }
 775
 776         if (status === 'unknown') {
 777             return 'unknown';
 778         }
 779
 780         let match = status.match(/^WARNINGS: (.*)$/);
 781         if (match) {
 782             return 'warning';
 783         }
 784
 785         return 'error';
 786     },
 787
 788     format_task_status: function(status) {
 789         let parsed = Proxmox.Utils.parse_task_status(status);
 790         switch (parsed) {
 791             case 'unknown': return Proxmox.Utils.unknownText;
 792             case 'error': return Proxmox.Utils.errorText + ': ' + status;
 793             case 'warning': return status.replace('WARNINGS', Proxmox.Utils.warningsText);
 794             case 'ok': // fall-through
 795             default: return status;
 796         }
 797     },
 798
 799     render_duration: function(value) {
 800         if (value === undefined) {
 801             return '-';
 802         }
 803         return Proxmox.Utils.format_duration_human(value);
 804     },
 805
 806     render_timestamp: function(value, metaData, record, rowIndex, colIndex, store) {
 807         let servertime = new Date(value * 1000);
 808         return Ext.Date.format(servertime, 'Y-m-d H:i:s');
 809     },
 810
 811     render_zfs_health: function(value) {
 812         if (typeof value === 'undefined') {
 813             return "";
 814         }
 815         var iconCls = 'question-circle';
 816         switch (value) {
 817             case 'AVAIL':
 818             case 'ONLINE':
 819                 iconCls = 'check-circle good';
 820                 break;
 821             case 'REMOVED':
 822             case 'DEGRADED':
 823                 iconCls = 'exclamation-circle warning';
 824                 break;
 825             case 'UNAVAIL':
 826             case 'FAULTED':
 827             case 'OFFLINE':
 828                 iconCls = 'times-circle critical';
 829                 break;
 830             default: //unknown
 831         }
 832
 833         return '<i class="fa fa-' + iconCls + '"></i> ' + value;
 834     },
 835
 836     get_help_info: function(section) {
 837         let helpMap;
 838         if (typeof proxmoxOnlineHelpInfo !== 'undefined') {
 839             helpMap = proxmoxOnlineHelpInfo; // eslint-disable-line no-undef
 840         } else if (typeof pveOnlineHelpInfo !== 'undefined') {
 841             // be backward compatible with older pve-doc-generators
 842             helpMap = pveOnlineHelpInfo; // eslint-disable-line no-undef
 843         } else {
 844             throw "no global OnlineHelpInfo map declared";
 845         }
 846
 847         if (helpMap[section]) {
 848             return helpMap[section];
 849         }
 850         // try to normalize - and _ separators, to support asciidoc and sphinx
 851         // references at the same time.
 852         let section_minus_normalized = section.replace(/_/g, '-');
 853         if (helpMap[section_minus_normalized]) {
 854             return helpMap[section_minus_normalized];
 855         }
 856         let section_underscore_normalized = section.replace(/-/g, '_');
 857         return helpMap[section_underscore_normalized];
 858     },
 859
 860     get_help_link: function(section) {
 861         let info = Proxmox.Utils.get_help_info(section);
 862         if (!info) {
 863             return undefined;
 864         }
 865         return window.location.origin + info.link;
 866     },
 867
 868     openXtermJsViewer: function(vmtype, vmid, nodename, vmname, cmd) {
 869         let url = Ext.Object.toQueryString({
 870             console: vmtype, // kvm, lxc, upgrade or shell
 871             xtermjs: 1,
 872             vmid: vmid,
 873             vmname: vmname,
 874             node: nodename,
 875             cmd: cmd,
 876
 877         });
 878         let nw = window.open("?" + url, '_blank', 'toolbar=no,location=no,status=no,menubar=no,resizable=yes,width=800,height=420');
 879         if (nw) {
 880             nw.focus();
 881         }
 882     },
 883
 884     render_optional_url: function(value) {
 885         if (value && value.match(/^https?:\/\//) !== null) {
 886             return '<a target="_blank" href="' + value + '">' + value + '</a>';
 887         }
 888         return value;
 889     },
 890
 891     render_san: function(value) {
 892         var names = [];
 893         if (Ext.isArray(value)) {
 894             value.forEach(function(val) {
 895                 if (!Ext.isNumber(val)) {
 896                     names.push(val);
 897                 }
 898             });
 899             return names.join('<br>');
 900         }
 901         return value;
 902     },
 903
 904     render_usage: val => (val * 100).toFixed(2) + '%',
 905
 906     render_cpu_usage: function(val, max) {
 907         return Ext.String.format(
 908             `${gettext('{0}% of {1}')} ${gettext('CPU(s)')}`,
 909             (val*100).toFixed(2),
 910             max,
 911         );
 912     },
 913
 914     render_size_usage: function(val, max, useSI) {
 915         if (max === 0) {
 916             return gettext('N/A');
 917         }
 918         let fmt = v => Proxmox.Utils.format_size(v, useSI);
 919         let ratio = (val * 100 / max).toFixed(2);
 920         return ratio + '% (' + Ext.String.format(gettext('{0} of {1}'), fmt(val), fmt(max)) + ')';
 921     },
 922
 923     render_cpu: function(value, metaData, record, rowIndex, colIndex, store) {
 924         if (!(record.data.uptime && Ext.isNumeric(value))) {
 925             return '';
 926         }
 927
 928         let maxcpu = record.data.maxcpu || 1;
 929         if (!Ext.isNumeric(maxcpu) || maxcpu < 1) {
 930             return '';
 931         }
 932         let cpuText = maxcpu > 1 ? 'CPUs' : 'CPU';
 933         let ratio = (value * 100).toFixed(1);
 934         return `${ratio}% of ${maxcpu.toString()} ${cpuText}`;
 935     },
 936
 937     render_size: function(value, metaData, record, rowIndex, colIndex, store) {
 938         if (!Ext.isNumeric(value)) {
 939             return '';
 940         }
 941         return Proxmox.Utils.format_size(value);
 942     },
 943
 944     render_cpu_model: function(cpu) {
 945         let socketText = cpu.sockets > 1 ? gettext('Sockets') : gettext('Socket');
 946         return `${cpu.cpus} x ${cpu.model} (${cpu.sockets.toString()} ${socketText})`;
 947     },
 948
 949     /* this is different for nodes */
 950     render_node_cpu_usage: function(value, record) {
 951         return Proxmox.Utils.render_cpu_usage(value, record.cpus);
 952     },
 953
 954     render_node_size_usage: function(record) {
 955         return Proxmox.Utils.render_size_usage(record.used, record.total);
 956     },
 957
 958     loadTextFromFile: function(file, callback, maxBytes) {
 959         let maxSize = maxBytes || 8192;
 960         if (file.size > maxSize) {
 961             Ext.Msg.alert(gettext('Error'), gettext("Invalid file size: ") + file.size);
 962             return;
 963         }
 964         let reader = new FileReader();
 965         reader.onload = evt => callback(evt.target.result);
 966         reader.readAsText(file);
 967     },
 968
 969     parsePropertyString: function(value, defaultKey) {
 970         var res = {},
 971             error;
 972
 973         if (typeof value !== 'string' || value === '') {
 974             return res;
 975         }
 976
 977         Ext.Array.each(value.split(','), function(p) {
 978             var kv = p.split('=', 2);
 979             if (Ext.isDefined(kv[1])) {
 980                 res[kv[0]] = kv[1];
 981             } else if (Ext.isDefined(defaultKey)) {
 982                 if (Ext.isDefined(res[defaultKey])) {
 983                     error = 'defaultKey may be only defined once in propertyString';
 984                     return false; // break
 985                 }
 986                 res[defaultKey] = kv[0];
 987             } else {
 988                 error = 'invalid propertyString, not a key=value pair and no defaultKey defined';
 989                 return false; // break
 990             }
 991             return true;
 992         });
 993
 994         if (error !== undefined) {
 995             console.error(error);
 996             return undefined;
 997         }
 998
 999         return res;
1000     },
1001
1002     printPropertyString: function(data, defaultKey) {
1003         var stringparts = [],
1004             gotDefaultKeyVal = false,
1005             defaultKeyVal;
1006
1007         Ext.Object.each(data, function(key, value) {
1008             if (defaultKey !== undefined && key === defaultKey) {
1009                 gotDefaultKeyVal = true;
1010                 defaultKeyVal = value;
1011             } else if (Ext.isArray(value)) {
1012                 stringparts.push(key + '=' + value.join(';'));
1013             } else if (value !== '') {
1014                 stringparts.push(key + '=' + value);
1015             }
1016         });
1017
1018         stringparts = stringparts.sort();
1019         if (gotDefaultKeyVal) {
1020             stringparts.unshift(defaultKeyVal);
1021         }
1022
1023         return stringparts.join(',');
1024     },
1025
1026     acmedomain_count: 5,
1027
1028     parseACMEPluginData: function(data) {
1029         let res = {};
1030         let extradata = [];
1031         data.split('\n').forEach((line) => {
1032             // capture everything after the first = as value
1033             let [key, value] = line.split('=');
1034             if (value !== undefined) {
1035                 res[key] = value;
1036             } else {
1037                 extradata.push(line);
1038             }
1039         });
1040         return [res, extradata];
1041     },
1042
1043     delete_if_default: function(values, fieldname, default_val, create) {
1044         if (values[fieldname] === '' || values[fieldname] === default_val) {
1045             if (!create) {
1046                 if (values.delete) {
1047                     if (Ext.isArray(values.delete)) {
1048                         values.delete.push(fieldname);
1049                     } else {
1050                         values.delete += ',' + fieldname;
1051                     }
1052                 } else {
1053                     values.delete = fieldname;
1054                 }
1055             }
1056
1057             delete values[fieldname];
1058         }
1059     },
1060
1061     printACME: function(value) {
1062         if (Ext.isArray(value.domains)) {
1063             value.domains = value.domains.join(';');
1064         }
1065         return Proxmox.Utils.printPropertyString(value);
1066     },
1067
1068     parseACME: function(value) {
1069         if (!value) {
1070             return {};
1071         }
1072
1073         var res = {};
1074         var error;
1075
1076         Ext.Array.each(value.split(','), function(p) {
1077             var kv = p.split('=', 2);
1078             if (Ext.isDefined(kv[1])) {
1079                 res[kv[0]] = kv[1];
1080             } else {
1081                 error = 'Failed to parse key-value pair: '+p;
1082                 return false;
1083             }
1084             return true;
1085         });
1086
1087         if (error !== undefined) {
1088             console.error(error);
1089             return undefined;
1090         }
1091
1092         if (res.domains !== undefined) {
1093             res.domains = res.domains.split(/;/);
1094         }
1095
1096         return res;
1097     },
1098
1099     add_domain_to_acme: function(acme, domain) {
1100         if (acme.domains === undefined) {
1101             acme.domains = [domain];
1102         } else {
1103             acme.domains.push(domain);
1104             acme.domains = acme.domains.filter((value, index, self) => self.indexOf(value) === index);
1105         }
1106         return acme;
1107     },
1108
1109     remove_domain_from_acme: function(acme, domain) {
1110         if (acme.domains !== undefined) {
1111             acme.domains = acme.domains.filter(
1112                 (value, index, self) => self.indexOf(value) === index && value !== domain,
1113             );
1114         }
1115         return acme;
1116     },
1117
1118     get_health_icon: function(state, circle) {
1119         if (circle === undefined) {
1120             circle = false;
1121         }
1122
1123         if (state === undefined) {
1124             state = 'uknown';
1125         }
1126
1127         var icon = 'faded fa-question';
1128         switch (state) {
1129             case 'good':
1130                 icon = 'good fa-check';
1131                 break;
1132             case 'upgrade':
1133                 icon = 'warning fa-upload';
1134                 break;
1135             case 'old':
1136                 icon = 'warning fa-refresh';
1137                 break;
1138             case 'warning':
1139                 icon = 'warning fa-exclamation';
1140                 break;
1141             case 'critical':
1142                 icon = 'critical fa-times';
1143                 break;
1144             default: break;
1145         }
1146
1147         if (circle) {
1148             icon += '-circle';
1149         }
1150
1151         return icon;
1152     },
1153
1154     authSchema: {
1155         pam: {
1156             name: 'Linux PAM',
1157             add: false,
1158             edit: false,
1159             pwchange: true,
1160         },
1161     },
1162
1163     // to add or change existing for product specific ones
1164     overrideAuthSchema: function(extra) {
1165         for (const [key, value] of Object.entries(extra)) {
1166             Proxmox.Utils.authSchema[key] = value;
1167         }
1168     },
1169 },
1170
1171     singleton: true,
1172     constructor: function() {
1173         let me = this;
1174         Ext.apply(me, me.utilities);
1175
1176         let IPV4_OCTET = "(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])";
1177         let IPV4_REGEXP = "(?:(?:" + IPV4_OCTET + "\\.){3}" + IPV4_OCTET + ")";
1178         let IPV6_H16 = "(?:[0-9a-fA-F]{1,4})";
1179         let IPV6_LS32 = "(?:(?:" + IPV6_H16 + ":" + IPV6_H16 + ")|" + IPV4_REGEXP + ")";
1180         let IPV4_CIDR_MASK = "([0-9]{1,2})";
1181         let IPV6_CIDR_MASK = "([0-9]{1,3})";
1182
1183
1184         me.IP4_match = new RegExp("^(?:" + IPV4_REGEXP + ")$");
1185         me.IP4_cidr_match = new RegExp("^(?:" + IPV4_REGEXP + ")/" + IPV4_CIDR_MASK + "$");
1186
1187         /* eslint-disable no-useless-concat,no-multi-spaces */
1188         let IPV6_REGEXP = "(?:" +
1189             "(?:(?:"                                                  + "(?:" + IPV6_H16 + ":){6})" + IPV6_LS32 + ")|" +
1190             "(?:(?:"                                         +   "::" + "(?:" + IPV6_H16 + ":){5})" + IPV6_LS32 + ")|" +
1191             "(?:(?:(?:"                           + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){4})" + IPV6_LS32 + ")|" +
1192             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,1}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){3})" + IPV6_LS32 + ")|" +
1193             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,2}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){2})" + IPV6_LS32 + ")|" +
1194             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,3}" + IPV6_H16 + ")?::" + "(?:" + IPV6_H16 + ":){1})" + IPV6_LS32 + ")|" +
1195             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,4}" + IPV6_H16 + ")?::" +                         ")" + IPV6_LS32 + ")|" +
1196             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,5}" + IPV6_H16 + ")?::" +                         ")" + IPV6_H16  + ")|" +
1197             "(?:(?:(?:(?:" + IPV6_H16 + ":){0,7}" + IPV6_H16 + ")?::" +                         ")"             + ")"  +
1198             ")";
1199         /* eslint-enable no-useless-concat,no-multi-spaces */
1200
1201         me.IP6_match = new RegExp("^(?:" + IPV6_REGEXP + ")$");
1202         me.IP6_cidr_match = new RegExp("^(?:" + IPV6_REGEXP + ")/" + IPV6_CIDR_MASK + "$");
1203         me.IP6_bracket_match = new RegExp("^\\[(" + IPV6_REGEXP + ")\\]");
1204
1205         me.IP64_match = new RegExp("^(?:" + IPV6_REGEXP + "|" + IPV4_REGEXP + ")$");
1206         me.IP64_cidr_match = new RegExp("^(?:" + IPV6_REGEXP + "/" + IPV6_CIDR_MASK + ")|(?:" + IPV4_REGEXP + "/" + IPV4_CIDR_MASK + ")$");
1207
1208         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])?))";
1209         me.DnsName_match = new RegExp("^" + DnsName_REGEXP + "$");
1210
1211         me.HostPort_match = new RegExp("^(" + IPV4_REGEXP + "|" + DnsName_REGEXP + ")(?::(\\d+))?$");
1212         me.HostPortBrackets_match = new RegExp("^\\[(" + IPV6_REGEXP + "|" + IPV4_REGEXP + "|" + DnsName_REGEXP + ")\\](?::(\\d+))?$");
1213         me.IP6_dotnotation_match = new RegExp("^(" + IPV6_REGEXP + ")(?:\\.(\\d+))?$");
1214         me.Vlan_match = /^vlan(\d+)/;
1215         me.VlanInterface_match = /(\w+)\.(\d+)/;
1216     },
1217 });
1218
1219 Ext.define('Proxmox.Async', {
1220     singleton: true,
1221
1222     // Returns a Promise resolving to the result of an `API2Request` or rejecting to the error
1223     // repsonse on failure
1224     api2: function(reqOpts) {
1225         return new Promise((resolve, reject) => {
1226             delete reqOpts.callback; // not allowed in this api
1227             reqOpts.success = response => resolve(response);
1228             reqOpts.failure = response => reject(response);
1229             Proxmox.Utils.API2Request(reqOpts);
1230         });
1231     },
1232
1233     // Delay for a number of milliseconds.
1234     sleep: function(millis) {
1235         return new Promise((resolve, _reject) => setTimeout(resolve, millis));
1236     },
1237 });