Programmatically remove illegal SharePoint characters from file names and directories.



I have often found the need to remove illegal chars from several hundred files, so they could be transferred form a file share to a SharePoint document library.  This is a quick winform that does just that.


using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.IO;

namespace SharePointCleanV2
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button_Clean_Click(object sender, EventArgs e)
        {
            string rootpath = textBox_path.Text;

            DirectoryInfo root = new DirectoryInfo(rootpath);
            CleanFilesDirectoryTree(root);

            CleanDirectoryTree(root);
            CleanTempFilesDirectoryTree(root);
        }

        private void CleanTempFilesDirectoryTree(System.IO.DirectoryInfo root)
        {
            System.IO.FileInfo[] files = null;
            System.IO.DirectoryInfo[] subDirs = null;

            // First, process all the files directly under this folder
            try
            {
                files = root.GetFiles("*.*");
            }
            // This is thrown if even one of the files requires permissions greater
            // than the application provides.
            catch (UnauthorizedAccessException e)
            {

            }

            catch (System.IO.DirectoryNotFoundException e)
            {
                Console.WriteLine(e.Message);
            }

            if (files != null)
            {
                foreach (System.IO.FileInfo fi in files)
                {
                    string [] EXT = fi.Name.Split('.');
                    if (EXT[1] == "tmp")
                    {
                        string Path = fi.FullName;
                        fi.Delete();
                    }

                }


                // Now find all the subdirectories under this directory.
                subDirs = root.GetDirectories();

                foreach (System.IO.DirectoryInfo dirInfo in subDirs)
                {
                    // Resursive call for each subdirectory.
                    CleanTempFilesDirectoryTree(dirInfo);
                }
            }
        }


        private void CleanFilesDirectoryTree(System.IO.DirectoryInfo root)
        {
            System.IO.FileInfo[] files = null;
            System.IO.DirectoryInfo[] subDirs = null;

            // First, process all the files directly under this folder
            try
            {
                files = root.GetFiles("*.*");
            }
            // This is thrown if even one of the files requires permissions greater
            // than the application provides.
            catch (UnauthorizedAccessException e)
            {
                // This code just writes out the message and continues to recurse.
                // You may decide to do something different here. For example, you
                // can try to elevate your privileges and access the file again.
                // log.Add(e.Message);
            }

            catch (System.IO.DirectoryNotFoundException e)
            {
                Console.WriteLine(e.Message);
            }

            if (files != null)
            {
                foreach (System.IO.FileInfo fi in files)
                {
                    if(IsNameDirty(fi.Name))
                    {
                        string OldName = fi.Name;
                        string NewName = CleanName(OldName);
                        string ParentFolder = fi.DirectoryName;
                        string FullNewName = ParentFolder + "\\" + NewName;
                        fi.MoveTo(FullNewName);
                    }
                }


                // Now find all the subdirectories under this directory.
                subDirs = root.GetDirectories();

                foreach (System.IO.DirectoryInfo dirInfo in subDirs)
                {
                    // Resursive call for each subdirectory.
                    CleanFilesDirectoryTree(dirInfo);
                }
            }
        }

        private void CleanDirectoryTree(System.IO.DirectoryInfo root)
        {
            System.IO.FileInfo[] files = null;
            System.IO.DirectoryInfo[] subDirs = null;

            // First, process all the files directly under this folder
            try
            {
                files = root.GetFiles("*.*");
            }
            // This is thrown if even one of the files requires permissions greater
            // than the application provides.
            catch (UnauthorizedAccessException e)
            {
                // This code just writes out the message and continues to recurse.
                // You may decide to do something different here. For example, you
                // can try to elevate your privileges and access the file again.
                // log.Add(e.Message);
            }

            catch (System.IO.DirectoryNotFoundException e)
            {
                Console.WriteLine(e.Message);
            }
            // Now find all the subdirectories under this directory.
            subDirs = root.GetDirectories();

            foreach (System.IO.DirectoryInfo dirInfo in subDirs)
            {
                // Resursive call for each subdirectory.
               
                CleanDirectoryTree(dirInfo);
                if (IsNameDirty(dirInfo.Name))
                {
                    string OldName = dirInfo.Name;
                    string NewName = CleanName(OldName);
                    string ParentFolder = dirInfo.Parent.FullName;
                    string FullNewName = ParentFolder + "\\" + NewName;
                    dirInfo.MoveTo(FullNewName);
                }
            }
        }

        bool IsNameDirty(string name)
        {
            bool IsDirty = false;
            //~ # % & * { } \ : < > ? / + | " . _
            if (name.Contains('~')) return true;
            if (name.Contains('#')) return true;
            if (name.Contains('%')) return true;
            if (name.Contains('&')) return true;
            if (name.Contains('*')) return true;
            if (name.Contains('{')) return true;
            if (name.Contains('}')) return true;
            if (name.Contains(':')) return true;
            if (name.Contains('<')) return true;
            if (name.Contains('>')) return true;
            if (name.Contains('?')) return true;
            if (name.Contains('+')) return true;
            if (name.Contains('|')) return true;
            if (name.Contains('+')) return true;
            return IsDirty;
        }


        string CleanName(string name)
        {        
            //~ # % & * { } \ : < > ? / + | " . _
            string returnName = name.Replace('~', ' ');
            returnName = returnName.Replace("A&O", "A and O");
            returnName = returnName.Replace("&", " and ");
            returnName = returnName.Replace('%', ' ');
            returnName = returnName.Replace('*', ' ');
            returnName = returnName.Replace('{', ' ');
            returnName = returnName.Replace('}', ' ');
            returnName = returnName.Replace(':', ' ');
            returnName = returnName.Replace('<', ' ');
            returnName = returnName.Replace('>', ' ');
            returnName = returnName.Replace('?', ' ');
            returnName = returnName.Replace('+', ' ');
            returnName = returnName.Replace('|', ' ');
            return returnName;
        }
    }
}


 

