#445 update filenames for download

Author: DavidBlaa

Components/IO/BExIS.IO.Tests/IOHelperTests.cs

@@ -31,15 +31,15 @@ public void OneTimeTearDown()
         public void GetDynamicStorePathValuesTest(
             [Range(1, 2)] long datasetId, [Range(1, 2)] long datasetVersionOrderNr)
         {
-            string path = IoHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, "title", ".txt");
+            string path = IOHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, "title", ".txt");
 
             path.Should().NotBeNull("Because path is not null.");
         }
 
         [TestCase(1, 2, "test", ".txt", ExpectedResult = @"Datasets\1\DatasetVersions\1_2_test.txt")]
         public string GetDynamicStorePathResultTest(long datasetId, long datasetVersionOrderNr, string title, string extention)
         {
-            return IoHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention);
+            return IOHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention);
         }
 
         [TestCase(-1, 1, "title", ".txt")]
@@ -48,7 +48,7 @@ public string GetDynamicStorePathResultTest(long datasetId, long datasetVersionO
         [TestCase(1, 1, "title", "")]
         public void GetDynamicStorePathWidthExceptionTest(long datasetId, long datasetVersionOrderNr, string title, string extention)
         {
-            Assert.Throws<Exception>(() => IoHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention));
+            Assert.Throws<Exception>(() => IOHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention));
         }
     }
 }

Components/IO/BExIS.IO/BExIS.IO.csproj

@@ -67,6 +67,12 @@
     <Analyzer Include="..\..\..\packages\Microsoft.CodeAnalysis.NetAnalyzers.8.0.0\analyzers\dotnet\cs\Microsoft.CodeAnalysis.CSharp.NetAnalyzers.dll" />
     <Analyzer Include="..\..\..\packages\Microsoft.CodeAnalysis.NetAnalyzers.8.0.0\analyzers\dotnet\cs\Microsoft.CodeAnalysis.NetAnalyzers.dll" />
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\Utils\BExIS.Utils.Config\BExIS.Utils.Config.csproj">
+      <Project>{6EAD7D02-02F7-42FF-85E4-90BB892D3846}</Project>
+      <Name>BExIS.Utils.Config</Name>
+    </ProjectReference>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">

Components/IO/BExIS.Io.Transform.Output/OutputDatasetManager.cs

@@ -74,7 +74,7 @@ public static GFBIOPangaeaFormularObject GetGFBIOPangaeaFormularObject(long data
 
         public static string GetDynamicDatasetStorePath(long datasetId, long datasetVersionOrderNr, string title, string extention)
         {
-            return IoHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention);
+            return IOHelper.GetDynamicStorePath(datasetId, datasetVersionOrderNr, title, extention);
         }
 
         public static XmlDocument GenerateManifest(long datasetId, long versionId)

Components/IO/BExIS.Io/IoHelper.cs

