issuenotification.cs

BugNET is an issue tracking and project issue management solution built using the ASP.NET web applic

using System;
using System.Text;
using System.Web;
using System.Xml;
using System.Xml.Xsl;
using System.IO;
using System.Collections;
using Lesnikowski.Client;
using Lesnikowski.Mail;
using BugNET.POP3Reader;
using BugNET.DataAccessLayer;
using BugNET.BusinessLogicLayer;
using System.Net.Mail;
using System.Net;
using log4net;
using System.Collections.Generic;
using System.Web.Security;

namespace BugNET.BusinessLogicLayer
{
	/// <summary>
	/// Summary description for Notification.
	/// </summary>
	public class IssueNotification
	{
		private int _IssueId;
		private int _Id;
		private string _NotificationUsername;
		private string _NotificationEmail;
        private string _NotificationDisplayName;
        private static readonly ILog Log = LogManager.GetLogger(typeof(IssueNotification));

        /// <summary>
        /// Initializes a new instance of the <see cref="T:IssueNotification"/> class.
        /// </summary>
        /// <param name="id">The id.</param>
        /// <param name="issueId">The bug id.</param>
        /// <param name="notificationUsername">The notification username.</param>
        /// <param name="notificationEmail">The notification email.</param>
		public IssueNotification(int id,int issueId, string notificationUsername,string notificationEmail, string notificationDisplayName)
		{
			_Id = id;
			_IssueId = issueId;
			_NotificationUsername = notificationUsername;
			_NotificationEmail =notificationEmail;
            _NotificationDisplayName = notificationDisplayName;
		}
        /// <summary>
        /// Initializes a new instance of the <see cref="T:IssueNotification"/> class.
        /// </summary>
        /// <param name="issueId">The bug id.</param>
        /// <param name="notificationUsername">The notification username.</param>
		public IssueNotification(int issueId,string notificationUsername) : 
			this(Globals.NewId,issueId,notificationUsername,string.Empty,string.Empty){}

        /// <summary>
        /// Initializes a new instance of the <see cref="T:IssueNotification"/> class.
        /// </summary>
		public IssueNotification(){}

        /// <summary>
        /// Gets or sets the display name of the notification.
        /// </summary>
        /// <value>The display name of the notification.</value>
        public string NotificationDisplayName 
        {
            get { return _NotificationDisplayName; }
            set { _NotificationDisplayName = value; }
        }

        /// <summary>
        /// Gets the id.
        /// </summary>
        /// <value>The id.</value>
		public int Id 
		{
			get {return _Id;}
		}

        /// <summary>
        /// Gets or sets the issue id.
        /// </summary>
        /// <value>The issue id.</value>
		public int IssueId 
		{
			get {return _IssueId; }
			set
			{
				if (value<= DefaultValues.GetIssueIdMinValue() )
					throw (new ArgumentOutOfRangeException("value"));
				_IssueId=value;
			}
		}

        /// <summary>
        /// Gets the notification username.
        /// </summary>
        /// <value>The notification username.</value>
		public string NotificationUsername 
		{
			get 
			{
				if (_NotificationUsername == null || _NotificationUsername.Length==0)
					return string.Empty;
				else
					return _NotificationUsername;
			}
		}

        /// <summary>
        /// Gets the notification email.
        /// </summary>
        /// <value>The notification email.</value>
		public string NotificationEmail 
		{
			get 
			{
				if (_NotificationEmail == null || _NotificationEmail.Length==0)
					return string.Empty;
				else
					return _NotificationEmail;
			}
		}

        /// <summary>
        /// Notifcate Type
        /// </summary>
		public enum NotificationType
		{
            /// <summary>
            /// Bug update email
            /// </summary>
			BugUpdate = 1,
            /// <summary>
            /// Assigned to new user email
            /// </summary>
			BugAssignedToNewUser,
            /// <summary>
            /// New user registered email
            /// </summary>
			NewUserRegistered
		}

