Fix #1635 - Escape underscores in packages for markdown

src/NuGetGallery/App_Start/ContainerBindings.cs

@@ -5,7 +5,6 @@
 using System.Web;
 using System.Web.Hosting;
 using System.Web.Mvc;
-using AnglicanGeek.MarkdownMailer;
 using Elmah;
 using Microsoft.WindowsAzure.ServiceRuntime;
 using Ninject;
@@ -16,6 +15,7 @@
 using System.Diagnostics;
 using NuGetGallery.Auditing;
 using NuGetGallery.Infrastructure.Lucene;
+using NuGetGallery.Services;
 
 namespace NuGetGallery
 {

src/NuGetGallery/NuGetGallery.csproj

@@ -93,10 +93,6 @@
     <CodeAnalysisRuleSet>..\Frontend.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="AnglicanGeek.MarkdownMailer, Version=1.2.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\packages\AnglicanGeek.MarkdownMailer.1.2\lib\net40\AnglicanGeek.MarkdownMailer.dll</HintPath>
-    </Reference>
     <Reference Include="Antlr3.Runtime, Version=3.3.1.7705, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\packages\WebGrease.1.1.0\lib\Antlr3.Runtime.dll</HintPath>
@@ -973,6 +969,8 @@
     <Compile Include="Services\ContentService.cs" />
     <Compile Include="Services\IContentService.cs" />
     <Compile Include="Services\IFileReference.cs" />
+    <Compile Include="Services\IMailSender.cs" />
+    <Compile Include="Services\ISmtpClient.cs" />
     <Compile Include="Services\IStatusService.cs" />
     <Compile Include="Services\JsonStatisticsService.cs" />
     <Compile Include="Services\CloudReportService.cs" />
@@ -995,11 +993,14 @@
     <Compile Include="Services\ISearchService.cs" />
     <Compile Include="Services\IUploadFileService.cs" />
     <Compile Include="Services\LocalFileReference.cs" />
+    <Compile Include="Services\MailSender.cs" />
+    <Compile Include="Services\MailSenderConfiguration.cs" />
     <Compile Include="Services\NuGetExeDownloaderService.cs" />
     <Compile Include="Services\PackageFileService.cs" />
     <Compile Include="Filters\RequireSslAttribute.cs" />
     <Compile Include="Services\PackageSearchResults.cs" />
     <Compile Include="Services\JsonAggregateStatsService.cs" />
+    <Compile Include="Services\SmtpClientWrapper.cs" />
     <Compile Include="Services\SqlAggregateStatsService.cs" />
     <Compile Include="Services\ReportPackageRequest.cs" />
     <Compile Include="Services\SearchFilter.cs" />

src/NuGetGallery/Services/IMailSender.cs

@@ -0,0 +1,22 @@
+using System;
+using System.Net.Mail;
+
+namespace NuGetGallery.Services
+{
+    public interface IMailSender : IDisposable
+    {
+        void Send(
+            string fromAddress,
+            string toAddress,
+            string subject,
+            string markdownBody);
+
+        void Send(
+            MailAddress fromAddress,
+            MailAddress toAddress,
+            string subject,
+            string markdownBody);
+
+        void Send(MailMessage mailMessage);
+    }
+}

src/NuGetGallery/Services/ISmtpClient.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Net;
+using System.Net.Mail;
+
+namespace NuGetGallery.Services
+{
+    public interface ISmtpClient : IDisposable
+    {
+        ICredentialsByHost Credentials { get; set; }
+        SmtpDeliveryMethod DeliveryMethod { get; set; }
+        bool EnableSsl { get; set; }
+        string Host { get; set; }
+        string PickupDirectoryLocation { get; set; }
+        int Port { get; set; }
+        void Send(MailMessage message);
+        bool UseDefaultCredentials { get; set; }
+    }
+}

src/NuGetGallery/Services/MailSender.cs

@@ -0,0 +1,118 @@
+using System;
+using System.IO;
+using System.Net.Mail;
+using System.Net.Mime;
+using MarkdownSharp;
+
+namespace NuGetGallery.Services
+{
+    public class MailSender : IMailSender
+    {
+        readonly ISmtpClient smtpClient;
+
+        public MailSender()
+            : this(new SmtpClientWrapper(new SmtpClient()), null)
+        {
+        }
+
+        public MailSender(MailSenderConfiguration configuration)
+            : this(new SmtpClientWrapper(new SmtpClient()), configuration)
+        {
+        }
+
+        public MailSender(SmtpClient smtpClient)
+            : this(new SmtpClientWrapper(smtpClient), null)
+        {
+        }
+
+        internal MailSender(
+            ISmtpClient smtpClient,
+            MailSenderConfiguration configuration)
+        {
+            if (smtpClient == null)
+                throw new ArgumentNullException("smtpClient");
+
+            if (configuration != null)
+                ConfigureSmtpClient(smtpClient, configuration);
+
+            this.smtpClient = smtpClient;
+        }
+
+        static internal void ConfigureSmtpClient(
+            ISmtpClient smtpClient,
+            MailSenderConfiguration configuration)
+        {
+            if (configuration.Host != null)
+                smtpClient.Host = configuration.Host;
+            if (configuration.Port.HasValue)
+                smtpClient.Port = configuration.Port.Value;
+            if (configuration.EnableSsl.HasValue)
+                smtpClient.EnableSsl = configuration.EnableSsl.Value;
+            if (configuration.DeliveryMethod.HasValue)
+                smtpClient.DeliveryMethod = configuration.DeliveryMethod.Value;
+            if (configuration.UseDefaultCredentials.HasValue)
+                smtpClient.UseDefaultCredentials = configuration.UseDefaultCredentials.Value;
+            if (configuration.Credentials != null)
+                smtpClient.Credentials = configuration.Credentials;
+            if (configuration.PickupDirectoryLocation != null)
+                smtpClient.PickupDirectoryLocation = configuration.PickupDirectoryLocation;
+        }
+
+        public void Send(
+            string fromAddress,
+            string toAddress,
+            string subject,
+            string markdownBody)
+        {
+            Send(
+                new MailAddress(fromAddress),
+                new MailAddress(toAddress),
+                subject,
+                markdownBody);
+        }
+
+        public void Send(
+            MailAddress fromAddress,
+            MailAddress toAddress,
+            string subject,
+            string markdownBody)
+        {
+            var mailMessage = new MailMessage(fromAddress, toAddress)
+            {
+                Subject = subject,
+                Body = markdownBody
+            };
+
+            Send(mailMessage);
+        }
+
+        public void Send(MailMessage mailMessage)
+        {
+            if (smtpClient.DeliveryMethod == SmtpDeliveryMethod.SpecifiedPickupDirectory
+                && !Directory.Exists(smtpClient.PickupDirectoryLocation))
+                Directory.CreateDirectory(smtpClient.PickupDirectoryLocation);
+
+            string markdownBody = mailMessage.Body;
+            string htmlBody = new Markdown().Transform(markdownBody);
+
+            AlternateView textView = AlternateView.CreateAlternateViewFromString(
+                markdownBody,
+                null,
+                MediaTypeNames.Text.Plain);
+            mailMessage.AlternateViews.Add(textView);
+
+            AlternateView htmlView = AlternateView.CreateAlternateViewFromString(
+                htmlBody,
+                null,
+                MediaTypeNames.Text.Html);
+            mailMessage.AlternateViews.Add(htmlView);
+
+            smtpClient.Send(mailMessage);
+        }
+
+        public void Dispose()
+        {
+            smtpClient.Dispose();
+        }
+    }
+}

src/NuGetGallery/Services/MailSenderConfiguration.cs

@@ -0,0 +1,16 @@
+using System.Net;
+using System.Net.Mail;
+
+namespace NuGetGallery.Services
+{
+    public class MailSenderConfiguration
+    {
+        public ICredentialsByHost Credentials { get; set; }
+        public SmtpDeliveryMethod? DeliveryMethod { get; set; }
+        public bool? EnableSsl { get; set; }
+        public string Host { get; set; }
+        public string PickupDirectoryLocation { get; set; }
+        public int? Port { get; set; }
+        public bool? UseDefaultCredentials { get; set; }
+    }
+}

src/NuGetGallery/Services/MessageService.cs

@@ -4,11 +4,10 @@
 using System.Net.Mail;
 using System.Text;
 using System.Web;
-using AnglicanGeek.MarkdownMailer;
 using Elmah;
 using NuGetGallery.Authentication;
-using Glimpse.AspNet.AlternateType;
 using NuGetGallery.Configuration;
+using NuGetGallery.Services;
 
 namespace NuGetGallery
 {

src/NuGetGallery/Services/ReportPackageRequest.cs

@@ -23,8 +23,10 @@ internal string FillIn(string subject, IAppConfiguration config)
             // note, format blocks {xxx} are matched by ordinal-case-sensitive comparison
             var builder = new StringBuilder(subject);
 
+            string packageIdMarkdownEscaped = Package.PackageRegistration.Id.Replace("_", "\\_");
+
             Substitute(builder, "{GalleryOwnerName}", config.GalleryOwner.DisplayName);
-            Substitute(builder, "{Id}", Package.PackageRegistration.Id);
+            Substitute(builder, "{Id}", packageIdMarkdownEscaped);
             Substitute(builder, "{Version}", Package.Version);
             Substitute(builder, "{Reason}", Reason);
             if (RequestingUser != null)
@@ -44,8 +46,9 @@ internal string FillIn(string subject, IAppConfiguration config)
             Substitute(builder, "{Name}", FromAddress.DisplayName);
             Substitute(builder, "{Address}", FromAddress.Address);
             Substitute(builder, "{AlreadyContactedOwners}", AlreadyContactedOwners ? "Yes" : "No");
-            Substitute(builder, "{PackageUrl}", Url.Package(Package.PackageRegistration.Id, null, scheme: "http"));
-            Substitute(builder, "{VersionUrl}", Url.Package(Package.PackageRegistration.Id, Package.Version, scheme: "http"));
+            // Fix for Markdown Mailer compatible urls containing _
+            Substitute(builder, "{PackageUrl}", Url.Package(packageIdMarkdownEscaped, null, scheme: "http").Replace("%5C", "\\"));
+            Substitute(builder, "{VersionUrl}", Url.Package(packageIdMarkdownEscaped, Package.Version, scheme: "http").Replace("%5C", "\\"));
             Substitute(builder, "{Reason}", Reason);
             Substitute(builder, "{Message}", Message);
 

src/NuGetGallery/Services/SmtpClientWrapper.cs

@@ -0,0 +1,67 @@
+using System.Net;
+using System.Net.Mail;
+
+namespace NuGetGallery.Services
+{
+    public class SmtpClientWrapper : ISmtpClient
+    {
+        readonly SmtpClient smtpClient;
+
+        public SmtpClientWrapper(SmtpClient smtpClient)
+        {
+            this.smtpClient = smtpClient;
+        }
+
+        public ICredentialsByHost Credentials
+        {
+            get { return smtpClient.Credentials; }
+            set { smtpClient.Credentials = value; }
+        }
+
+        public SmtpDeliveryMethod DeliveryMethod
+        {
+            get { return smtpClient.DeliveryMethod; }
+            set { smtpClient.DeliveryMethod = value; }
+        }
+
+        public bool EnableSsl
+        {
+            get { return smtpClient.EnableSsl; }
+            set { smtpClient.EnableSsl = value; }
+        }
+
+        public void Dispose()
+        {
+            smtpClient.Dispose();
+        }
+
+        public string Host
+        {
+            get { return smtpClient.Host; }
+            set { smtpClient.Host = value; }
+        }
+
+        public string PickupDirectoryLocation
+        {
+            get { return smtpClient.PickupDirectoryLocation; }
+            set { smtpClient.PickupDirectoryLocation = value; }
+        }
+
+        public int Port
+        {
+            get { return smtpClient.Port; }
+            set { smtpClient.Port = value; }
+        }
+
+        public void Send(MailMessage message)
+        {
+            smtpClient.Send(message);
+        }
+
+        public bool UseDefaultCredentials
+        {
+            get { return smtpClient.UseDefaultCredentials; }
+            set { smtpClient.UseDefaultCredentials = value; }
+        }
+    }
+}

src/NuGetGallery/packages.config

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="AnglicanGeek.MarkdownMailer" version="1.2" />
   <package id="AnglicanGeek.WindowsAzure.ServiceRuntime" version="1.6" targetFramework="net45" />
   <package id="d3" version="3.0.2" targetFramework="net45" />
   <package id="DynamicData.EFCodeFirstProvider" version="0.3.0.0" />

tests/NuGetGallery.Facts/NuGetGallery.Facts.csproj

@@ -40,10 +40,6 @@
     <Prefer32Bit>false</Prefer32Bit>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="AnglicanGeek.MarkdownMailer, Version=1.2.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <SpecificVersion>False</SpecificVersion>
-      <HintPath>..\..\packages\AnglicanGeek.MarkdownMailer.1.2\lib\net40\AnglicanGeek.MarkdownMailer.dll</HintPath>
-    </Reference>
     <Reference Include="EntityFramework, Version=5.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
       <HintPath>..\..\packages\EntityFramework.5.0.0\lib\net45\EntityFramework.dll</HintPath>

tests/NuGetGallery.Facts/Services/MessageServiceFacts.cs

@@ -3,9 +3,9 @@
 using System.Linq;
 using System.Collections.ObjectModel;
 using System.Net.Mail;
-using AnglicanGeek.MarkdownMailer;
 using Moq;
 using NuGetGallery.Areas.Admin.DynamicData;
+using NuGetGallery.Services;
 using Xunit;
 using NuGetGallery.Configuration;
 using NuGetGallery.Framework;
@@ -506,6 +506,10 @@ public void Send(string fromAddress, string toAddress, string subject, string ma
             {
                 Send(new MailMessage(fromAddress, toAddress, subject, markdownBody));
             }
+
+            public void Dispose()
+            {
+            }
         }
     }
 }

tests/NuGetGallery.Facts/packages.config

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="AnglicanGeek.MarkdownMailer" version="1.2" />
   <package id="EntityFramework" version="5.0.0" targetFramework="net45" />
   <package id="Glimpse" version="1.8.0" targetFramework="net45" />
   <package id="Glimpse.AspNet" version="1.6.0" targetFramework="net45" />