@@ -1,9 +1,10 @@
-using System;
+using BExIS.Utils.Config;
+using System;
 using System.IO;
 
 namespace BExIS.IO
 {
-    public class IoHelper
+    public class IOHelper
     {
         public static string GetDynamicStorePath(long datasetId, long datasetVersionOrderNr, string title, string extention)
         {
@@ -14,9 +15,86 @@ public static string GetDynamicStorePath(long datasetId, long datasetVersionOrde
             if (extention.IndexOf('.') == -1) throw new Exception("Extention should start with '.' .");
 
             string storePath = Path.Combine("Datasets", datasetId.ToString(), "DatasetVersions");
+            string fileName = datasetId + "_" + datasetVersionOrderNr + "_" + title + extention;//GetFileName(FileType.None, datasetId, (int)datasetVersionOrderNr, 0, title);
 
-            return Path.Combine(storePath, datasetId + "_" + datasetVersionOrderNr + "_" + title + extention);
+            return Path.Combine(storePath, fileName);
         }
+
+        public static string GetDynamicStoreFilePath(long datasetId, long datasetVersionOrderNr, string name, string extention)
+        {
+            if (datasetId < 1) throw new Exception("Dataset id can not be less then 1.");
+            if (datasetVersionOrderNr < 1) throw new Exception("Dataset version number can not be less then 1.");
+            if (string.IsNullOrEmpty(name)) throw new Exception("Title should not be Empty.");
+            if (string.IsNullOrEmpty(extention)) throw new Exception("Extention should not be Empty.");
+            if (extention.IndexOf('.') == -1) throw new Exception("Extention should start with '.' .");
+
+            string storePath = Path.Combine("Datasets", datasetId.ToString(), "DatasetVersions");
+            string fileName = GetFileName(FileType.None, datasetId, (int)datasetVersionOrderNr, 0, name);
+
+            return Path.Combine(storePath, fileName + extention);
+        }
+
+        public static string GetFileName(FileType type, long datasetId, int versionNr, long datastructureId, string title = "")
+        {
+            string appName = GeneralSettings.ApplicationName;
+            if (string.IsNullOrEmpty(appName)) appName = "BEXIS2";
+
+            string downloadName = "no title available";
+            string downloadDate = DateTime.Now.ToString("yyyyMMdd");
+
+            string downloadTitle = title.Replace(" ", "");
+
+            switch (type)
+            {
+                case FileType.Metadata:
+                    // filename should contain: application name, dataset ID, and version ID
+                    downloadName = string.Format("{0}_{1}_v{2}_metadata", appName, datasetId, versionNr);
+                    break;
+                case FileType.MetadataExport:
+                    // filename should contain: application name, dataset ID, and version ID
+                    downloadName = string.Format("{0}_{1}_v{2}_metadata_{3}", appName, datasetId, versionNr, title);
+                    break;
+                case FileType.DataStructure:
+                    downloadName = string.Format("{0}_{1}_datastructure_{2}", appName, datasetId, datastructureId);
+                    break;
+                case FileType.PrimaryData:
+                    downloadName = string.Format("{0}_{1}_v{2}_data", appName, datasetId, versionNr);
+
+                    break;
+                case FileType.PrimaryDataFiles:
+                    downloadName = string.Format("{0}_{1}_v{2}_data_{3}", appName, datasetId, versionNr, title);
+                    break;
+                case FileType.Attachments:
+                    downloadName = string.Format("{0}_{1}_v{2}_attachment_{3}", appName, datasetId, versionNr, title);
+                    break;
+                case FileType.Bundle:
+                    downloadName = string.Format("{0}_{1}_v{2}_{3}_{4}", appName, datasetId, versionNr, downloadTitle, downloadDate);
+                    break;
+                case FileType.Manifest:
+                    downloadName = string.Format("{0}_{1}_v{2}_general-metadata", appName, datasetId, versionNr);
+                    break;
+                default:
+                    downloadName = string.Format("{0}_{1}_v{2}_{3}", appName, datasetId, versionNr, title);
+                    break;
+            }
+
+
+            return downloadName;
+        }
+
+    }
+
+    public enum FileType
+    {
+        Metadata,
+        MetadataExport,
+        PrimaryData,
+        PrimaryDataFiles,
+        DataStructure,
+        Attachments,
+        Bundle,
+        Manifest,
+        None
     }
 
     public enum DecimalCharacter

Components/XML/BExIS.Xml.Helpers/BExIS.Xml.Helpers.csproj

@@ -71,7 +71,6 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="DatasetStore.cs" />
-    <Compile Include="IOHelper.cs" />
     <Compile Include="Mapping\XmlMapperManager.cs" />
     <Compile Include="Mapping\XmlSchemaManager.cs" />
     <Compile Include="SampleStore.cs" />

Components/XML/BExIS.Xml.Helpers/IOHelper.cs

@@ -28,6 +28,7 @@
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
+using System.Security.Cryptography;
 using System.Text;
 using System.Web.Mvc;
 using System.Web.Routing;
@@ -203,13 +204,14 @@ public ActionResult GenerateZip(long id, long versionid, string format)
                     long dataStructureId = 0;
                     int datasetVersionNumber = dm.GetDatasetVersionNr(datasetVersionId);
                     DatasetVersion datasetVersion = datasetManager.GetDatasetVersion(datasetVersionId);
+                    string title = "";    
 
                     #region Metadata
 
                     //metadata as XML
                     XmlDocument document = OutputMetadataManager.GetConvertedMetadata(id, TransmissionType.mappingFileExport, datasetVersion.Dataset.MetadataStructure.Name);
 
-                    //generate metadata as HTML and store the file locally
+                    //generate data structure as html 
                     generateMetadataAsHtml(datasetVersion);
 
                     #endregion
@@ -222,7 +224,7 @@ public ActionResult GenerateZip(long id, long versionid, string format)
                         OutputDataManager odm = new OutputDataManager();
 
                         //check wheter title is empty or not
-                        string title = String.IsNullOrEmpty(datasetVersion.Title) ? "no title available" : datasetVersion.Title;
+                        title = String.IsNullOrEmpty(datasetVersion.Title) ? "no title available" : datasetVersion.Title;
 
                         switch (format)
                         {
@@ -260,16 +262,15 @@ public ActionResult GenerateZip(long id, long versionid, string format)
 
                         AsciiWriter.AllTextToFile(datastructureFilePath, json);
 
-                        //generate data structure as html 
                         generateDataStructureHtml(datasetVersion);
                     }
 
                     #endregion
 
                     #region zip file
 
-                    string zipName = publishingManager.GetZipFileName(id, datasetVersionNumber);
-                    string zipPath = Path.Combine(publishingManager.GetDirectoryPath(id, brokerName), zipName);
+                    string zipName = IOHelper.GetFileName(FileType.Bundle, id, datasetVersionNumber, dataStructureId, title); //publishingManager.GetZipFileName(id, datasetVersionNumber);
+                    string zipPath = Path.Combine(publishingManager.GetDirectoryPath(id, brokerName), zipName+".zip");
                     FileHelper.CreateDicrectoriesIfNotExist(Path.GetDirectoryName(zipPath));
 
                     using (var zipFileStream = new FileStream(zipPath, FileMode.Create))
@@ -283,13 +284,33 @@ public ActionResult GenerateZip(long id, long versionid, string format)
                         {
                             string path = Path.Combine(AppConfiguration.DataPath, cd.URI);
                             string name = cd.URI.Split('\\').Last();
+                            string ext = Path.GetExtension(name).ToLower();
 
                             if(cd.Name.StartsWith("generated") && !cd.Name.Equals(dataName)) continue;
 
                             if (FileHelper.FileExist(path))
                             {
                                 if (!archive.Entries.Any(entry => entry.Name.EndsWith(name)))
+                                {
+                                    if (cd.Name.Equals("metadata"))
+                                    {
+                                        name = IOHelper.GetFileName(FileType.Metadata, id, datasetVersionNumber, dataStructureId) + ext;
+                                    }
+                                    else if (cd.Name.Equals("datastructure"))
+                                    {
+                                        name = IOHelper.GetFileName(FileType.DataStructure, id, datasetVersionNumber, dataStructureId) + ext;
+                                    }
+                                    else if (cd.Name.Contains("generated"))
+                                    {
+                                        name = IOHelper.GetFileName(FileType.PrimaryData, id, datasetVersionNumber, dataStructureId) + ext;
+                                    }
+                                    else
+                                    {
+                                        name = IOHelper.GetFileName(FileType.None, id, datasetVersionNumber, dataStructureId,cd.Name) + ext;
+                                    }
+
                                     archive.AddFileToArchive(path, name);
+                                }
                             }
                         }
 
@@ -307,16 +328,17 @@ public ActionResult GenerateZip(long id, long versionid, string format)
 
                         if (manifest != null)
                         {
+                            string manifestFileName = IOHelper.GetFileName(FileType.Manifest, id, datasetVersionNumber, dataStructureId);
                             string manifestPath = OutputDatasetManager.GetDynamicDatasetStorePath(id,
-                                datasetVersionNumber, "manifest", ".json");
+                                datasetVersionNumber, manifestFileName, ".json");
                             string fullFilePath = Path.Combine(AppConfiguration.DataPath, manifestPath);
                             string directory = Path.GetDirectoryName(fullFilePath);
                             if (!Directory.Exists(directory))
                                 FileHelper.CreateDicrectoriesIfNotExist(directory);
 
                            System.IO.File.WriteAllText(fullFilePath, manifest, System.Text.Encoding.UTF8);
 
-                            archive.AddFileToArchive(fullFilePath, "manifest.json");
+                            archive.AddFileToArchive(fullFilePath, manifestFileName + ".json");
                         }
                         #endregion
 
@@ -329,7 +351,7 @@ public ActionResult GenerateZip(long id, long versionid, string format)
 
                         #endregion terms and conditions
 
-                        string title = datasetVersion.Title;
+                        title = datasetVersion.Title;
                         title = String.IsNullOrEmpty(title) ? "unknown" : title;
 
                         string message = string.Format("dataset {0} version {1} was downloaded as zip - {2}.", id,
@@ -406,6 +428,12 @@ private string storeGeneratedFilePathToContentDiscriptor(long datasetId, Dataset
                 mimeType = "text/comma-separated-values";
             }
 
+            if (ext.Contains("json"))
+            {
+                name = "datastructure";
+                mimeType = "application/json";
+            }
+
             if (ext.Contains("html"))
             {
                 name = title;
@@ -436,6 +464,8 @@ private string storeGeneratedFilePathToContentDiscriptor(long datasetId, Dataset
                     {
                         if (cd.Name.Equals(name) && cd.MimeType.Equals(mimeType))
                         {
+                            cd.Name = name;
+                            cd.MimeType = mimeType;
                             cd.URI = dynamicPath;
                             dm.UpdateContentDescriptor(cd);
                         }
@@ -463,7 +493,7 @@ private void generateMetadataAsHtml(DatasetVersion dsv)
 
             string title = dsv.Title;
             Session["ShowDataMetadata"] = dsv.Metadata;
-
+            int versionNr = 0;
             var view = this.Render("DCM", "Form", "LoadMetadataOfflineVersion", new RouteValueDictionary()
             {
                 { "entityId", datasetId },
@@ -477,6 +507,7 @@ private void generateMetadataAsHtml(DatasetVersion dsv)
 
             byte[] content = Encoding.ASCII.GetBytes(view.ToString());
 
+    
             string dynamicPathOfMD = "";
             dynamicPathOfMD = storeGeneratedFilePathToContentDiscriptor(datasetId, dsv,
                 "metadata", ".html");
@@ -493,7 +524,7 @@ private void generateDataStructureHtml(DatasetVersion dsv)
             });
 
             byte[] content = Encoding.ASCII.GetBytes(view.ToString());
-
+       
             string dynamicPathOfMD = "";
             dynamicPathOfMD = storeGeneratedFilePathToContentDiscriptor(dsv.Dataset.Id, dsv,
                 "datastructure", ".html");