Comments

Post a Comment

Popular posts from this blog

Metastorm - Open form in an action from a list or link

Below is the SQL underneath the custom list with the link to open an action.  If you are opening from outside of a Metastorm client, you may need to add the ‘SessionID’ parameter containing a valid session ID 9.  I haven’t tried this with the current 9.1 SSO, it may be unnecessary.   If the session id parameter is still necessary, usually we write a wrapper aspx page to authenticate to user, grab the session id and redirect them to the action. The syntax is http://<servername/Metastorm/eForm.aspx?Map=<process map name>&Action=<action name>&Folder=<folder name>&FolderID=<folderid>&Service=<BPM Service Name>&Client=External&FolderLaunchURL=&FolderCancelURL=&IsFolderAction=True SELECT eFolder . eFolderID , eFolder . eFolderName , eFolder . eStageName ,   eFolder . eUpdated , eFolder . eSubject , ITProjectInitiation . txtProjectName ,   CASE       WHEN LEN ( ITProjectInitiation . txtNextAction ) > 1          
Read more

Corporate Intranet Information Architecture – a Publishing Site

Image
There have been several occasions in my consulting career where I have discussed what a corporate intranet should look like.   There are several aspects to this question, branding, custom web parts or other bells and whistles, but I believe that the fundamental structure or information architecture is one of if not the most important aspect of a solid, useful corporate intranet. Clearly, each individual company will have a unique look and feel and information architecture.   This will depend on the underlying business as well as the relative size, geographical locations and languages of the company. However, I have noticed certain commonalities across companies and have started to develop a template of how I can help an organization visualize there corporate intranet.   This could be used as a target to reorganize an existing intranet or as a template to stand up a new one.   In either case, changes will have to be made to suit the individual company’s needs.   Most companie
Read more

No Search Results in SharePoint Contextual Search OSSSearchResults.aspx

This is another one for me so I never have to figure this out again.   All the other posts I found when looking into this talked about how to set up a search center and redirect people over there.   That is pretty well documented at this point, but the problem I had was that people were trying to search the local site, being direct to the out of the box _layouts/OSSSearchResults.aspx page and getting no results.   The fix was frustratingly simple, check your alternate access mappings.   If you have extended the web app and users are using the new AAM then that could be the reason that the OOTB search results are not working.   In my case I had the short name as the default, and the FQDN as the custom, I switched them and now everything works.
Read more