Umbraco-CMS/src/Umbraco.ModelsBuilder.Embedded/Building/Builder.cs

using System;
using System.Collections.Generic;
using System.Linq;
using Umbraco.Core;
using Umbraco.Core.Configuration;
using Umbraco.Core.Configuration.Models;

namespace Umbraco.ModelsBuilder.Embedded.Building
{
    // NOTE
    // The idea was to have different types of builder, because I wanted to experiment with
    // building code with CodeDom. Turns out more complicated than I thought and maybe not
    // worth it at the moment, to we're using TextBuilder and its Generate method is specific.
    //
    // Keeping the code as-is for the time being...

    /// <summary>
    /// Provides a base class for all builders.
    /// </summary>
    internal abstract class Builder
    {



        private readonly IList<TypeModel> _typeModels;

        protected Dictionary<string, string> ModelsMap { get; } = new Dictionary<string, string>();

        // the list of assemblies that will be 'using' by default
        protected readonly IList<string> TypesUsing = new List<string>
        {
            "System",
            "System.Collections.Generic",
            "System.Linq.Expressions",
            "System.Web",
            "Umbraco.Core.Models",
            "Umbraco.Core.Models.PublishedContent",
            "Umbraco.Web",
            "Umbraco.ModelsBuilder.Embedded"
        };

        /// <summary>
        /// Gets or sets a value indicating the namespace to use for the models.
        /// </summary>
        /// <remarks>May be overriden by code attributes.</remarks>
        public string ModelsNamespace { get; set; }

        /// <summary>
        /// Gets the list of assemblies to add to the set of 'using' assemblies in each model file.
        /// </summary>
        public IList<string> Using => TypesUsing;

        /// <summary>
        /// Gets the list of models to generate.
        /// </summary>
        /// <returns>The models to generate</returns>
        public IEnumerable<TypeModel> GetModelsToGenerate()
        {
            return _typeModels;
        }

        /// <summary>
        /// Gets the list of all models.
        /// </summary>
        /// <remarks>Includes those that are ignored.</remarks>
        internal IList<TypeModel> TypeModels => _typeModels;

        /// <summary>
        /// Initializes a new instance of the <see cref="Builder"/> class with a list of models to generate,
        /// the result of code parsing, and a models namespace.
        /// </summary>
        /// <param name="typeModels">The list of models to generate.</param>
        /// <param name="modelsNamespace">The models namespace.</param>
        protected Builder(ModelsBuilderConfig config, IList<TypeModel> typeModels)
        {
            _typeModels = typeModels ?? throw new ArgumentNullException(nameof(typeModels));

            Config = config ?? throw new ArgumentNullException(nameof(config));

            // can be null or empty, we'll manage
            ModelsNamespace = Config.ModelsNamespace;

            // but we want it to prepare
            Prepare();
        }

        // for unit tests only
        protected Builder()
        { }

        protected ModelsBuilderConfig Config { get; }

