Umbraco-CMS/src/Umbraco.Core/UdiRange.cs

using System;

namespace Umbraco.Cms.Core
{
    /// <summary>
    /// Represents a <see cref="Core.Udi"/> range.
    /// </summary>
    /// <remarks>
    /// <remarks>A Udi range is composed of a <see cref="Core.Udi"/> which represents the base of the range,
    /// plus a selector that can be "." (the Udi), ".*" (the Udi and its children), ".**" (the udi and
    /// its descendants, "*" (the children of the Udi), and "**" (the descendants of the Udi).</remarks>
    /// <remarks>The Udi here can be a closed entity, or an open entity.</remarks></remarks>
    public class UdiRange
    {
        private readonly Uri _uriValue;

        /// <summary>
        /// Initializes a new instance of the <see cref="UdiRange"/> class with a <see cref="Core.Udi"/> and an optional selector.
        /// </summary>
        /// <param name="udi">A <see cref="Udi"/>.</param>
        /// <param name="selector">An optional selector.</param>
        public UdiRange(Udi udi, string selector = Constants.DeploySelector.This)
        {
            Udi = udi;
            switch (selector)
            {
                case Constants.DeploySelector.This:
                    Selector = selector;
                    _uriValue = udi.UriValue;
                    break;
                case Constants.DeploySelector.ChildrenOfThis:
                case Constants.DeploySelector.DescendantsOfThis:
                case Constants.DeploySelector.ThisAndChildren:
                case Constants.DeploySelector.ThisAndDescendants:
                    Selector = selector;
                    _uriValue = new Uri(Udi + "?" + selector);
                    break;
                default:
                    throw new ArgumentException(string.Format("Invalid selector \"{0}\".", selector));
            }
        }

        /// <summary>
        /// Gets the <see cref="Udi"/> for this range.
        /// </summary>
        public Udi Udi { get; private set; }

        /// <summary>
        /// Gets or sets the selector for this range.
        /// </summary>
        public string Selector { get; private set; }

        /// <summary>
        /// Gets the entity type of the <see cref="Core.Udi"/> for this range.
        /// </summary>
        public string EntityType
        {
            get { return Udi.EntityType; }
        }

        public static UdiRange Parse(string s)
        {
            Uri uri;

            if (Uri.IsWellFormedUriString(s, UriKind.Absolute) == false
                || Uri.TryCreate(s, UriKind.Absolute, out uri) == false)
            {
                //if (tryParse) return false;
                throw new FormatException(string.Format("String \"{0}\" is not a valid udi range.", s));
            }

            var udiUri = uri.Query == string.Empty ? uri : new UriBuilder(uri) { Query = string.Empty }.Uri;
            return new UdiRange(Udi.Create(udiUri), uri.Query.TrimStart(Constants.CharArrays.QuestionMark));
        }

        public override string ToString()
        {
            return _uriValue.ToString();
        }

        public override bool Equals(object obj)
        {
            var other = obj as UdiRange;
            return other != null && GetType() == other.GetType() && _uriValue == other._uriValue;
        }

        public override int GetHashCode()
        {
            return _uriValue.GetHashCode();
        }

        public static bool operator ==(UdiRange range1, UdiRange range2)
        {
            if (ReferenceEquals(range1, range2)) return true;
            if ((object)range1 == null || (object)range2 == null) return false;
            return range1.Equals(range2);
        }

        public static bool operator !=(UdiRange range1, UdiRange range2)
        {
            return !(range1 == range2);
        }
    }
}