        /// <summary>
        /// Saves this instance.
        /// </summary>
        /// <returns></returns>
		public bool Save () 
		{
            int TempId = DataProviderManager.Provider.CreateNewIssueNotification(this);
			if (TempId>0) 
			{
				_Id = TempId;
				return true;
			} 
			else
				return false;
		}
        /// <summary>
        /// Deletes the bug notification.
        /// </summary>
        /// <param name="issueId">The bug id.</param>
        /// <param name="username">The username.</param>
        /// <returns></returns>
		public static bool DeleteIssueNotification(int issueId, string username) 
		{
			if (issueId <= Globals.NewId )
				throw (new ArgumentOutOfRangeException("issueId"));

			return DataProviderManager.Provider.DeleteIssueNotification(issueId, username);
		}

        /// <summary>
        /// Gets the bug notifications by bug id.
        /// </summary>
        /// <param name="issueId">The bug id.</param>
        /// <returns></returns>
		public static List<IssueNotification> GetIssueNotificationsByIssueId(int issueId)
		{
			if (issueId <= Globals.NewId)
				throw (new ArgumentOutOfRangeException("issueId"));

			return DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);
		}

        /// <summary>
        /// Sends an email to all users that are subscribed to a bug
        /// </summary>
        /// <param name="issueId">The bug id.</param>
		public static void SendIssueNotifications(int issueId) 
		{
			if (issueId <= Globals.NewId)
				throw (new ArgumentOutOfRangeException("issueId"));

			Issue issue = DataProviderManager.Provider.GetIssueById(issueId);
            List<IssueNotification> issNotifications = DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);
       
            //load plugins 
            NotificationManager nm = new NotificationManager();
            nm.LoadNotificationTypes();

            //load template and replace the tokens
            string template = nm.LoadNotificationTemplate("IssueUpdated"); 
            nm.ReplaceTokens(ref template,issue);
            string subject = nm.LoadNotificationTemplate("IssueUpdatedSubject"); 
            string displayname = ITUser.GetUserDisplayName(Security.GetUserName());
           