        /// <summary>
        /// Prepares generation by processing the result of code parsing.
        /// </summary>
        private void Prepare()
        {
            TypeModel.MapModelTypes(_typeModels, ModelsNamespace);

            var pureLive = Config.ModelsMode == ModelsMode.PureLive;

            // for the first two of these two tests,
            //  always throw, even in purelive: cannot happen unless ppl start fidling with attributes to rename
            //  things, and then they should pay attention to the generation error log - there's no magic here
            // for the last one, don't throw in purelive, see comment

            // ensure we have no duplicates type names
            foreach (var xx in _typeModels.GroupBy(x => x.ClrName).Where(x => x.Count() > 1))
                throw new InvalidOperationException($"Type name \"{xx.Key}\" is used"
                    + $" for types with alias {string.Join(", ", xx.Select(x => x.ItemType + ":\"" + x.Alias + "\""))}. Names have to be unique."
                    + " Consider using an attribute to assign different names to conflicting types.");

            // ensure we have no duplicates property names
            foreach (var typeModel in _typeModels)
                foreach (var xx in typeModel.Properties.GroupBy(x => x.ClrName).Where(x => x.Count() > 1))
                    throw new InvalidOperationException($"Property name \"{xx.Key}\" in type {typeModel.ItemType}:\"{typeModel.Alias}\""
                        + $" is used for properties with alias {string.Join(", ", xx.Select(x => "\"" + x.Alias + "\""))}. Names have to be unique."
                        + " Consider using an attribute to assign different names to conflicting properties.");

            // ensure content & property type don't have identical name (csharp hates it)
            foreach (var typeModel in _typeModels)
            {
                foreach (var xx in typeModel.Properties.Where(x => x.ClrName == typeModel.ClrName))
                {
                    if (!pureLive)
                        throw new InvalidOperationException($"The model class for content type with alias \"{typeModel.Alias}\" is named \"{xx.ClrName}\"."
                            + $" CSharp does not support using the same name for the property with alias \"{xx.Alias}\"."
                            + " Consider using an attribute to assign a different name to the property.");

                    // for purelive, will we generate a commented out properties with an error message,
                    // instead of throwing, because then it kills the sites and ppl don't understand why
                    xx.AddError($"The class {typeModel.ClrName} cannot implement this property, because"
                        + $" CSharp does not support naming the property with alias \"{xx.Alias}\" with the same name as content type with alias \"{typeModel.Alias}\"."
                        + " Consider using an attribute to assign a different name to the property.");

                    // will not be implemented on interface nor class
                    // note: we will still create the static getter, and implement the property on other classes...
                }
            }

            // ensure we have no collision between base types
            // NO: we may want to define a base class in a partial, on a model that has a parent
            // we are NOT checking that the defined base type does maintain the inheritance chain
            //foreach (var xx in _typeModels.Where(x => !x.IsContentIgnored).Where(x => x.BaseType != null && x.HasBase))
            //    throw new InvalidOperationException(string.Format("Type alias \"{0}\" has more than one parent class.",
            //        xx.Alias));

            // discover interfaces that need to be declared / implemented
            foreach (var typeModel in _typeModels)
            {
                // collect all the (non-removed) types implemented at parent level
                // ie the parent content types and the mixins content types, recursively
                var parentImplems = new List<TypeModel>();
                if (typeModel.BaseType != null)
                    TypeModel.CollectImplems(parentImplems, typeModel.BaseType);

                // interfaces we must declare we implement (initially empty)
                // ie this type's mixins, except those that have been removed,
                // and except those that are already declared at the parent level
                // in other words, DeclaringInterfaces is "local mixins"
                var declaring = typeModel.MixinTypes
                    .Except(parentImplems);
                typeModel.DeclaringInterfaces.AddRange(declaring);

                // interfaces we must actually implement (initially empty)
                // if we declare we implement a mixin interface, we must actually implement
                // its properties, all recursively (ie if the mixin interface implements...)
                // so, starting with local mixins, we collect all the (non-removed) types above them
                var mixinImplems = new List<TypeModel>();
                foreach (var i in typeModel.DeclaringInterfaces)
                    TypeModel.CollectImplems(mixinImplems, i);
                // and then we remove from that list anything that is already declared at the parent level
                typeModel.ImplementingInterfaces.AddRange(mixinImplems.Except(parentImplems));
            }

            // ensure elements don't inherit from non-elements
            foreach (var typeModel in _typeModels.Where(x => x.IsElement))
            {
                if (typeModel.BaseType != null && !typeModel.BaseType.IsElement)
                    throw new InvalidOperationException($"Cannot generate model for type '{typeModel.Alias}' because it is an element type, but its parent type '{typeModel.BaseType.Alias}' is not.");

                var errs = typeModel.MixinTypes.Where(x => !x.IsElement).ToList();
                if (errs.Count > 0)
                    throw new InvalidOperationException($"Cannot generate model for type '{typeModel.Alias}' because it is an element type, but it is composed of {string.Join(", ", errs.Select(x => "'" + x.Alias + "'"))} which {(errs.Count == 1 ? "is" : "are")} not.");
            }
        }

        // looking for a simple symbol eg 'Umbraco' or 'String'
        // expecting to match eg 'Umbraco' or 'System.String'
        // returns true if either
        // - more than 1 symbol is found (explicitely ambiguous)
        // - 1 symbol is found BUT not matching (implicitely ambiguous)
        protected bool IsAmbiguousSymbol(string symbol, string match)
        {
            // cannot figure out is a symbol is ambiguous without Roslyn
            // so... let's say everything is ambiguous - code won't be
            // pretty but it'll work

            // Essentially this means that a `global::` syntax will be output for the generated models
            return true;
        }

        internal string ModelsNamespaceForTests;

        public string GetModelsNamespace()
        {
            if (ModelsNamespaceForTests != null)
                return ModelsNamespaceForTests;

            // if builder was initialized with a namespace, use that one
            if (!string.IsNullOrWhiteSpace(ModelsNamespace))
                return ModelsNamespace;

            // use configured else fallback to default
            return string.IsNullOrWhiteSpace(Config.ModelsNamespace)
                ? Constants.ModelsBuilder.DefaultModelsNamespace
                : Config.ModelsNamespace;
        }

        protected string GetModelsBaseClassName(TypeModel type)
        {
            // default
            return type.IsElement ? "PublishedElementModel" : "PublishedContentModel";
        }
    }
}