Files
Umbraco-CMS/src/Umbraco.Infrastructure/Persistence/Repositories/Implement/CreatedPackageSchemaRepository.cs
Mole 13f2d52576 V14: Fix package creation (#16309)
* Fix documents and document types

* Fix remaining parts
2024-05-17 12:30:26 +02:00

836 lines
28 KiB
C#

using System.ComponentModel.DataAnnotations;
using System.IO.Compression;
using System.Xml.Linq;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using NPoco;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.DependencyInjection;
using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Packaging;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Infrastructure.Persistence.Dtos;
using Umbraco.Cms.Infrastructure.Scoping;
using Umbraco.Extensions;
using File = System.IO.File;
namespace Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement;
/// <inheritdoc />
public class CreatedPackageSchemaRepository : ICreatedPackagesRepository
{
private readonly IContentService _contentService;
private readonly IContentTypeService _contentTypeService;
private readonly IScopeAccessor _scopeAccessor;
private readonly ITemplateService _templateService;
private readonly IDictionaryItemService _dictionaryItemService;
private readonly ILanguageService _languageService;
private readonly string _createdPackagesFolderPath;
private readonly IDataTypeService _dataTypeService;
private readonly IFileService _fileService;
private readonly FileSystems _fileSystems;
private readonly IHostingEnvironment _hostingEnvironment;
private readonly MediaFileManager _mediaFileManager;
private readonly IMediaService _mediaService;
private readonly IMediaTypeService _mediaTypeService;
private readonly IEntityXmlSerializer _serializer;
private readonly string _tempFolderPath;
private readonly PackageDefinitionXmlParser _xmlParser;
/// <summary>
/// Initializes a new instance of the <see cref="CreatedPackageSchemaRepository" /> class.
/// </summary>
public CreatedPackageSchemaRepository(
IHostingEnvironment hostingEnvironment,
FileSystems fileSystems,
IEntityXmlSerializer serializer,
IDataTypeService dataTypeService,
IFileService fileService,
IMediaService mediaService,
IMediaTypeService mediaTypeService,
IContentService contentService,
MediaFileManager mediaFileManager,
IContentTypeService contentTypeService,
IScopeAccessor scopeAccessor,
ITemplateService templateService,
IDictionaryItemService dictionaryItemService,
ILanguageService languageService,
string? mediaFolderPath = null,
string? tempFolderPath = null)
{
_hostingEnvironment = hostingEnvironment;
_fileSystems = fileSystems;
_serializer = serializer;
_dataTypeService = dataTypeService;
_fileService = fileService;
_mediaService = mediaService;
_mediaTypeService = mediaTypeService;
_contentService = contentService;
_mediaFileManager = mediaFileManager;
_contentTypeService = contentTypeService;
_scopeAccessor = scopeAccessor;
_templateService = templateService;
_dictionaryItemService = dictionaryItemService;
_languageService = languageService;
_xmlParser = new PackageDefinitionXmlParser();
_createdPackagesFolderPath = mediaFolderPath ?? Constants.SystemDirectories.CreatedPackages;
_tempFolderPath = tempFolderPath ?? Constants.SystemDirectories.TempData + "/PackageFiles";
}
[Obsolete("use ctor with all dependencies instead")]
public CreatedPackageSchemaRepository(
IUmbracoDatabaseFactory umbracoDatabaseFactory,
IHostingEnvironment hostingEnvironment,
IOptions<GlobalSettings> globalSettings,
FileSystems fileSystems,
IEntityXmlSerializer serializer,
IDataTypeService dataTypeService,
ILocalizationService localizationService,
IFileService fileService,
IMediaService mediaService,
IMediaTypeService mediaTypeService,
IContentService contentService,
MediaFileManager mediaFileManager,
IContentTypeService contentTypeService,
IScopeAccessor scopeAccessor,
string? mediaFolderPath = null,
string? tempFolderPath = null)
: this(
hostingEnvironment,
fileSystems,
serializer,
dataTypeService,
fileService,
mediaService,
mediaTypeService,
contentService,
mediaFileManager,
contentTypeService,
scopeAccessor,
StaticServiceProvider.Instance.GetRequiredService<ITemplateService>(),
StaticServiceProvider.Instance.GetRequiredService<IDictionaryItemService>(),
StaticServiceProvider.Instance.GetRequiredService<ILanguageService>(),
mediaFolderPath,
tempFolderPath)
{
}
[Obsolete("use ctor with all dependencies instead")]
public CreatedPackageSchemaRepository(
IUmbracoDatabaseFactory umbracoDatabaseFactory,
IHostingEnvironment hostingEnvironment,
IOptions<GlobalSettings> globalSettings,
FileSystems fileSystems,
IEntityXmlSerializer serializer,
IDataTypeService dataTypeService,
ILocalizationService localizationService,
IFileService fileService,
IMediaService mediaService,
IMediaTypeService mediaTypeService,
IContentService contentService,
MediaFileManager mediaFileManager,
IContentTypeService contentTypeService,
string? mediaFolderPath = null,
string? tempFolderPath = null)
: this(
umbracoDatabaseFactory,
hostingEnvironment,
globalSettings,
fileSystems,
serializer,
dataTypeService,
localizationService,
fileService,
mediaService,
mediaTypeService,
contentService,
mediaFileManager,
contentTypeService,
StaticServiceProvider.Instance.GetRequiredService<IScopeAccessor>(),
mediaFolderPath,
tempFolderPath)
{
}
private IUmbracoDatabase Database => _scopeAccessor.AmbientScope?.Database ?? throw new InvalidOperationException("A scope is required to query the database");
public IEnumerable<PackageDefinition> GetAll()
{
Sql<ISqlContext> query = new Sql<ISqlContext>(Database.SqlContext)
.Select<CreatedPackageSchemaDto>()
.From<CreatedPackageSchemaDto>()
.OrderBy<CreatedPackageSchemaDto>(x => x.Id);
var packageDefinitions = new List<PackageDefinition>();
List<CreatedPackageSchemaDto> xmlSchemas = Database.Fetch<CreatedPackageSchemaDto>(query);
foreach (CreatedPackageSchemaDto packageSchema in xmlSchemas)
{
PackageDefinition? packageDefinition = CreatePackageDefinitionFromSchema(packageSchema);
if (packageDefinition is not null)
{
packageDefinitions.Add(packageDefinition);
}
}
return packageDefinitions;
}
public PackageDefinition? GetById(int id)
{
Sql<ISqlContext> query = new Sql<ISqlContext>(Database.SqlContext)
.Select<CreatedPackageSchemaDto>()
.From<CreatedPackageSchemaDto>()
.Where<CreatedPackageSchemaDto>(x => x.Id == id);
List<CreatedPackageSchemaDto> schemaDtos = Database.Fetch<CreatedPackageSchemaDto>(query);
if (schemaDtos.IsCollectionEmpty())
{
return null;
}
return CreatePackageDefinitionFromSchema(schemaDtos.First());
}
public PackageDefinition? GetByKey(Guid key)
{
Sql<ISqlContext> query = new Sql<ISqlContext>(Database.SqlContext)
.Select<CreatedPackageSchemaDto>()
.From<CreatedPackageSchemaDto>()
.Where<CreatedPackageSchemaDto>(x => x.PackageId == key);
if (_scopeAccessor.AmbientScope is null)
{
return null;
}
List<CreatedPackageSchemaDto> schemaDtos = _scopeAccessor.AmbientScope.Database.Fetch<CreatedPackageSchemaDto>(query);
if (schemaDtos.IsCollectionEmpty())
{
return null;
}
return CreatePackageDefinitionFromSchema(schemaDtos.First());
}
public void Delete(int id)
{
// Delete package snapshot
PackageDefinition? packageDef = GetById(id);
if (File.Exists(packageDef?.PackagePath))
{
File.Delete(packageDef.PackagePath);
}
Sql<ISqlContext> query = new Sql<ISqlContext>(Database.SqlContext)
.Delete<CreatedPackageSchemaDto>()
.Where<CreatedPackageSchemaDto>(x => x.Id == id);
Database.Execute(query);
}
public bool SavePackage(PackageDefinition? definition)
{
if (definition == null)
{
throw new NullReferenceException("PackageDefinition cannot be null when saving");
}
if (string.IsNullOrEmpty(definition.Name))
{
return false;
}
// Ensure it's valid
ValidatePackage(definition);
if (definition.Id == default)
{
Sql<ISqlContext> query = new Sql<ISqlContext>(Database.SqlContext)
.SelectCount()
.From<CreatedPackageSchemaDto>()
.Where<CreatedPackageSchemaDto>(x => x.Name == definition.Name);
if (_scopeAccessor.AmbientScope is null)
{
return false;
}
var exists = _scopeAccessor.AmbientScope.Database.ExecuteScalar<int>(query);
if (exists > 0)
{
return false;
}
// Create dto from definition
var dto = new CreatedPackageSchemaDto
{
Name = definition.Name,
Value = _xmlParser.ToXml(definition).ToString(),
UpdateDate = DateTime.Now,
PackageId = Guid.NewGuid(),
};
// Set the ids, we have to save in database first to get the Id
Database!.Insert(dto);
definition.Id = dto.Id;
}
if (definition.PackageId == default)
{
definition.PackageId = Guid.NewGuid();
}
// Save snapshot locally, we do this to the updated packagePath
ExportPackage(definition);
// Create dto from definition
var updatedDto = new CreatedPackageSchemaDto
{
Name = definition.Name,
Value = _xmlParser.ToXml(definition).ToString(),
Id = definition.Id,
PackageId = definition.PackageId,
UpdateDate = DateTime.Now,
};
Database?.Update(updatedDto);
return true;
}
public string ExportPackage(PackageDefinition definition)
{
// Ensure it's valid
ValidatePackage(definition);
// Create a folder for building this package
var temporaryPath =
_hostingEnvironment.MapPathContentRoot(Path.Combine(_tempFolderPath, Guid.NewGuid().ToString()));
Directory.CreateDirectory(temporaryPath);
try
{
// Init package file
XDocument compiledPackageXml = CreateCompiledPackageXml(out XElement root);
// Info section
root.Add(GetPackageInfoXml(definition));
PackageDocumentsAndTags(definition, root);
PackageDocumentTypes(definition, root);
PackageMediaTypes(definition, root);
PackageTemplates(definition, root);
PackageStylesheets(definition, root);
PackageStaticFiles(definition.Scripts, root, "Scripts", "Script", _fileSystems.ScriptsFileSystem!);
PackageStaticFiles(definition.PartialViews, root, "PartialViews", "View", _fileSystems.PartialViewsFileSystem!);
PackageDictionaryItems(definition, root);
PackageLanguages(definition, root);
PackageDataTypes(definition, root);
Dictionary<string, Stream> mediaFiles = PackageMedia(definition, root);
string fileName;
string tempPackagePath;
if (mediaFiles.Count > 0)
{
fileName = "package.zip";
tempPackagePath = Path.Combine(temporaryPath, fileName);
using (FileStream fileStream = File.OpenWrite(tempPackagePath))
using (var archive = new ZipArchive(fileStream, ZipArchiveMode.Create, true))
{
ZipArchiveEntry packageXmlEntry = archive.CreateEntry("package.xml");
using (Stream entryStream = packageXmlEntry.Open())
{
compiledPackageXml.Save(entryStream);
}
foreach (KeyValuePair<string, Stream> mediaFile in mediaFiles)
{
var entryPath = $"media{mediaFile.Key.EnsureStartsWith('/')}";
ZipArchiveEntry mediaEntry = archive.CreateEntry(entryPath);
using (Stream entryStream = mediaEntry.Open())
using (mediaFile.Value)
{
mediaFile.Value.Seek(0, SeekOrigin.Begin);
mediaFile.Value.CopyTo(entryStream);
}
}
}
}
else
{
fileName = "package.xml";
tempPackagePath = Path.Combine(temporaryPath, fileName);
using (FileStream fileStream = File.OpenWrite(tempPackagePath))
{
compiledPackageXml.Save(fileStream);
}
}
var directoryName =
_hostingEnvironment.MapPathContentRoot(Path.Combine(
_createdPackagesFolderPath,
definition.Name.Replace(' ', '_')));
var expectedRoot = Path.GetFullPath(_hostingEnvironment.MapPathContentRoot(_createdPackagesFolderPath));
var finalPackagePath = Path.GetFullPath(Path.Combine(directoryName, fileName));
if (finalPackagePath.StartsWith(expectedRoot) == false)
{
throw new IOException("Invalid path due to the package name");
}
Directory.CreateDirectory(directoryName);
// Clean existing files
foreach (var packagePath in new[] { definition.PackagePath, finalPackagePath })
{
if (File.Exists(packagePath))
{
File.Delete(packagePath);
}
}
// Move to final package path
File.Move(tempPackagePath, finalPackagePath);
definition.PackagePath = finalPackagePath;
return finalPackagePath;
}
finally
{
// Clean up
Directory.Delete(temporaryPath, true);
}
}
private static XElement GetPackageInfoXml(PackageDefinition definition)
{
var info = new XElement("info");
// Package info
var package = new XElement("package");
package.Add(new XElement("name", definition.Name));
info.Add(package);
return info;
}
private XDocument CreateCompiledPackageXml(out XElement root)
{
root = new XElement("umbPackage");
var compiledPackageXml = new XDocument(root);
return compiledPackageXml;
}
private void ValidatePackage(PackageDefinition definition)
{
// Ensure it's valid
var context = new ValidationContext(definition, null, null);
var results = new List<ValidationResult>();
var isValid = Validator.TryValidateObject(definition, context, results);
if (!isValid)
{
throw new InvalidOperationException("Validation failed, there is invalid data on the model: " +
string.Join(", ", results.Select(x => x.ErrorMessage)));
}
}
private void PackageDataTypes(PackageDefinition definition, XContainer root)
{
var dataTypes = new XElement("DataTypes");
foreach (var dataTypeId in definition.DataTypes)
{
if (Guid.TryParse(dataTypeId, out Guid dataTypeKey) is false)
{
continue;
}
IDataType? dataType = _dataTypeService.GetAsync(dataTypeKey).GetAwaiter().GetResult();
if (dataType is null)
{
continue;
}
dataTypes.Add(_serializer.Serialize(dataType));
}
root.Add(dataTypes);
}
private void PackageLanguages(PackageDefinition definition, XContainer root)
{
var languages = new XElement("Languages");
foreach (var isoCode in definition.Languages)
{
ILanguage? lang = _languageService.GetAsync(isoCode).GetAwaiter().GetResult();
if (lang == null)
{
continue;
}
languages.Add(_serializer.Serialize(lang));
}
root.Add(languages);
}
private void PackageDictionaryItems(PackageDefinition definition, XContainer root)
{
var rootDictionaryItems = new XElement("DictionaryItems");
var items = new Dictionary<Guid, (IDictionaryItem dictionaryItem, XElement serializedDictionaryValue)>();
foreach (var dictionaryId in definition.DictionaryItems)
{
if (Guid.TryParse(dictionaryId, out Guid dictionaryKey) is false)
{
continue;
}
IDictionaryItem? dictionaryItem = _dictionaryItemService.GetAsync(dictionaryKey).GetAwaiter().GetResult();
if (dictionaryItem is null)
{
continue;
}
items[dictionaryItem.Key] = (dictionaryItem, _serializer.Serialize(dictionaryItem, false));
}
// organize them in hierarchy ...
var itemCount = items.Count;
var processed = new Dictionary<Guid, XElement>();
while (processed.Count < itemCount)
{
foreach (Guid key in items.Keys.ToList())
{
(IDictionaryItem dictionaryItem, XElement serializedDictionaryValue) = items[key];
if (!dictionaryItem.ParentId.HasValue)
{
// if it has no parent, its definitely just at the root
AppendDictionaryElement(rootDictionaryItems, items, processed, key, serializedDictionaryValue);
}
else
{
if (processed.ContainsKey(dictionaryItem.ParentId.Value))
{
// we've processed this parent element already so we can just append this xml child to it
AppendDictionaryElement(processed[dictionaryItem.ParentId.Value], items, processed, key, serializedDictionaryValue);
}
else if (items.ContainsKey(dictionaryItem.ParentId.Value))
{
// we know the parent exists in the dictionary but
// we haven't processed it yet so we'll leave it for the next loop
}
else
{
// in this case, the parent of this item doesn't exist in our collection, we have no
// choice but to add it to the root.
AppendDictionaryElement(rootDictionaryItems, items, processed, key, serializedDictionaryValue);
}
}
}
}
root.Add(rootDictionaryItems);
static void AppendDictionaryElement(
XElement rootDictionaryItems,
Dictionary<Guid, (IDictionaryItem dictionaryItem, XElement serializedDictionaryValue)> items,
Dictionary<Guid, XElement> processed,
Guid key,
XElement serializedDictionaryValue)
{
// track it
processed.Add(key, serializedDictionaryValue);
// append it
rootDictionaryItems.Add(serializedDictionaryValue);
// remove it so its not re-processed
items.Remove(key);
}
}
private void PackageStylesheets(PackageDefinition definition, XContainer root)
{
var stylesheetsXml = new XElement("Stylesheets");
foreach (var stylesheet in definition.Stylesheets)
{
if (stylesheet.IsNullOrWhiteSpace())
{
continue;
}
XElement? xml = GetStylesheetXml(stylesheet, true);
if (xml != null)
{
stylesheetsXml.Add(xml);
}
}
root.Add(stylesheetsXml);
}
private void PackageStaticFiles(
IEnumerable<string> filePaths,
XContainer root,
string containerName,
string elementName,
IFileSystem fileSystem)
{
var scriptsXml = new XElement(containerName);
foreach (var file in filePaths)
{
if (file.IsNullOrWhiteSpace())
{
continue;
}
if (!fileSystem.FileExists(file))
{
throw new InvalidOperationException("No file found with path " + file);
}
using Stream stream = fileSystem.OpenFile(file);
using (var reader = new StreamReader(stream))
{
var fileContents = reader.ReadToEnd();
scriptsXml.Add(
new XElement(
elementName,
new XAttribute("path", file),
new XCData(fileContents)));
}
}
root.Add(scriptsXml);
}
private void PackageTemplates(PackageDefinition definition, XContainer root)
{
var templatesXml = new XElement("Templates");
foreach (var templateId in definition.Templates)
{
if (Guid.TryParse(templateId, out Guid templateKey) is false)
{
continue;
}
ITemplate? template = _templateService.GetAsync(templateKey).GetAwaiter().GetResult();
if (template == null)
{
continue;
}
templatesXml.Add(_serializer.Serialize(template));
}
root.Add(templatesXml);
}
private void PackageDocumentTypes(PackageDefinition definition, XContainer root)
{
var contentTypes = new HashSet<IContentType>();
var docTypesXml = new XElement("DocumentTypes");
foreach (var documentTypeIdentifierString in definition.DocumentTypes)
{
if (Guid.TryParse(documentTypeIdentifierString, out Guid documentTypeKey) is false)
{
continue;
}
IContentType? contentType = _contentTypeService.Get(documentTypeKey);
if (contentType is null)
{
continue;
}
AddDocumentType(contentType, contentTypes);
}
foreach (IContentType contentType in contentTypes)
{
docTypesXml.Add(_serializer.Serialize(contentType));
}
root.Add(docTypesXml);
}
private void PackageMediaTypes(PackageDefinition definition, XContainer root)
{
var mediaTypes = new HashSet<IMediaType>();
var mediaTypesXml = new XElement("MediaTypes");
foreach (var mediaTypeId in definition.MediaTypes)
{
if (Guid.TryParse(mediaTypeId, out Guid mediaTypeKey) is false)
{
continue;
}
IMediaType? mediaType = _mediaTypeService.Get(mediaTypeKey);
if (mediaType == null)
{
continue;
}
AddMediaType(mediaType, mediaTypes);
}
foreach (IMediaType mediaType in mediaTypes)
{
mediaTypesXml.Add(_serializer.Serialize(mediaType));
}
root.Add(mediaTypesXml);
}
private void PackageDocumentsAndTags(PackageDefinition definition, XContainer root)
{
// Documents and tags
if (string.IsNullOrWhiteSpace(definition.ContentNodeId))
{
return;
}
if (Guid.TryParse(definition.ContentNodeId, out Guid contentNodeKey) is false)
{
return;
}
IContent? content = _contentService.GetById(contentNodeKey);
if (content is null)
{
return;
}
XElement contentXml = definition.ContentLoadChildNodes
? content.ToDeepXml(_serializer)
: content.ToXml(_serializer);
// Create the Documents/DocumentSet node
root.Add(
new XElement(
"Documents",
new XElement(
"DocumentSet",
new XAttribute("importMode", "root"),
contentXml)));
}
private Dictionary<string, Stream> PackageMedia(PackageDefinition definition, XElement root)
{
var mediaStreams = new Dictionary<string, Stream>();
// callback that occurs on each serialized media item
void OnSerializedMedia(IMedia media, XElement xmlMedia)
{
// get the media file path and store that separately in the XML.
// the media file path is different from the URL and is specifically
// extracted using the property editor for this media file and the current media file system.
Stream mediaStream = _mediaFileManager.GetFile(media, out var mediaFilePath);
if (mediaFilePath is not null)
{
xmlMedia.Add(new XAttribute("mediaFilePath", mediaFilePath));
// add the stream to our outgoing stream
mediaStreams.Add(mediaFilePath, mediaStream);
}
}
IEnumerable<IMedia> medias = _mediaService.GetByIds(definition.MediaUdis);
var mediaXml = new XElement(
"MediaItems",
medias.Select(media =>
{
XElement serializedMedia = _serializer.Serialize(
media,
definition.MediaLoadChildNodes,
OnSerializedMedia);
return new XElement("MediaSet", serializedMedia);
}));
root.Add(mediaXml);
return mediaStreams;
}
/// <summary>
/// Converts a umbraco stylesheet to a package xml node
/// </summary>
/// <param name="path">The path of the stylesheet.</param>
/// <param name="includeProperties">if set to <c>true</c> [include properties].</param>
private XElement? GetStylesheetXml(string path, bool includeProperties)
{
if (string.IsNullOrWhiteSpace(path))
{
throw new ArgumentException("Value cannot be null or whitespace.", nameof(path));
}
IStylesheet? stylesheet = _fileService.GetStylesheet(path);
if (stylesheet == null)
{
return null;
}
return _serializer.Serialize(stylesheet, includeProperties);
}
private void AddDocumentType(IContentType dt, HashSet<IContentType> dtl)
{
if (dt.ParentId > 0)
{
IContentType? parent = _contentTypeService.Get(dt.ParentId);
if (parent != null)
{
AddDocumentType(parent, dtl);
}
}
if (!dtl.Contains(dt))
{
dtl.Add(dt);
}
}
private void AddMediaType(IMediaType mediaType, HashSet<IMediaType> mediaTypes)
{
if (mediaType.ParentId > 0)
{
IMediaType? parent = _mediaTypeService.Get(mediaType.ParentId);
if (parent != null)
{
AddMediaType(parent, mediaTypes);
}
}
if (!mediaTypes.Contains(mediaType))
{
mediaTypes.Add(mediaType);
}
}
private PackageDefinition? CreatePackageDefinitionFromSchema(CreatedPackageSchemaDto packageSchema)
{
var packageDefinition = _xmlParser.ToPackageDefinition(XElement.Parse(packageSchema.Value));
if (packageDefinition is not null)
{
packageDefinition.Id = packageSchema.Id;
packageDefinition.Name = packageSchema.Name;
packageDefinition.PackageId = packageSchema.PackageId;
}
return packageDefinition;
}
}