using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Net; using System.Text; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Mvc; using Microsoft.Net.Http.Headers; using Umbraco.Cms.Core.Packaging; using Umbraco.Cms.Core.Security; using Umbraco.Cms.Core.Services; using Umbraco.Cms.Web.Common.ActionsResults; using Umbraco.Cms.Web.Common.Attributes; using Umbraco.Cms.Web.Common.Authorization; using Constants = Umbraco.Cms.Core.Constants; using Microsoft.Extensions.Logging; using Umbraco.Cms.Infrastructure.Install; namespace Umbraco.Cms.Web.BackOffice.Controllers { /// /// A controller used for managing packages in the back office /// [PluginController(Constants.Web.Mvc.BackOfficeApiArea)] [Authorize(Policy = AuthorizationPolicies.SectionAccessPackages)] public class PackageController : UmbracoAuthorizedJsonController { private readonly IPackagingService _packagingService; private readonly IBackOfficeSecurityAccessor _backofficeSecurityAccessor; private readonly PackageMigrationRunner _packageMigrationRunner; private readonly ILogger _logger; public PackageController( IPackagingService packagingService, IBackOfficeSecurityAccessor backofficeSecurityAccessor, PackageMigrationRunner packageMigrationRunner, ILogger logger) { _packagingService = packagingService ?? throw new ArgumentNullException(nameof(packagingService)); _backofficeSecurityAccessor = backofficeSecurityAccessor ?? throw new ArgumentNullException(nameof(backofficeSecurityAccessor)); _packageMigrationRunner = packageMigrationRunner; _logger = logger; } public IEnumerable GetCreatedPackages() { return _packagingService.GetAllCreatedPackages(); } public ActionResult GetCreatedPackageById(int id) { var package = _packagingService.GetCreatedPackageById(id); if (package == null) return NotFound(); return package; } public PackageDefinition GetEmpty() => new PackageDefinition(); /// /// Creates or updates a package /// /// /// public ActionResult PostSavePackage(PackageDefinition model) { if (ModelState.IsValid == false) return ValidationProblem(ModelState); //save it if (!_packagingService.SaveCreatedPackage(model)) { return ValidationProblem( model.Id == default ? $"A package with the name {model.Name} already exists" : $"The package with id {model.Id} was not found"); } _packagingService.ExportCreatedPackage(model); //the packagePath will be on the model return model; } /// /// Deletes a created package /// /// /// [HttpPost] [HttpDelete] public IActionResult DeleteCreatedPackage(int packageId) { _packagingService.DeleteCreatedPackage(packageId, _backofficeSecurityAccessor.BackOfficeSecurity.GetUserId().Result ?? -1); return Ok(); } [HttpPost] public ActionResult> RunMigrations([FromQuery]string packageName) { try { _packageMigrationRunner.RunPackageMigrationsIfPending(packageName); return _packagingService.GetAllInstalledPackages().ToList(); } catch (Exception ex) { _logger.LogError(ex, "Package migration failed on package {Package}", packageName); return ValidationErrorResult.CreateNotificationValidationErrorResult( $"Package migration failed on package {packageName} with error: {ex.Message}. Check log for full details."); } } [HttpGet] public IActionResult DownloadCreatedPackage(int id) { var package = _packagingService.GetCreatedPackageById(id); if (package == null) return NotFound(); if (!System.IO.File.Exists(package.PackagePath)) return ValidationProblem("No file found for path " + package.PackagePath); var fileName = Path.GetFileName(package.PackagePath); var encoding = Encoding.UTF8; var cd = new System.Net.Mime.ContentDisposition { FileName = WebUtility.UrlEncode(fileName), Inline = false // false = prompt the user for downloading; true = browser to try to show the file inline }; Response.Headers.Add("Content-Disposition", cd.ToString()); // Set custom header so umbRequestHelper.downloadFile can save the correct filename Response.Headers.Add("x-filename", WebUtility.UrlEncode(fileName)); return new FileStreamResult(System.IO.File.OpenRead(package.PackagePath), new MediaTypeHeaderValue("application/octet-stream") { Charset = encoding.WebName, }); } public ActionResult GetInstalledPackageByName([FromQuery] string packageName) { InstalledPackage pack = _packagingService.GetInstalledPackageByName(packageName); if (pack == null) { return NotFound(); } return pack; } /// /// Returns all installed packages - only shows their latest versions /// /// public IEnumerable GetInstalled() => _packagingService.GetAllInstalledPackages().ToList(); } }