Pre release polish

Former-commit-id: f18d297cafde4ca9a7d6e9aeb40fa6e038044295
Former-commit-id: bbe58c41a02747a536016c8872319e4499623479

build/content/ImageProcessor.Web.AzureBlobCache/config/imageprocessor/cache.config.transform

@@ -1,13 +1,12 @@
 <caching currentCache="AzureBlobCache">
   <caches>
-    <cache name="AzureBlobCache" type="ImageProcessor.Web.Caching.AzureBlobCache, ImageProcessor.Web.Caching.AzureBlobCache">
+    <cache name="AzureBlobCache" type="ImageProcessor.Web.Caching.AzureBlobCache, ImageProcessor.Web.Caching.AzureBlobCache" maxDays="365">
       <settings>
-        <setting key="MaxDays" value="365"/>
         <setting key="CachedStorageAccount" value="DefaultEndpointsProtocol=https;AccountName=[CacheAccountName];AccountKey=[CacheAccountKey]"/>
-        <setting key="SourceStorageAccount" value="DefaultEndpointsProtocol=https;AccountName=[SourceAccountName];AccountKey=[SourceAccountKey]"/>
         <setting key="CachedBlobContainer" value="cache"/>
-        <setting key="SourceBlobContainer" value="source"/>
         <setting key="CachedCDNRoot" value="[CdnRootUrl]"/>
+        <setting key="SourceStorageAccount" value=""/>
+        <setting key="SourceBlobContainer" value=""/>
       </settings>
     </cache>
   </caches>

src/ImageProcessor.Playground/Program.cs

