Merge commit from fork

Refined validation of portal import

Author: valadas

DNN Platform/Modules/DnnExportImport/Components/Controllers/ImportController.cs

@@ -88,7 +88,7 @@ public bool VerifyImportPackage(string packageId, ImportExportSummary summary, o
         {
             bool isValid;
             errorMessage = string.Empty;
-            var importFolder = Path.Combine(ExportFolder, packageId);
+            var importFolder = Path.Combine(ExportFolder, Path.GetFileName(packageId));
             if (!IsValidImportFolder(importFolder))
             {
                 return false;

DNN Platform/Modules/DnnExportImport/Services/ExportImportController.cs

@@ -15,12 +15,19 @@ namespace Dnn.ExportImport.Services
     using DotNetNuke.Services.Localization;
     using DotNetNuke.Web.Api;
 
+    /// <summary>
+    /// REST APIs to manage import/export jobs.
+    /// </summary>
     [RequireHost]
     public class ExportImportController : DnnApiController
     {
+        /// <summary>
+        /// Exports the specified site.
+        /// </summary>
+        /// <param name="exportDto">The details needed to export a site.</param>
+        /// <returns>OK.</returns>
         [HttpPost]
         [ValidateAntiForgeryToken]
-
         public HttpResponseMessage Export(ExportDto exportDto)
         {
             var controller = new ExportController();
@@ -29,14 +36,17 @@ public HttpResponseMessage Export(ExportDto exportDto)
             return this.Request.CreateResponse(HttpStatusCode.OK, new { jobId });
         }
 
+        /// <summary>
+        /// Imports a site.
+        /// </summary>
+        /// <param name="importDto">The details required to import a site.</param>
+        /// <returns>OK or BadRequest with a message.</returns>
         [HttpPost]
         [ValidateAntiForgeryToken]
-
         public HttpResponseMessage Import(ImportDto importDto)
         {
             var controller = new ImportController();
-            string message;
-            if (controller.VerifyImportPackage(importDto.PackageId, null, out message))
+            if (controller.VerifyImportPackage(importDto.PackageId, null, out var message))
             {
                 var jobId = controller.QueueOperation(this.PortalSettings.UserId, importDto);
                 return this.Request.CreateResponse(HttpStatusCode.OK, new { jobId });
@@ -45,14 +55,17 @@ public HttpResponseMessage Import(ImportDto importDto)
             return this.Request.CreateErrorResponse(HttpStatusCode.BadRequest, message);
         }
 
+        /// <summary>
+        /// Verifies an import package validity.
+        /// </summary>
+        /// <param name="packageId">The ID of the package to validate.</param>
+        /// <returns>OK with a summary or BadRequest with an error message.</returns>
         [HttpGet]
-
         public HttpResponseMessage VerifyImportPackage(string packageId)
         {
             var controller = new ImportController();
-            string message;
             var summary = new ImportExportSummary();
-            var isValid = controller.VerifyImportPackage(packageId, summary, out message);
+            var isValid = controller.VerifyImportPackage(packageId, summary, out var message);
             summary.ConvertToLocal(this.UserInfo);
             return isValid
                 ? this.Request.CreateResponse(HttpStatusCode.OK, summary)
@@ -66,20 +79,22 @@ public HttpResponseMessage VerifyImportPackage(string packageId)
         /// <param name="pageSize">Page size. Should not be more than 100.</param>
         /// <returns>An <see cref="HttpResponseMessage"/>.</returns>
         [HttpGet]
-
         public HttpResponseMessage GetImportPackages(string keyword = "", string order = "newest", int pageIndex = 0, int pageSize = 10)
         {
             var controller = new ImportController();
-            int total;
-            var packages = controller.GetImportPackages(out total, keyword, order, pageIndex, pageSize).ToList();
+            var packages = controller.GetImportPackages(out var total, keyword, order, pageIndex, pageSize).ToList();
             packages.ForEach(package => package.ConvertToLocal(this.UserInfo));
             return this.Request.CreateResponse(HttpStatusCode.OK, new { packages, total });
         }
 
-        // this is POST so users can't cancel using a simple browser link
+        /// <summary>
+        /// Cancels a job.
+        /// </summary>
+        /// <param name="jobId">The ID of the job to cancel.</param>
+        /// <remarks>This is a POST so users can't cancel using a simple browser link.</remarks>
+        /// <returns>OK or a BadRequest with a cancel status value.</returns>
         [HttpPost]
         [ValidateAntiForgeryToken]
-
         public HttpResponseMessage CancelProcess([FromUri] int jobId)
         {
             var controller = new BaseController();
@@ -88,10 +103,14 @@ public HttpResponseMessage CancelProcess([FromUri] int jobId)
                 cancelStatus ? HttpStatusCode.OK : HttpStatusCode.BadRequest, new { success = cancelStatus });
         }
 
-        // this is POST so users can't remove a job using a browser link
+        /// <summary>
+        /// Removes a job.
+        /// </summary>
+        /// <param name="jobId">The ID of the job to remove.</param>
+        /// <remarks>This is a POST so users can't remove a job using a browser link.</remarks>
+        /// <returns>OK or a BadRequest with a status value.</returns>
         [HttpPost]
         [ValidateAntiForgeryToken]
-
         public HttpResponseMessage RemoveJob([FromUri] int jobId)
         {
             var controller = new BaseController();
@@ -100,8 +119,13 @@ public HttpResponseMessage RemoveJob([FromUri] int jobId)
                 cancelStatus ? HttpStatusCode.OK : HttpStatusCode.BadRequest, new { success = cancelStatus });
         }
 
+        /// <summary>
+        /// Gets the last job time.
+        /// </summary>
+        /// <param name="portal">The ID of the portal to check.</param>
+        /// <param name="jobType">Type of the job.</param>
+        /// <returns>OK with the last time or a BadRequest with a message.</returns>
         [HttpGet]
-
         public HttpResponseMessage LastJobTime(int portal, JobType jobType)
         {
             if (!this.UserInfo.IsSuperUser && portal != this.PortalSettings.PortalId)
@@ -124,8 +148,16 @@ public HttpResponseMessage LastJobTime(int portal, JobType jobType)
                 new { lastTime = Util.GetDateTimeString(lastTime) });
         }
 
+        /// <summary>
+        /// Gets all the jobs.
+        /// </summary>
+        /// <param name="portal">The ID of the portal to check.</param>
+        /// <param name="pageSize">Size of the page.</param>
+        /// <param name="pageIndex">Index of the page.</param>
+        /// <param name="jobType">Type of the job.</param>
+        /// <param name="keywords">The keywords to search for.</param>
+        /// <returns>OK with a list of jobs or a BadRequest with an error message.</returns>
         [HttpGet]
-
         public HttpResponseMessage AllJobs(int portal, int? pageSize = 10, int? pageIndex = 0, int? jobType = null, string keywords = null)
         {
             if (!this.UserInfo.IsSuperUser && portal != this.PortalSettings.PortalId)
@@ -140,8 +172,12 @@ public HttpResponseMessage AllJobs(int portal, int? pageSize = 10, int? pageInde
             return this.Request.CreateResponse(HttpStatusCode.OK, jobs);
         }
 
+        /// <summary>
+        /// Jobs the details about a single job.
+        /// </summary>
+        /// <param name="jobId">The ID of the job to get.</param>
+        /// <returns>OK with the job details or BadRequest with an error message.</returns>
         [HttpGet]
-
         public HttpResponseMessage JobDetails(int jobId)
         {
             var controller = new BaseController();