path: root/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveUtils.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Text;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
using OpenSim.Services.Interfaces;

namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver
{
    /// <summary>
    /// Utility methods for inventory archiving
    /// </summary>
    public static class InventoryArchiveUtils
    {
//        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        // Character used for escaping the path delimter ("\/") and itself ("\\") in human escaped strings
        public static readonly char ESCAPE_CHARACTER = '\\';

        // The character used to separate inventory path components (different folders and items)
        public static readonly char PATH_DELIMITER = '/';

        /// <summary>
        /// Find a folder given a PATH_DELIMITER delimited path starting from a user's root folder
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimitors
        ///
        /// FIXME: We have no way of distinguishing folders with the same path
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        /// <param name="inventoryService">
        /// Inventory service to query
        /// </param>
        /// <param name="userId">
        /// User id to search
        /// </param>
        /// <param name="path">
        /// The path to the required folder.
        /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
        /// </param>
        /// <returns>The folder found.  Please note that if there are multiple folders with the same name then an
        /// unspecified one will be returned.  If no such folder eixsts then null is returned</returns>
        public static InventoryFolderBase FindFolderByPath(
            IInventoryService inventoryService, UUID userId, string path)
        {
            List<InventoryFolderBase> folders = FindFoldersByPath(inventoryService, userId, path);

            if (folders.Count == 0)
                return null;
            else
                return folders[0];
        }

        /// <summary>
        /// Find a folder given a PATH_DELIMITER delimited path starting from a given folder
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimitors
        ///
        /// FIXME: We have no way of distinguishing folders with the same path
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        /// <param name="inventoryService">
        /// Inventory service to query
        /// </param>
        /// <param name="startFolder">
        /// The folder from which the path starts
        /// </param>
        /// <param name="path">
        /// The path to the required folder.
        /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
        /// </param>
        /// <returns>The folder found.  Please note that if there are multiple folders with the same name then an
        /// unspecified one will be returned.  If no such folder eixsts then null is returned</returns>
        public static InventoryFolderBase FindFolderByPath(
            IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
        {
            if (null == startFolder)
                return null;

            List<InventoryFolderBase> folders = FindFoldersByPath(inventoryService, startFolder, path);

            if (folders.Count == 0)
                return null;
            else
                return folders[0];
        }

        /// <summary>
        /// Find a set of folders given a PATH_DELIMITER delimited path starting from a user's root folder
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimitors
        ///
        /// FIXME: We have no way of distinguishing folders with the same path
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        /// <param name="inventoryService">
        /// Inventory service to query
        /// </param>
        /// <param name="userId">
        /// User id to search
        /// </param>
        /// <param name="path">
        /// The path to the required folder.
        /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
        /// </param>
        /// <returns>An empty list if the folder is not found, otherwise a list of all folders that match the name</returns>
        public static List<InventoryFolderBase> FindFoldersByPath(
            IInventoryService inventoryService, UUID userId, string path)
        {
            InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);

            if (null == rootFolder)
                return new List<InventoryFolderBase>();

            return FindFoldersByPath(inventoryService, rootFolder, path);
        }

        /// <summary>
        /// Find a set of folders given a PATH_DELIMITER delimited path starting from this folder
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimitors
        ///
        /// FIXME: We have no way of distinguishing folders with the same path.
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        /// <param name="inventoryService">
        /// Inventory service to query
        /// </param>
        /// <param name="startFolder">
        /// The folder from which the path starts
        /// </param>
        /// <param name="path">
        /// The path to the required folder.
        /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned.
        /// </param>
        /// <returns>An empty list if the folder is not found, otherwise a list of all folders that match the name</returns>
        public static List<InventoryFolderBase> FindFoldersByPath(
            IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
        {
            List<InventoryFolderBase> foundFolders = new List<InventoryFolderBase>();

            if (path == string.Empty)
            {
                foundFolders.Add(startFolder);
                return foundFolders;
            }

            path = path.Trim();

            if (path == PATH_DELIMITER.ToString())
            {
                foundFolders.Add(startFolder);
                return foundFolders;
            }

            // If the path isn't just / then trim any starting extraneous slashes
            path = path.TrimStart(new char[] { PATH_DELIMITER });

//            m_log.DebugFormat("[INVENTORY ARCHIVE UTILS]: Adjusted path in FindFolderByPath() is [{0}]", path);

            string[] components = SplitEscapedPath(path);
            components[0] = UnescapePath(components[0]);

            //string[] components = path.Split(new string[] { PATH_DELIMITER.ToString() }, 2, StringSplitOptions.None);

            InventoryCollection contents = inventoryService.GetFolderContent(startFolder.Owner, startFolder.ID);

//            m_log.DebugFormat(
//                "Found {0} folders in {1} for {2}", contents.Folders.Count, startFolder.Name, startFolder.Owner);

            foreach (InventoryFolderBase folder in contents.Folders)
            {
                if (folder.Name == components[0])
                {
                    if (components.Length > 1)
                        foundFolders.AddRange(FindFoldersByPath(inventoryService, folder, components[1]));
                    else
                        foundFolders.Add(folder);
                }
            }

            return foundFolders;
        }

        /// <summary>
        /// Find an item given a PATH_DELIMITOR delimited path starting from the user's root folder.
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimitors
        ///
        /// FIXME: We do not yet handle situations where folders or items have the same name.  We could handle this by some
        /// XPath like expression
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        ///
        /// <param name="inventoryService">
        /// Inventory service to query
        /// </param>
        /// <param name="userId">
        /// The user to search
        /// </param>
        /// <param name="path">
        /// The path to the required item.
        /// </param>
        /// <returns>null if the item is not found</returns>
        public static InventoryItemBase FindItemByPath(
            IInventoryService inventoryService, UUID userId, string path)
        {
            InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);

            if (null == rootFolder)
                return null;

            return FindItemByPath(inventoryService, rootFolder, path);
        }

        /// <summary>
        /// Find an item given a PATH_DELIMITOR delimited path starting from this folder.
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimiters
        ///
        /// FIXME: We do not yet handle situations where folders or items have the same name.  We could handle this by some
        /// XPath like expression
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        ///
        /// <param name="inventoryService">Inventory service to query</param>
        /// <param name="startFolder">The folder from which the path starts</param>
        /// <param name="path">The path to the required item.</param>
        /// <returns>null if the item is not found</returns>
        public static InventoryItemBase FindItemByPath(
            IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
        {
            List<InventoryItemBase> foundItems = FindItemsByPath(inventoryService, startFolder, path);

            if (foundItems.Count != 0)
                return foundItems[0];
            else
                return null;
        }

        public static List<InventoryItemBase> FindItemsByPath(
            IInventoryService inventoryService, UUID userId, string path)
        {
            InventoryFolderBase rootFolder = inventoryService.GetRootFolder(userId);

            if (null == rootFolder)
                return new List<InventoryItemBase>();

            return FindItemsByPath(inventoryService, rootFolder, path);
        }

        /// <summary>
        /// Find items that match a given PATH_DELIMITOR delimited path starting from this folder.
        /// </summary>
        /// <remarks>
        /// This method does not handle paths that contain multiple delimiters
        ///
        /// FIXME: We do not yet handle situations where folders or items have the same name.  We could handle this by some
        /// XPath like expression
        ///
        /// FIXME: Delimitors which occur in names themselves are not currently escapable.
        /// </remarks>
        ///
        /// <param name="inventoryService">Inventory service to query</param>
        /// <param name="startFolder">The folder from which the path starts</param>
        /// <param name="path">The path to the required item.</param>
        /// <returns>The items that were found with this path.  An empty list if no items were found.</returns>
        public static List<InventoryItemBase> FindItemsByPath(
            IInventoryService inventoryService, InventoryFolderBase startFolder, string path)
        {
            List<InventoryItemBase> foundItems = new List<InventoryItemBase>();

            // If the path isn't just / then trim any starting extraneous slashes
            path = path.TrimStart(new char[] { PATH_DELIMITER });

            string[] components = SplitEscapedPath(path);
            components[0] = UnescapePath(components[0]);

            //string[] components = path.Split(new string[] { PATH_DELIMITER }, 2, StringSplitOptions.None);

            if (components.Length == 1)
            {
//                m_log.DebugFormat(
//                    "FOUND SINGLE COMPONENT [{0}].  Looking for this in [{1}] {2}",
//                    components[0], startFolder.Name, startFolder.ID);

                List<InventoryItemBase> items = inventoryService.GetFolderItems(startFolder.Owner, startFolder.ID);

//                m_log.DebugFormat("[INVENTORY ARCHIVE UTILS]: Found {0} items in FindItemByPath()", items.Count);

                foreach (InventoryItemBase item in items)
                {
//                    m_log.DebugFormat("[INVENTORY ARCHIVE UTILS]: Inspecting item {0} {1}", item.Name, item.ID);

                    if (item.Name == components[0])
                        foundItems.Add(item);
                }
            }
            else
            {
//                m_log.DebugFormat("FOUND COMPONENTS [{0}] and [{1}]", components[0], components[1]);

                InventoryCollection contents = inventoryService.GetFolderContent(startFolder.Owner, startFolder.ID);

                foreach (InventoryFolderBase folder in contents.Folders)
                {
                    if (folder.Name == components[0])
                        foundItems.AddRange(FindItemsByPath(inventoryService, folder, components[1]));
                }
            }

            return foundItems;
        }

        /// <summary>
        /// Split a human escaped path into two components if it contains an unescaped path delimiter, or one component
        /// if no delimiter is present
        /// </summary>
        /// <param name="path"></param>
        /// <returns>
        /// The split path.  We leave the components in their originally unescaped state (though we remove the delimiter
        /// which originally split them if applicable).
        /// </returns>
        public static string[] SplitEscapedPath(string path)
        {
//            m_log.DebugFormat("SPLITTING PATH {0}", path);

            bool singleEscapeChar = false;

            for (int i = 0; i < path.Length; i++)
            {
                if (path[i] == ESCAPE_CHARACTER && !singleEscapeChar)
                {
                    singleEscapeChar = true;
                }
                else
                {
                    if (PATH_DELIMITER == path[i] && !singleEscapeChar)
                        return new string[2] { path.Remove(i), path.Substring(i + 1) };
                    else
                        singleEscapeChar = false;
                }
            }

            // We didn't find a delimiter
            return new string[1] { path };
        }

        /// <summary>
        /// Unescapes a human escaped path.  This means that "\\" goes to "\", and "\/" goes to "/"
        /// </summary>
        /// <param name="path"></param>
        /// <returns></returns>
        public static string UnescapePath(string path)
        {
//            m_log.DebugFormat("ESCAPING PATH {0}", path);

            StringBuilder sb = new StringBuilder();

            bool singleEscapeChar = false;
            for (int i = 0; i < path.Length; i++)
            {
                if (path[i] == ESCAPE_CHARACTER && !singleEscapeChar)
                    singleEscapeChar = true;
                else
                    singleEscapeChar = false;

                if (singleEscapeChar)
                {
                    if (PATH_DELIMITER == path[i])
                        sb.Append(PATH_DELIMITER);
                }
                else
                {
                    sb.Append(path[i]);
                }
            }

//            m_log.DebugFormat("ESCAPED PATH TO {0}", sb);

            return sb.ToString();
        }

        /// <summary>
        /// Escape an archive path.
        /// </summary>
        /// This has to be done differently from human paths because we can't leave in any "/" characters (due to
        /// problems if the archive is built from or extracted to a filesystem
        /// <param name="path"></param>
        /// <returns></returns>
        public static string EscapeArchivePath(string path)
        {
            // Only encode ampersands (for escaping anything) and / (since this is used as general dir separator).
            return path.Replace("&", "&amp;").Replace("/", "&#47;");
        }

        /// <summary>
        /// Unescape an archive path.
        /// </summary>
        /// <param name="path"></param>
        /// <returns></returns>
        public static string UnescapeArchivePath(string path)
        {
            return path.Replace("&#47;", "/").Replace("&amp;", "&");
        }
    }
}