xenadmin/XenAdmin/SettingsPanels/PerfmonAlertOptionsPage.cs
Mihaela Stoica 3c051654d6 CA-136173: Getting several notifications for one user-level action (e.g. Updating network operation creates 4 entries in the Notifications/Events view)
-  Suppress reporting of success and failure for sub-actions:
The suppress history flag is set when the action is created and if is false (by default) the action is added to the history (the Events list).
In order to suppress history for the subactions, we need change all actions used in Edit pages so their constructor can set the SuppressHistory flag and then use these constructors with suppressHistory = true on all the implementations of IEditPage.SaveSettings() where an action is created
(then we need to remember to do the same everytime we introduce a new page and / or "save" action).

Signed-off-by: Mihaela Stoica <mihaela.stoica@citrix.com>
2014-07-21 11:19:04 +01:00

208 lines
7.5 KiB
C#

/* Copyright (c) Citrix Systems Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms,
* with or without modification, are permitted provided
* that the following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Text.RegularExpressions;
using XenAPI;
using XenAdmin;
using XenAdmin.SettingsPanels;
using XenAdmin.Alerts;
using XenAdmin.Network;
using XenAdmin.Actions;
using XenAdmin.Core;
namespace XenAdmin.SettingsPanels
{
public partial class PerfmonAlertOptionsPage : UserControl, IEditPage
{
private IXenObject _XenModelObject;
private PerfmonOptionsDefinition _PerfmonOptions;
private bool _OrigEmailNotificationCheckBox;
private string _OrigEmailAddressTextBox;
private string _OrigSmtpServerAddrTextBox;
private string _OrigSmtpServerPortTextBox;
private readonly ToolTip InvalidParamToolTip;
public PerfmonAlertOptionsPage()
{
InitializeComponent();
Text = Messages.EMAIL_OPTIONS;
InvalidParamToolTip = new ToolTip();
InvalidParamToolTip.IsBalloon = true;
InvalidParamToolTip.ToolTipIcon = ToolTipIcon.Warning;
InvalidParamToolTip.ToolTipTitle = Messages.INVALID_PARAMETER;
EmailNotificationCheckBox_CheckedChanged(null, null);
}
public String SubText
{
get
{
if (!EmailNotificationCheckBox.Checked)
return Messages.NONE_DEFINED;
return EmailAddressTextBox.Text;
}
}
public Image Image
{
get
{
return Properties.Resources._000_Email_h32bit_16;
}
}
// match anything with an @ sign in the middle
private static readonly Regex emailRegex = new Regex(@"\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*", RegexOptions.IgnoreCase);
public static bool IsValidEmail(string s)
{
return emailRegex.IsMatch(s);
}
private bool IsValidSmtpAddress()
{
return !SmtpServerAddrTextBox.Text.ToCharArray().Any((c) => c >= 128) && SmtpServerAddrTextBox.Text.Trim().Length > 0;
}
public void SetXenObjects(IXenObject orig, IXenObject clone)
{
_XenModelObject = clone;
Repopulate();
// Save original settings for change detection
_OrigEmailNotificationCheckBox = EmailNotificationCheckBox.Checked;
_OrigEmailAddressTextBox = EmailAddressTextBox.Text;
_OrigSmtpServerAddrTextBox = SmtpServerAddrTextBox.Text;
_OrigSmtpServerPortTextBox = SmtpServerPortTextBox.Text;
}
public void Repopulate()
{
if (_XenModelObject == null)
return;
try
{
_PerfmonOptions = PerfmonOptionsDefinition.GetPerfmonOptionsDefinitions(_XenModelObject);
if (_PerfmonOptions != null)
{
EmailNotificationCheckBox.Checked = true;
EmailAddressTextBox.Text = _PerfmonOptions.MailDestination;
SmtpServerAddrTextBox.Text = PerfmonOptionsDefinition.GetSmtpServerAddress(_PerfmonOptions.MailHub);
SmtpServerPortTextBox.Text = PerfmonOptionsDefinition.GetSmtpPort(_PerfmonOptions.MailHub);
}
}
catch { }
} // Repopulate()
public bool HasChanged
{
get
{
return ((_OrigEmailNotificationCheckBox != EmailNotificationCheckBox.Checked) ||
(_OrigEmailAddressTextBox != EmailAddressTextBox.Text) ||
(_OrigSmtpServerAddrTextBox != SmtpServerAddrTextBox.Text) ||
(_OrigSmtpServerPortTextBox != SmtpServerPortTextBox.Text));
}
}
public void ShowLocalValidationMessages()
{
if (!IsValidEmail(EmailAddressTextBox.Text))
{
HelpersGUI.ShowBalloonMessage(EmailAddressTextBox, Messages.INVALID_PARAMETER, InvalidParamToolTip);
}
else if (!IsValidSmtpAddress())
{
HelpersGUI.ShowBalloonMessage(SmtpServerAddrTextBox, Messages.INVALID_PARAMETER, InvalidParamToolTip);
}
else if (!Util.IsValidPort(SmtpServerPortTextBox.Text))
{
HelpersGUI.ShowBalloonMessage(SmtpServerPortTextBox, Messages.INVALID_PARAMETER, InvalidParamToolTip);
}
}
public bool ValidToSave
{
get
{
if (EmailNotificationCheckBox.Checked)
{
return IsValidEmail(EmailAddressTextBox.Text) && Util.IsValidPort(SmtpServerPortTextBox.Text) && IsValidSmtpAddress();
}
else
{
return true;
}
}
}
public void Cleanup()
{
InvalidParamToolTip.Dispose();
}
public AsyncAction SaveSettings()
{
PerfmonOptionsDefinition perfmonOptions = null; // a null value will clear the definitions
if (EmailNotificationCheckBox.Checked)
{
string smtpMailHub = SmtpServerAddrTextBox.Text + ":" + SmtpServerPortTextBox.Text;
perfmonOptions = new PerfmonOptionsDefinition(smtpMailHub, EmailAddressTextBox.Text);
}
return new PerfmonOptionsDefinitionAction(_XenModelObject.Connection, perfmonOptions, true);
}
private void EmailNotificationCheckBox_CheckedChanged(object sender, EventArgs e)
{
EmailAddressTextBox.Enabled = EmailNotificationCheckBox.Checked;
SmtpServerAddrTextBox.Enabled = EmailNotificationCheckBox.Checked;
SmtpServerPortTextBox.Enabled = EmailNotificationCheckBox.Checked;
}
}
}