From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id DA4849B1A1 for ; Wed, 24 May 2023 15:58:05 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 95BDA1F844 for ; Wed, 24 May 2023 15:57:43 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Wed, 24 May 2023 15:57:39 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 623BB46E2B for ; Wed, 24 May 2023 15:57:35 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Wed, 24 May 2023 15:56:40 +0200 Message-Id: <20230524135649.934881-34-l.wagner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230524135649.934881-1-l.wagner@proxmox.com> References: <20230524135649.934881-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.154 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v2 pve-manager 33/42] ui: backup: allow to select notification channel for notifications X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 24 May 2023 13:58:05 -0000 This commit adds a possibility to choose between different options for notifications for backup jobs: - Notify via email, in the same manner as before - Notify via a notification channel If 'notify via mail' is selected, a text field where an email address can be entered is displayed: Notify: | Always notify v | Notify via: | E-Mail v | Send Mail to: | foo@example.com | Compression: | ..... v | If 'notify via channel' is selected, a combo picker for selecting a channel is displayed: Notify: | Always notify v | Notify via: | Channel v | Channel: | chan1 v | Compression: | ..... v | The code has also been adapted to use the newly introduced 'notification-policy' parameter, which replaces the 'mailnotification' paramter for backup jobs. Some logic which automatically migrates from 'mailnotification' has been added. Signed-off-by: Lukas Wagner --- www/manager6/Makefile | 4 +- www/manager6/dc/Backup.js | 77 +++++++++++++++++-- .../form/NotificationChannelSelector.js | 47 +++++++++++ www/manager6/form/NotificationModeSelector.js | 8 ++ ...ector.js => NotificationPolicySelector.js} | 1 + 5 files changed, 129 insertions(+), 8 deletions(-) create mode 100644 www/manager6/form/NotificationChannelSelector.js create mode 100644 www/manager6/form/NotificationModeSelector.js rename www/manager6/form/{EmailNotificationSelector.js => NotificationPolicySelector.js} (87%) diff --git a/www/manager6/Makefile b/www/manager6/Makefile index 2b577c8e..fea0bfdd 100644 --- a/www/manager6/Makefile +++ b/www/manager6/Makefile @@ -34,7 +34,6 @@ JSSRC= \ form/DayOfWeekSelector.js \ form/DiskFormatSelector.js \ form/DiskStorageSelector.js \ - form/EmailNotificationSelector.js \ form/FileSelector.js \ form/FirewallPolicySelector.js \ form/GlobalSearchField.js \ @@ -48,6 +47,9 @@ JSSRC= \ form/MemoryField.js \ form/NetworkCardSelector.js \ form/NodeSelector.js \ + form/NotificationChannelSelector.js \ + form/NotificationModeSelector.js \ + form/NotificationPolicySelector.js \ form/PCISelector.js \ form/PermPathSelector.js \ form/PoolSelector.js \ diff --git a/www/manager6/dc/Backup.js b/www/manager6/dc/Backup.js index 03a02651..997b0393 100644 --- a/www/manager6/dc/Backup.js +++ b/www/manager6/dc/Backup.js @@ -35,6 +35,29 @@ Ext.define('PVE.dc.BackupEdit', { } delete values.node; } + + if (!isCreate) { + // 'mailnotification' is deprecated in favor of 'notification-policy' + // -> Migration to the new paramater happens in init, so we are + // safe to remove the old parameter here. + Proxmox.Utils.assemble_field_data(values, { 'delete': 'mailnotification' }); + + // If sending notifications via mail, remove the current value of + // 'notification-channel' + if (values['notification-mode'] === "mail") { + Proxmox.Utils.assemble_field_data( + values, + { 'delete': 'notification-channel' } + ); + } + // and vice versa + if (values['notification-mode'] === "channel") { + Proxmox.Utils.assemble_field_data( + values, + { 'delete': 'mailto' } + ); + } + } if (!values.id && isCreate) { values.id = 'backup-' + Ext.data.identifier.Uuid.Global.generate().slice(0, 13); @@ -146,6 +169,16 @@ Ext.define('PVE.dc.BackupEdit', { success: function(response, _options) { let data = response.result.data; + // 'mailnotification' is deprecated. Let's automatically + // migrate to the compatible 'notification-policy' parameter + if (data.mailnotification) { + if (!data["notification-policy"]) { + data["notification-policy"] = data.mailnotification; + } + + delete data.mailnotification; + } + if (data.exclude) { data.vmid = data.exclude; data.selMode = 'exclude'; @@ -188,11 +221,13 @@ Ext.define('PVE.dc.BackupEdit', { viewModel: { data: { selMode: 'include', + notificationMode: 'mail', }, formulas: { poolMode: (get) => get('selMode') === 'pool', disableVMSelection: (get) => get('selMode') !== 'include' && get('selMode') !== 'exclude', + mailNotificationSelected: (get) => get('notificationMode') === 'mail', }, }, @@ -282,20 +317,48 @@ Ext.define('PVE.dc.BackupEdit', { }, ], column2: [ - { - xtype: 'textfield', - fieldLabel: gettext('Send email to'), - name: 'mailto', - }, { xtype: 'pveEmailNotificationSelector', - fieldLabel: gettext('Email'), - name: 'mailnotification', + fieldLabel: gettext('Notify'), + name: 'notification-policy', cbind: { value: (get) => get('isCreate') ? 'always' : '', deleteEmpty: '{!isCreate}', }, }, + { + xtype: 'pveNotificationModeSelector', + fieldLabel: gettext('Notify via'), + name: 'notification-mode', + bind: { + value: '{notificationMode}', + }, + }, + { + xtype: 'pveNotificationChannelSelector', + fieldLabel: gettext('Notification channel'), + name: 'notification-channel', + allowBlank: true, + editable: true, + autoSelect: false, + bind: { + hidden: '{mailNotificationSelected}', + disabled: '{mailNotificationSelected}', + }, + cbind: { + deleteEmpty: '{!isCreate}', + }, + }, + { + xtype: 'textfield', + fieldLabel: gettext('Send email to'), + name: 'mailto', + hidden: true, + bind: { + hidden: '{!mailNotificationSelected}', + disabled: '{!mailNotificationSelected}', + }, + }, { xtype: 'pveCompressionSelector', reference: 'compressionSelector', diff --git a/www/manager6/form/NotificationChannelSelector.js b/www/manager6/form/NotificationChannelSelector.js new file mode 100644 index 00000000..72dfd709 --- /dev/null +++ b/www/manager6/form/NotificationChannelSelector.js @@ -0,0 +1,47 @@ +Ext.define('PVE.form.NotificationChannelSelector', { + extend: 'Proxmox.form.ComboGrid', + alias: ['widget.pveNotificationChannelSelector'], + + // set default value to empty array, else it inits it with + // null and after the store load it is an empty array, + // triggering dirtychange + value: [], + valueField: 'name', + displayField: 'name', + deleteEmpty: true, + skipEmptyText: true, + + store: { + fields: ['name', 'comment'], + proxy: { + type: 'proxmox', + url: '/api2/json/cluster/notifications/channels', + }, + sorters: [ + { + property: 'name', + direction: 'ASC', + }, + ], + autoLoad: true, + }, + + listConfig: { + columns: [ + { + header: gettext('Channel'), + dataIndex: 'name', + sortable: true, + hideable: false, + flex: 1, + }, + { + header: gettext('Comment'), + dataIndex: 'comment', + sortable: true, + hideable: false, + flex: 2, + }, + ], + }, +}); diff --git a/www/manager6/form/NotificationModeSelector.js b/www/manager6/form/NotificationModeSelector.js new file mode 100644 index 00000000..7f56f10a --- /dev/null +++ b/www/manager6/form/NotificationModeSelector.js @@ -0,0 +1,8 @@ +Ext.define('PVE.form.NotificationModeSelector', { + extend: 'Proxmox.form.KVComboBox', + alias: ['widget.pveNotificationModeSelector'], + comboItems: [ + ['channel', gettext('Channel')], + ['mail', gettext('E-Mail')], + ], +}); diff --git a/www/manager6/form/EmailNotificationSelector.js b/www/manager6/form/NotificationPolicySelector.js similarity index 87% rename from www/manager6/form/EmailNotificationSelector.js rename to www/manager6/form/NotificationPolicySelector.js index f318ea18..68087275 100644 --- a/www/manager6/form/EmailNotificationSelector.js +++ b/www/manager6/form/NotificationPolicySelector.js @@ -4,5 +4,6 @@ Ext.define('PVE.form.EmailNotificationSelector', { comboItems: [ ['always', gettext('Notify always')], ['failure', gettext('On failure only')], + ['never', gettext('Notify never')], ], }); -- 2.30.2