Merge pull request #11102 from umbraco/v9/bugfix/packagedatainstallation-macropartialviews

Use IFileService to save macro partial views in package migration

Author: bergmania

src/Umbraco.Core/Packaging/InstallationSummary.cs

@@ -13,16 +13,17 @@ namespace Umbraco.Cms.Core.Packaging
     public class InstallationSummary
     {
         public InstallationSummary(string packageName)
-        {
-            PackageName = packageName;
-        }
+            => PackageName = packageName;
+
+        public string PackageName { get; }
 
         public InstallWarnings Warnings { get; set; } = new InstallWarnings();
 
         public IEnumerable<IDataType> DataTypesInstalled { get; set; } = Enumerable.Empty<IDataType>();
         public IEnumerable<ILanguage> LanguagesInstalled { get; set; } = Enumerable.Empty<ILanguage>();
         public IEnumerable<IDictionaryItem> DictionaryItemsInstalled { get; set; } = Enumerable.Empty<IDictionaryItem>();
         public IEnumerable<IMacro> MacrosInstalled { get; set; } = Enumerable.Empty<IMacro>();
+        public IEnumerable<IPartialView> MacroPartialViewsInstalled { get; set; } = Enumerable.Empty<IPartialView>();
         public IEnumerable<ITemplate> TemplatesInstalled { get; set; } = Enumerable.Empty<ITemplate>();
         public IEnumerable<IContentType> DocumentTypesInstalled { get; set; } = Enumerable.Empty<IContentType>();
         public IEnumerable<IMediaType> MediaTypesInstalled { get; set; } = Enumerable.Empty<IMediaType>();
@@ -31,73 +32,55 @@ public InstallationSummary(string packageName)
         public IEnumerable<IPartialView> PartialViewsInstalled { get; set; } = Enumerable.Empty<IPartialView>();
         public IEnumerable<IContent> ContentInstalled { get; set; } = Enumerable.Empty<IContent>();
         public IEnumerable<IMedia> MediaInstalled { get; set; } = Enumerable.Empty<IMedia>();
-        public string PackageName { get; }
 
         public override string ToString()
         {
             var sb = new StringBuilder();
-            var macroConflicts = Warnings.ConflictingMacros.ToList();
-            if (macroConflicts.Count > 0)
-            {
-                sb.Append("Conflicting macros found, they will be overwritten:");
-                foreach(IMacro m in macroConflicts)
-                {
-                    sb.Append(m.Alias);
-                    sb.Append(',');
-                }
-                sb.AppendLine(". ");
-            }
-            var templateConflicts = Warnings.ConflictingTemplates.ToList();
-            if (templateConflicts.Count > 0)
+
+            void WriteConflicts<T>(IEnumerable<T> source, Func<T, string> selector, string message, bool appendLine = true)
             {
-                sb.Append("Conflicting templates found, they will be overwritten:");
-                foreach (ITemplate m in templateConflicts)
+                var result = source?.Select(selector).ToList();
+                if (result?.Count > 0)
                 {
-                    sb.Append(m.Alias);
-                    sb.Append(',');
+                    sb.Append(message);
+                    sb.Append(string.Join(", ", result));
+
+                    if (appendLine)
+                    {
+                        sb.AppendLine();
+                    }
                 }
-                sb.AppendLine(". ");
             }
-            var stylesheetConflicts = Warnings.ConflictingStylesheets.ToList();
-            if (stylesheetConflicts.Count > 0)
+
+            void WriteCount<T>(string message, IEnumerable<T> source, bool appendLine = true)
             {
-                sb.Append("Conflicting stylesheets found, they will be overwritten:");
-                foreach (IFile m in stylesheetConflicts)
+                sb.Append(message);
+                sb.Append(source?.Count() ?? 0);
+
+                if (appendLine)
                 {
-                    sb.Append(m.Alias);
-                    sb.Append(',');
+                    sb.AppendLine();
                 }
-                sb.AppendLine(". ");
             }
 
-            sb.Append("Content items installed: ");
-            sb.Append(ContentInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Media items installed: ");
-            sb.Append(MediaInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Dictionary items installed: ");
-            sb.Append(DictionaryItemsInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Macros installed: ");
-            sb.Append(MacrosInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Stylesheets installed: ");
-            sb.Append(StylesheetsInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Templates installed: ");
-            sb.Append(TemplatesInstalled.Count());
-            sb.AppendLine();
-            sb.Append("Document types installed: ");
-            sb.Append(DocumentTypesInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Media types installed: ");
-            sb.Append(MediaTypesInstalled.Count());
-            sb.AppendLine(". ");
-            sb.Append("Data types items installed: ");
-            sb.Append(DataTypesInstalled.Count());
+            WriteConflicts(Warnings?.ConflictingMacros, x => x.Alias, "Conflicting macros found, they will be overwritten: ");
+            WriteConflicts(Warnings?.ConflictingTemplates, x => x.Alias, "Conflicting templates found, they will be overwritten: ");
+            WriteConflicts(Warnings?.ConflictingStylesheets, x => x.Alias, "Conflicting stylesheets found, they will be overwritten: ");
+            WriteCount("Data types installed: ", DataTypesInstalled);
+            WriteCount("Languages installed: ", LanguagesInstalled);
+            WriteCount("Dictionary items installed: ", DictionaryItemsInstalled);
+            WriteCount("Macros installed: ", MacrosInstalled);
+            WriteCount("Macro partial views installed: ", MacroPartialViewsInstalled);
+            WriteCount("Templates installed: ", TemplatesInstalled);
+            WriteCount("Document types installed: ", DocumentTypesInstalled);
+            WriteCount("Media types installed: ", MediaTypesInstalled);
+            WriteCount("Stylesheets installed: ", StylesheetsInstalled);
+            WriteCount("Scripts installed: ", ScriptsInstalled);
+            WriteCount("Partial views installed: ", PartialViewsInstalled);
+            WriteCount("Content items installed: ", ContentInstalled);
+            WriteCount("Media items installed: ", MediaInstalled, false);
+
             return sb.ToString();
         }
     }
-
 }

src/Umbraco.Core/Packaging/PackageDefinition.cs

@@ -28,7 +28,7 @@ public class PackageDefinition
         public string Name { get; set; } = string.Empty;
 
         /// <summary>
-        /// The full path to the package's xml file
+        /// The full path to the package's XML file.
         /// </summary>
         [ReadOnly(true)]
         [DataMember(Name = "packagePath")]
@@ -71,12 +71,9 @@ public class PackageDefinition
         public IList<string> DataTypes { get; set; } = new List<string>();
 
         [DataMember(Name = "mediaUdis")]
-        public IList<GuidUdi> MediaUdis { get; set; } = Array.Empty<GuidUdi>();
+        public IList<GuidUdi> MediaUdis { get; set; } = new List<GuidUdi>();
 
         [DataMember(Name = "mediaLoadChildNodes")]
         public bool MediaLoadChildNodes { get; set; }
-
-
     }
-
 }

src/Umbraco.Core/Packaging/PackagesRepository.cs

@@ -415,9 +415,10 @@ private void PackageMacros(PackageDefinition definition, XContainer root)
 
             root.Add(macros);
 
-            // get the partial views for macros and package those
-            IEnumerable<string> views = packagedMacros.Select(x => x.MacroSource).Where(x => x.EndsWith(".cshtml"));
-            PackageMacroPartialViews(views, root);
+            // Get the partial views for macros and package those (exclude views outside of the default directory, e.g. App_Plugins\*\Views)
+            IEnumerable<string> views = packagedMacros.Where(x => x.MacroSource.StartsWith(Constants.SystemDirectories.MacroPartials))
+                .Select(x => x.MacroSource.Substring(Constants.SystemDirectories.MacroPartials.Length).Replace('/', '\\'));
+            PackageStaticFiles(views, root, "MacroPartialViews", "View", _fileSystems.MacroPartialsFileSystem);
         }
 
         private void PackageStylesheets(PackageDefinition definition, XContainer root)
@@ -488,33 +489,6 @@ private void PackageTemplates(PackageDefinition definition, XContainer root)
             root.Add(templatesXml);
         }
 
-        private void PackageMacroPartialViews(IEnumerable<string> viewPaths, XContainer root)
-        {
-            var viewsXml = new XElement("MacroPartialViews");
-            foreach (var viewPath in viewPaths)
-            {
-                // TODO: See TODO note in MacrosController about the inconsistencies of usages of partial views
-                // and how paths are saved. We have no choice currently but to assume that all views are 100% always
-                // on the content path.
-
-                var physicalPath = _hostingEnvironment.MapPathContentRoot(viewPath);
-                if (!File.Exists(physicalPath))
-                {
-                    throw new InvalidOperationException("Could not find partial view at path " + viewPath);
-                }
-
-                var fileContents = File.ReadAllText(physicalPath, Encoding.UTF8);
-
-                viewsXml.Add(
-                    new XElement(
-                        "View",
-                        new XAttribute("path", viewPath),
-                        new XCData(fileContents)));
-            }
-
-            root.Add(viewsXml);
-        }
-
         private void PackageDocumentTypes(PackageDefinition definition, XContainer root)
         {
             var contentTypes = new HashSet<IContentType>();