			foreach (IssueNotification notify in issNotifications) 
			{
				try 
				{
                    //send notifications to everyone except who changed it.
                    if (notify.NotificationUsername != Security.GetUserName())
                    {                     
                        nm.SendNotification(notify.NotificationUsername, String.Format(subject, issue.FullId, displayname),template);
                    }
				} 
				catch(Exception ex)
				{
                    ProcessException(ex);
				}
			}
		}

        /// <summary>
        /// Sends the issue add notifications.
        /// </summary>
        /// <param name="issueId">The issue id.</param>
        public static void SendIssueAddNotifications(int issueId)
        {
            // validate input
            if (issueId <= Globals.NewId)
                throw (new ArgumentOutOfRangeException("issueId"));

            Issue issue = DataProviderManager.Provider.GetIssueById(issueId);
            List<IssueNotification> issNotifications = DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);

            NotificationManager nm = new NotificationManager();
            nm.LoadNotificationTypes();

            //load template and replace the tokens
            string template = nm.LoadNotificationTemplate("IssueAdded");
            nm.ReplaceTokens(ref template, issue,null, null);
            string subject = nm.LoadNotificationTemplate("IssueAddedSubject"); 
            string displayname = ITUser.GetUserDisplayName(Security.GetUserName());
            

            foreach (IssueNotification notify in issNotifications)
            {
                try
                {
                    //send notifications to everyone except who changed it.
                    if (notify.NotificationUsername != Security.GetUserName())
                    {
                        nm.SendNotification(notify.NotificationUsername, String.Format(subject, issue.FullId, displayname), template);
                    }
                }
                catch (Exception ex)
                {
                    ProcessException(ex);
                }
            }
        }


        /// <summary>
        /// Sends the issue notifications.
        /// </summary>
        /// <param name="issueId">The issue id.</param>
        /// <param name="issueChanges">The issue changes.</param>
        public static void SendIssueNotifications(int issueId, string issueChanges)
        {
            // validate input
            if (issueId <= Globals.NewId)
                throw (new ArgumentOutOfRangeException("issueId"));

            Issue issue = DataProviderManager.Provider.GetIssueById(issueId);
            List<IssueNotification> issNotifications = DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);

            //load notification plugins 
            NotificationManager nm = new NotificationManager();
            nm.LoadNotificationTypes();

            //load template and replace the tokens
            string template = nm.LoadNotificationTemplate("IssueUpdatedWithChanges");
            nm.ReplaceTokens(ref template, issue);
            string subject = nm.LoadNotificationTemplate("IssueUpdatedSubject"); 
            string displayname = ITUser.GetUserDisplayName(Security.GetUserName());
         

            foreach (IssueNotification notify in issNotifications)
            {
                try
                {
                    //send notifications to everyone except who changed it.
                    if (notify.NotificationUsername != Security.GetUserName())
                    {
                        nm.SendNotification(notify.NotificationUsername, String.Format(subject, issue.FullId, displayname), String.Format(template, issueChanges));
                    }
                }
                catch (Exception ex)
                {
                    ProcessException(ex);
                }
            }
        }

        /// <summary>
        /// Sends an email to the user that is assigned to the issue
        /// </summary>
        /// <param name="issueId">The issue id.</param>
        /// <param name="newAssigneeUserName">New name of the assignee user.</param>
		public static void SendNewAssigneeNotification(int issueId, string newAssigneeUserName)
		{
			if (issueId <= Globals.NewId)
				throw (new ArgumentOutOfRangeException("issueId"));

            Issue issue = DataProviderManager.Provider.GetIssueById(issueId);
            List<IssueNotification> issNotifications = DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);

            //load notification plugins 
            NotificationManager nm = new NotificationManager();
            nm.LoadNotificationTypes();

            //load template and replace the tokens
            string template = nm.LoadNotificationTemplate("NewAssignee");
            nm.ReplaceTokens(ref template, issue);
            string subject = nm.LoadNotificationTemplate("NewAssigneeSubject"); 
            string displayname = ITUser.GetUserDisplayName(Security.GetUserName());
           

            foreach (IssueNotification notify in issNotifications)
            {
                try
                {
                    //send notifications to everyone except who changed it.
                    if (notify.NotificationUsername != Security.GetUserName())
                    {
                        nm.SendNotification(notify.NotificationUsername, String.Format(subject, issue.FullId), template);
                    }
                }
                catch (Exception ex)
                {
                    ProcessException(ex);
                }
            }
		}

        /// <summary>
        /// Sends the new issue comment notification.
        /// </summary>
        /// <param name="issueId">The issue id.</param>
        /// <param name="newComment">The new comment.</param>
        public static void SendNewIssueCommentNotification(int issueId, IssueComment newComment)
        {
            if (issueId <= Globals.NewId)
                throw (new ArgumentOutOfRangeException("issueId"));
            if (newComment == null)
                throw new ArgumentNullException("newComment");

            Issue issue = DataProviderManager.Provider.GetIssueById(issueId);
            List<IssueNotification> issNotifications = DataProviderManager.Provider.GetIssueNotificationsByIssueId(issueId);

            //load notification plugins 
            NotificationManager nm = new NotificationManager();
            nm.LoadNotificationTypes();

            //load template and replace the tokens
            string template = nm.LoadNotificationTemplate("NewIssueComment");
            nm.ReplaceTokens(ref template, newComment);
            string subject = nm.LoadNotificationTemplate("NewIssueCommentSubject");  
            string displayname = ITUser.GetUserDisplayName(Security.GetUserName());
            

            foreach (IssueNotification notify in issNotifications)
            {
                try
                {
                    //send notifications to everyone except who changed it.
                   //{
                        nm.SendNotification(notify.NotificationUsername, String.Format(subject, issue.FullId,displayname), template);
                   // }
                }
                catch (Exception ex)
                {
                    ProcessException(ex);
                }
            }
        }

        
         

        /// <summary>
        /// Processes the exception by logging and throwing a wrapper exception with non-sensitive data.
        /// </summary>
        /// <param name="ex">The ex.</param>
        /// <returns>New exception to wrap the thrown one.</returns>
        private static ApplicationException ProcessException(Exception ex)
        {
            //set user to log4net context, so we can use %X{user} in the appenders
            if (HttpContext.Current != null && HttpContext.Current.User != null && HttpContext.Current.User.Identity.IsAuthenticated)
                MDC.Set("user", HttpContext.Current.User.Identity.Name);

            if (Log.IsErrorEnabled)
                Log.Error("Email Notification Error", ex);

            return new ApplicationException("An error has occured sending notifications. Please check the error log for details.", ex);
        }
	}
}