roadie/Roadie.Api.Library/Utility/PathSanitizer.cs

using System;
using System.Collections.Generic;
using System.Text;

namespace Roadie.Library.Utility
{
    /// <summary>
    /// Cleans paths of invalid characters.
    /// </summary>
    public static class PathSanitizer
    {
        /// <summary>
        /// The set of invalid filename characters, kept sorted for fast binary search
        /// </summary>
        private readonly static char[] invalidFilenameChars;

        /// <summary>
        /// The set of invalid path characters, kept sorted for fast binary search
        /// </summary>
        private readonly static char[] invalidPathChars;

        static PathSanitizer()
        {
            // set up the two arrays -- sorted once for speed.
            var c = new List<char>();
            c.AddRange(System.IO.Path.GetInvalidFileNameChars());

            // Some Roadie instances run in Linux to Windows SMB clients via Samba this helps with Windows clients and invalid characters in Windows
            var badWindowsFileAndFoldercharacters = new List<char> { '\\', '/', ':', '*', '?', '\'', '<', '>', '|', '*' };
            foreach (var badWindowsFilecharacter in badWindowsFileAndFoldercharacters)
            {
                if (!c.Contains(badWindowsFilecharacter))
                {
                    c.Add(badWindowsFilecharacter);
                }
            }
            invalidFilenameChars = c.ToArray();

            var f = new List<char>();
            f.AddRange(System.IO.Path.GetInvalidPathChars());
            foreach (var badWindowsFilecharacter in badWindowsFileAndFoldercharacters)
            {
                if (!f.Contains(badWindowsFilecharacter))
                {
                    f.Add(badWindowsFilecharacter);
                }
            }
            invalidFilenameChars = c.ToArray();
            invalidPathChars = f.ToArray();

            Array.Sort(invalidFilenameChars);
            Array.Sort(invalidPathChars);
        }

        /// <summary>
        /// Cleans a filename of invalid characters
        /// </summary>
        /// <param name="input">the string to clean</param>
        /// <param name="errorChar">the character which replaces bad characters</param>
        /// <returns></returns>
        public static string SanitizeFilename(string input, char errorChar)
        {
            return Sanitize(input, invalidFilenameChars, errorChar);
        }

        /// <summary>
        /// Cleans a path of invalid characters
        /// </summary>
        /// <param name="input">the string to clean</param>
        /// <param name="errorChar">the character which replaces bad characters</param>
        /// <returns></returns>
        public static string SanitizePath(string input, char errorChar)
        {
            return Sanitize(input, invalidPathChars, errorChar);
        }

        /// <summary>
        /// Cleans a string of invalid characters.
        /// </summary>
        /// <param name="input"></param>
        /// <param name="invalidChars"></param>
        /// <param name="errorChar"></param>
        /// <returns></returns>
        private static string Sanitize(string input, char[] invalidChars, char errorChar)
        {
            // null always sanitizes to null
            if (input == null) { return null; }
            StringBuilder result = new StringBuilder();
            foreach (var characterToTest in input)
            {
                // we binary search for the character in the invalid set. This should be lightning fast.
                if (Array.BinarySearch(invalidChars, characterToTest) >= 0)
                {
                    // we found the character in the array of
                    result.Append(errorChar);
                }
                else
                {
                    // the character was not found in invalid, so it is valid.
                    result.Append(characterToTest);
                }
            }

            // we're done.
            return result.ToString();
        }
    }
}