@@ -39,10 +39,6 @@ namespace ImageProcessor.PlayGround
         /// </param>
         public static void Main(string[] args)
         {
-            var x = typeof(AzureBlobCache);
-            Console.WriteLine(x.AssemblyQualifiedName);
-            Console.ReadLine();
-
             string path = new Uri(System.Reflection.Assembly.GetExecutingAssembly().CodeBase).LocalPath;
 
             // ReSharper disable once AssignNullToNotNullAttribute

src/ImageProcessor.Web.AzureBlobCache/AzureBlobCache.cs

@@ -23,6 +23,7 @@ namespace ImageProcessor.Web.Caching
 
     using ImageProcessor.Web.Extensions;
     using ImageProcessor.Web.Helpers;
+    using ImageProcessor.Web.HttpModules;
 
     using Microsoft.WindowsAzure.Storage;
     using Microsoft.WindowsAzure.Storage.Blob;
@@ -34,9 +35,14 @@ namespace ImageProcessor.Web.Caching
     public class AzureBlobCache : ImageCacheBase
     {
         /// <summary>
-        /// The maximum number of days to store the image.
+        /// The regular expression for parsing a remote uri.
         /// </summary>
-        private readonly int maxDays;
+        private static readonly Regex RemoteRegex = new Regex("^http(s)?://", RegexOptions.Compiled);
+
+        /// <summary>
+        /// The assembly version.
+        /// </summary>
+        private static readonly string AssemblyVersion = typeof(ImageProcessingModule).Assembly.GetName().Version.ToString();
 
         /// <summary>
         /// The cloud cached blob container.
@@ -73,32 +79,26 @@ namespace ImageProcessor.Web.Caching
         public AzureBlobCache(string requestPath, string fullPath, string querystring)
             : base(requestPath, fullPath, querystring)
         {
-            this.maxDays = Convert.ToInt32(this.Settings["MaxDays"]);
-
             // Retrieve storage accounts from connection string.
             CloudStorageAccount cloudCachedStorageAccount = CloudStorageAccount.Parse(this.Settings["CachedStorageAccount"]);
-            CloudStorageAccount cloudSourceStorageAccount = CloudStorageAccount.Parse(this.Settings["SourceStorageAccount"]);
 
             // Create the blob clients.
             CloudBlobClient cloudCachedBlobClient = cloudCachedStorageAccount.CreateCloudBlobClient();
-            CloudBlobClient cloudSourceBlobClient = cloudSourceStorageAccount.CreateCloudBlobClient();
 
             // Retrieve references to a previously created containers.
             this.cloudCachedBlobContainer = cloudCachedBlobClient.GetContainerReference(this.Settings["CachedBlobContainer"]);
-            this.cloudSourceBlobContainer = cloudSourceBlobClient.GetContainerReference(this.Settings["SourceBlobContainer"]);
 
-            this.cachedCdnRoot = this.Settings["CachedCDNRoot"];
+            string sourceAccount = this.Settings.ContainsKey("SourceStorageAccount") ? this.Settings["SourceStorageAccount"] : string.Empty;
-        }
 
-        /// <summary>
+            // Repeat for source if it exists
-        /// Gets the maximum number of days to store the image.
+            if (!string.IsNullOrWhiteSpace(sourceAccount))
-        /// </summary>
-        public override int MaxDays
-        {
-            get
             {
-                return this.maxDays;
+                CloudStorageAccount cloudSourceStorageAccount = CloudStorageAccount.Parse(this.Settings["SourceStorageAccount"]);
+                CloudBlobClient cloudSourceBlobClient = cloudSourceStorageAccount.CreateCloudBlobClient();
+                this.cloudSourceBlobContainer = cloudSourceBlobClient.GetContainerReference(this.Settings["SourceBlobContainer"]);
             }
+
+            this.cachedCdnRoot = this.Settings.ContainsKey("CachedCDNRoot") ? this.Settings["CachedCDNRoot"] : string.Empty;
         }
 
         /// <summary>
@@ -109,7 +109,7 @@ namespace ImageProcessor.Web.Caching
         /// </returns>
         public override async Task<bool> IsNewOrUpdatedAsync()
         {
-            string cachedFileName = await this.CreateCachedFileName();
+            string cachedFileName = await this.CreateCachedFileNameAsync();
 
             // Collision rate of about 1 in 10000 for the folder structure.
             // That gives us massive scope to store millions of files.
@@ -118,7 +118,7 @@ namespace ImageProcessor.Web.Caching
             this.cachedRewritePath = Path.Combine(this.cachedCdnRoot, this.cloudCachedBlobContainer.Name, pathFromKey, cachedFileName).Replace(@"\", "/");
 
             bool isUpdated = false;
-            CachedImage cachedImage = CacheIndexer.GetValue(this.CachedPath);
+            CachedImage cachedImage = CacheIndexer.Get(this.CachedPath);
 
             if (new Uri(this.CachedPath).IsFile)
             {
@@ -205,6 +205,9 @@ namespace ImageProcessor.Web.Caching
             blockBlob.Properties.ContentType = contentType;
             blockBlob.Properties.CacheControl = string.Format("public, max-age={0}", this.MaxDays * 86400);
             await blockBlob.SetPropertiesAsync();
+
+            blockBlob.Metadata.Add("ImageProcessedBy", "ImageProcessor.Web/" + AssemblyVersion);
+            await blockBlob.SetMetadataAsync();
         }
 
         /// <summary>
@@ -257,7 +260,7 @@ namespace ImageProcessor.Web.Caching
         /// <returns>
         /// The asynchronous <see cref="Task"/> returning the value.
         /// </returns>
-        public override async Task<string> CreateCachedFileName()
+        public override async Task<string> CreateCachedFileNameAsync()
         {
             string streamHash = string.Empty;
 
@@ -279,11 +282,10 @@ namespace ImageProcessor.Web.Caching
                         streamHash = string.Format("{0}{1}", creation, length);
                     }
                 }
-                else
+                else if (this.cloudSourceBlobContainer != null)
                 {
-                    Regex regex = new Regex("^http(s)?://");
+                    string container = RemoteRegex.Replace(this.cloudSourceBlobContainer.Uri.ToString(), string.Empty);
-                    string container = regex.Replace(this.cloudSourceBlobContainer.Uri.ToString(), string.Empty);
+                    string blobPath = RemoteRegex.Replace(this.RequestPath, string.Empty);
-                    string blobPath = regex.Replace(this.RequestPath, string.Empty);
                     blobPath = blobPath.Replace(container, string.Empty).TrimStart('/');
                     CloudBlockBlob blockBlob = this.cloudSourceBlobContainer.GetBlockBlobReference(blobPath);
 

src/ImageProcessor.Web/Caching/CacheIndexer.cs

@@ -20,7 +20,6 @@ namespace ImageProcessor.Web.Caching
     /// </summary>
     public static class CacheIndexer
     {
-        #region Public
         /// <summary>
         /// Gets the <see cref="CachedImage"/> associated with the specified key.
         /// </summary>
@@ -31,7 +30,7 @@ namespace ImageProcessor.Web.Caching
         /// The <see cref="CachedImage"/> matching the given key if the <see cref="CacheIndexer"/> contains an element with 
         /// the specified key; otherwise, null.
         /// </returns>
-        public static CachedImage GetValue(string cachedPath)
+        public static CachedImage Get(string cachedPath)
         {
             string key = Path.GetFileNameWithoutExtension(cachedPath);
             CachedImage cachedImage = (CachedImage)MemCache.GetItem(key);
@@ -80,6 +79,5 @@ namespace ImageProcessor.Web.Caching
 
             return cachedImage;
         }
-        #endregion
     }
 }

src/ImageProcessor.Web/Caching/DiskCache.cs

@@ -11,7 +11,6 @@
 
 namespace ImageProcessor.Web.Caching
 {
-    using System;
     using System.Collections.Generic;
     using System.Configuration;
     using System.IO;
@@ -40,11 +39,6 @@ namespace ImageProcessor.Web.Caching
         /// </remarks>
         private const int MaxFilesCount = 100;
 
-        /// <summary>
-        /// The maximum number of days to store the image.
-        /// </summary>
-        private readonly int maxDays;
-
         /// <summary>
         /// The virtual cache path.
         /// </summary>
@@ -75,7 +69,6 @@ namespace ImageProcessor.Web.Caching
         public DiskCache(string requestPath, string fullPath, string querystring)
             : base(requestPath, fullPath, querystring)
         {
-            this.maxDays = Convert.ToInt32(this.Settings["MaxDays"]);
             string virtualPath = this.Settings["VirtualCachePath"];
 
             if (!virtualPath.IsValidVirtualPathName())
@@ -88,17 +81,6 @@ namespace ImageProcessor.Web.Caching
             this.absoluteCachePath = HostingEnvironment.MapPath(this.virtualCachePath);
         }
 
-        /// <summary>
-        /// Gets the maximum number of days to store the image.
-        /// </summary>
-        public override int MaxDays
-        {
-            get
-            {
-                return this.maxDays;
-            }
-        }
-
         /// <summary>
         /// Gets a value indicating whether the image is new or updated in an asynchronous manner.
         /// </summary>
@@ -107,7 +89,7 @@ namespace ImageProcessor.Web.Caching
         /// </returns>
         public override async Task<bool> IsNewOrUpdatedAsync()
         {
-            string cachedFileName = await this.CreateCachedFileName();
+            string cachedFileName = await this.CreateCachedFileNameAsync();
 
             // Collision rate of about 1 in 10000 for the folder structure.
             // That gives us massive scope to store millions of files.
@@ -117,7 +99,7 @@ namespace ImageProcessor.Web.Caching
             this.virtualCachedFilePath = Path.Combine(this.virtualCachePath, virtualPathFromKey, cachedFileName).Replace(@"\", "/");
 
             bool isUpdated = false;
-            CachedImage cachedImage = CacheIndexer.GetValue(this.CachedPath);
+            CachedImage cachedImage = CacheIndexer.Get(this.CachedPath);
 
             if (cachedImage == null)
             {

src/ImageProcessor.Web/Caching/IImageCache.cs

@@ -31,9 +31,9 @@ namespace ImageProcessor.Web.Caching
         string CachedPath { get; }
 
         /// <summary>
-        /// Gets the maximum number of days to store the image.
+        /// Gets or sets the maximum number of days to store the image.
         /// </summary>
-        int MaxDays { get; }
+        int MaxDays { get; set; }
 
         /// <summary>
         /// Gets a value indicating whether the image is new or updated in an asynchronous manner.
@@ -66,12 +66,12 @@ namespace ImageProcessor.Web.Caching
         Task TrimCacheAsync();
 
         /// <summary>
-        /// Gets a string identifying the cached file name.
+        /// Gets a string identifying the cached file name in an asynchronous manner.
         /// </summary>
         /// <returns>
         /// The asynchronous <see cref="Task"/> returning the value.
         /// </returns>
-        Task<string> CreateCachedFileName();
+        Task<string> CreateCachedFileNameAsync();
 
         /// <summary>
         /// Rewrites the path to point to the cached image.

src/ImageProcessor.Web/Caching/ImageCacheBase.cs

@@ -61,6 +61,7 @@ namespace ImageProcessor.Web.Caching
             this.FullPath = fullPath;
             this.Querystring = querystring;
             this.Settings = ImageProcessorConfiguration.Instance.ImageCacheSettings;
+            this.MaxDays = ImageProcessorConfiguration.Instance.ImageCacheMaxDays;
         }
 
         /// <summary>
@@ -74,9 +75,9 @@ namespace ImageProcessor.Web.Caching
         public string CachedPath { get; set; }
 
         /// <summary>
-        /// Gets the maximum number of days to store the image.
+        /// Gets or sets the maximum number of days to store the image.
         /// </summary>
-        public abstract int MaxDays { get; }
+        public int MaxDays { get; set; }
 
         /// <summary>
         /// Gets a value indicating whether the image is new or updated in an asynchronous manner.
@@ -114,7 +115,7 @@ namespace ImageProcessor.Web.Caching
         /// <returns>
         /// The asynchronous <see cref="Task"/> returning the value.
         /// </returns>
-        public virtual Task<string> CreateCachedFileName()
+        public virtual async Task<string> CreateCachedFileNameAsync()
         {
             string streamHash = string.Empty;
 
@@ -153,7 +154,7 @@ namespace ImageProcessor.Web.Caching
                  encryptedName,
                  !string.IsNullOrWhiteSpace(parsedExtension) ? parsedExtension.Replace(".", string.Empty) : "jpg");
 
-            return Task.FromResult(cachedFileName);
+            return await Task.FromResult(cachedFileName);
         }
 
         /// <summary>

src/ImageProcessor.Web/Caching/MemCache.cs

@@ -10,19 +10,16 @@
 
 namespace ImageProcessor.Web.Caching
 {
-    #region Using
     using System;
     using System.Collections.Concurrent;
     using System.Collections.Generic;
     using System.Runtime.Caching;
-    #endregion
 
     /// <summary>
     /// Encapsulates methods that allow the caching and retrieval of objects from the in memory cache.
     /// </summary>
     internal static class MemCache
     {
-        #region Fields
         /// <summary>
         /// The cache
         /// </summary>
@@ -32,9 +29,7 @@ namespace ImageProcessor.Web.Caching
         /// An internal list of cache keys to allow bulk removal.
         /// </summary>
         private static readonly ConcurrentDictionary<string, string> CacheItems = new ConcurrentDictionary<string, string>();
-        #endregion
 
-        #region Methods
         /// <summary>
         /// Adds an item to the cache.
         /// </summary>
@@ -105,7 +100,10 @@ namespace ImageProcessor.Web.Caching
         /// </returns>
         public static object GetItem(string key, string regionName = null)
         {
-            return Cache.Get(key, regionName);
+            lock (Cache)
+            {
+                return Cache.Get(key, regionName);
+            }
         }
 
         /// <summary>
@@ -131,7 +129,7 @@ namespace ImageProcessor.Web.Caching
         /// True if the update try succeeds, or false if there is an already an entry
         ///  in the cache with the same key as key.
         /// </returns>
-        public static bool UpdateItem(string key, object value, CacheItemPolicy policy = null, string regionName = null) 
+        public static bool UpdateItem(string key, object value, CacheItemPolicy policy = null, string regionName = null)
         {
             bool isUpDated = true;
 
@@ -237,6 +235,5 @@ namespace ImageProcessor.Web.Caching
 
             return isCleared;
         }
-        #endregion
     }
 }

src/ImageProcessor.Web/Configuration/ImageCacheSection.cs

@@ -103,6 +103,26 @@ namespace ImageProcessor.Web.Configuration
                 set { this["type"] = value; }
             }
 
+            /// <summary>
+            /// Gets or sets the maximum number of days to store an image in the cache.
+            /// </summary>
+            /// <value>The maximum number of days to store an image in the cache.</value>
+            /// <remarks>Defaults to 365 if not set.</remarks>
+            [ConfigurationProperty("maxDays", DefaultValue = "365", IsRequired = true)]
+            [IntegerValidator(ExcludeRange = false, MinValue = 0)]
+            public int MaxDays
+            {
+                get
+                {
+                    return (int)this["maxDays"];
+                }
+
+                set
+                {
+                    this["maxDays"] = value;
+                }
+            }
+
             /// <summary>
             /// Gets the <see cref="SettingElementCollection"/>.
             /// </summary>

src/ImageProcessor.Web/Configuration/ImageProcessingSection.cs

@@ -23,8 +23,6 @@ namespace ImageProcessor.Web.Configuration
     /// </summary>
     public sealed class ImageProcessingSection : ConfigurationSection
     {
-        #region Properties
-
         /// <summary>
         /// Gets or sets a value indicating whether to preserve exif meta data.
         /// </summary>
@@ -69,9 +67,7 @@ namespace ImageProcessor.Web.Configuration
         /// Gets or sets a value indicating whether to auto load plugins.
         /// </summary>
         public bool AutoLoadPlugins { get; set; }
-        #endregion
 
-        #region Methods
         /// <summary>
         /// Retrieves the processing configuration section from the current application configuration. 
         /// </summary>
@@ -95,8 +91,6 @@ namespace ImageProcessor.Web.Configuration
             return imageProcessingSection;
         }
 
-        #endregion
-
         /// <summary>
         /// Represents a PresetElement configuration element within the configuration.
         /// </summary>

src/ImageProcessor.Web/Configuration/ImageProcessorConfiguration.cs

@@ -60,7 +60,6 @@ namespace ImageProcessor.Web.Configuration
         #endregion
 
         #region Constructors
-
         /// <summary>
         /// Prevents a default instance of the <see cref="ImageProcessorConfiguration"/> class from being created.
         /// </summary>
@@ -99,6 +98,11 @@ namespace ImageProcessor.Web.Configuration
         /// </summary>
         public Type ImageCache { get; private set; }
 
+        /// <summary>
+        /// Gets the image cache max days.
+        /// </summary>
+        public int ImageCacheMaxDays { get; private set; }
+
         /// <summary>
         /// Gets the image cache settings.
         /// </summary>
@@ -435,6 +439,7 @@ namespace ImageProcessor.Web.Configuration
                         }
 
                         this.ImageCache = type;
+                        this.ImageCacheMaxDays = cache.MaxDays;
                         this.ImageCacheSettings = cache.Settings
                                                        .Cast<SettingElement>()
                                                        .ToDictionary(setting => setting.Key, setting => setting.Value);

src/ImageProcessor.Web/Configuration/Resources/cache.config.transform

@@ -1,8 +1,7 @@
 <caching currentCache="DiskCache">
   <caches>
-    <cache name="DiskCache" type="ImageProcessor.Web.Caching.DiskCache, ImageProcessor.Web">
+    <cache name="DiskCache" type="ImageProcessor.Web.Caching.DiskCache, ImageProcessor.Web" maxDays="365">
       <settings>
-        <setting key="MaxDays" value="365"/>
         <setting key="VirtualCachePath" value="~/app_data/cache"/>
       </settings>
     </cache>

src/ImageProcessor.Web/Helpers/RemoteFile.cs

@@ -10,7 +10,6 @@
 
 namespace ImageProcessor.Web.Helpers
 {
-    #region Using
     using System;
     using System.Collections.Generic;
     using System.Globalization;
@@ -18,7 +17,6 @@ namespace ImageProcessor.Web.Helpers
     using System.Security;
     using System.Threading.Tasks;
     using System.Web;
-    #endregion
 
     /// <summary>
     /// Encapsulates methods used to download files from a website address.

src/ImageProcessor.Web/HttpModules/ImageProcessingModule.cs

@@ -470,15 +470,15 @@ namespace ImageProcessor.Web.HttpModules
         /// </param>
         private void SetHeaders(HttpContext context, string responseType, IEnumerable<string> dependencyPaths)
         {
-            HttpResponse response = context.Response;
-
-            if (response.Headers["Image-Served-By"] == null)
-            {
-                response.AddHeader("Image-Served-By", "ImageProcessor.Web/" + AssemblyVersion);
-            }
-
             if (this.imageCache != null)
             {
+                HttpResponse response = context.Response;
+
+                if (response.Headers["ImageProcessedBy"] == null)
+                {
+                    response.AddHeader("ImageProcessedBy", "ImageProcessor.Web/" + AssemblyVersion);
+                }
+
                 HttpCachePolicy cache = response.Cache;
                 cache.SetCacheability(HttpCacheability.Public);
                 cache.VaryByHeaders["Accept-Encoding"] = true;
@@ -499,6 +499,8 @@ namespace ImageProcessor.Web.HttpModules
                 cache.SetExpires(DateTime.Now.ToUniversalTime().AddDays(maxDays));
                 cache.SetMaxAge(new TimeSpan(maxDays, 0, 0, 0));
                 cache.SetRevalidation(HttpCacheRevalidation.AllCaches);
+
+                this.imageCache = null;
             }
         }
 

src/TestWebsites/MVC/Views/Home/External.cshtml

@@ -5,15 +5,15 @@
 <section>
     <div class="row">
         <div class="col-s-6">
-            <img src="/remote.axd?http://images.mymovies.net/images/film/cin/500x377/fid11707.jpg?width=400" />
+            <img src="/remote.axd?http://images.mymovies.net/images/film/cin/500x377/fid11707.jpg?width=399" />
         </div>
         <div class="col-s-6">
-            <img src="/remote.axd?http://maps.googleapis.com/maps/api/staticmap?center=Albany,+NY&zoom=13&scale=false&size=800x500&maptype=roadmap&sensor=false&format=png&visual_refresh=true?width=400" />
+            <img src="/remote.axd?http://maps.googleapis.com/maps/api/staticmap?center=Albany,+NY&zoom=13&scale=false&size=800x500&maptype=roadmap&sensor=false&format=png&visual_refresh=true?width=401" />
         </div>
     </div>
     <div class="row">
         <div class="col-s-6">
-            <img src="/remote.axd?http://images.hanselminutes.com/images/255.jpg?width=200" />
+            <img src="/remote.axd?http://images.hanselminutes.com/images/255.jpg?width=201" />
         </div>
     </div>
 </section>

src/TestWebsites/MVC/config/imageprocessor/cache.config

@@ -1,11 +1,9 @@
 <caching currentCache="DiskCache">
   <caches>
-    <cache name="DiskCache" type="ImageProcessor.Web.Caching.DiskCache, ImageProcessor.Web">
+    <cache name="DiskCache" type="ImageProcessor.Web.Caching.DiskCache, ImageProcessor.Web" maxDays="365">
       <settings>
-        <setting key="MaxDays" value="56"/>
         <setting key="VirtualCachePath" value="~/app_data/cache"/>
       </settings>
     </cache>
   </caches>
 </caching>
-