System: Created a general basename cleanup function, and applied that when creating filenames from userdescription etc. Related to #1054 preparations

ApplicationCode/Application/RiaApplication.cpp

@@ -2086,7 +2086,7 @@ void RiaApplication::saveSnapshotForAllViews(const QString& snapshotFolderName)
                 viewer->repaint();
 
                 QString fileName = cas->caseUserDescription() + "-" + riv->name();
-                fileName.replace(" ", "_");
+                fileName = caf::Utils::makeValidFileBasename(fileName);
 
                 QString absoluteFileName = caf::Utils::constructFullFileName(absSnapshotPath, fileName, ".png");
                 

ApplicationCode/Commands/RicExportFaultsFeature.cpp

@@ -30,6 +30,7 @@
 #include "RigMainGrid.h"
 #include "RigCaseData.h"
 #include "QMessageBox"
+#include "cafUtils.h"
 
 CAF_CMD_SOURCE_INIT(RicExportFaultsFeature, "RicExportFaultsFeature");
 
@@ -79,7 +80,7 @@ void RicExportFaultsFeature::onActionTriggered(bool isChecked)
         if ( faultName == RimDefines::undefinedGridFaultWithInactiveName() ) faultName = "UNDEF_IA";
 
         QString baseFilename = "Fault_" + faultName + "_" + caseName;
-        baseFilename.replace(" ", "_");
+        baseFilename = caf::Utils::makeValidFileBasename(baseFilename);
 
         QString completeFilename = selectedDir + "/" + baseFilename + ".grdecl";
 

ApplicationCode/Commands/RicExportMultipleSnapshotsFeature.cpp

@@ -214,6 +214,7 @@ void RicExportMultipleSnapshotsFeature::exportViewVariationsToFolder(RimView* ri
 
     QString resName = resultName(rimView);
     QString viewCaseResultString = rimCase->caseUserDescription() + "_" + rimView->name() + "_" + resName;
+    viewCaseResultString = caf::Utils::makeValidFileBasename(viewCaseResultString);
 
     for (int i = msd->timeStepStart(); i <= msd->timeStepEnd(); i++)
     {
@@ -235,7 +236,6 @@ void RicExportMultipleSnapshotsFeature::exportViewVariationsToFolder(RimView* ri
         if (msd->sliceDirection == RimMultiSnapshotDefinition::NO_RANGEFILTER)
         {
             QString fileName = viewCaseResultString + "_" + timeStepString;
-            fileName.replace(" ", "-");
             QString absoluteFileName = caf::Utils::constructFullFileName(folder, fileName, ".png");
 
             RicSnapshotViewToFileFeature::saveSnapshotAs(absoluteFileName, rimView);
@@ -252,7 +252,6 @@ void RicExportMultipleSnapshotsFeature::exportViewVariationsToFolder(RimView* ri
             {
                 QString rangeFilterString = msd->sliceDirection().text() + "-" + QString::number(i);
                 QString fileName = viewCaseResultString + "_" + timeStepString + "_" + rangeFilterString;
-                fileName.replace(" ", "-");
 
                 rangeFilter->setDefaultValues();
                 if (msd->sliceDirection == RimMultiSnapshotDefinition::RANGEFILTER_I)
@@ -293,7 +292,7 @@ QString RicExportMultipleSnapshotsFeature::resultName(RimView* rimView)
     if (dynamic_cast<RimEclipseView*>(rimView))
     {
         RimEclipseView* eclView = dynamic_cast<RimEclipseView*>(rimView);
-
+        
         return eclView->cellResult()->resultVariable();
     }
     else if (dynamic_cast<RimGeoMechView*>(rimView))

ApplicationCode/Commands/RicSnapshotViewToClipboardFeature.cpp

@@ -208,7 +208,7 @@ void RicSnapshotAllPlotsToFileFeature::createSnapshotOfAllPlotsInFolder(QString
             if (wellLogPlot && wellLogPlot->viewWidget())
             {
                 QString fileName = wellLogPlot->description();
-                fileName.replace(" ", "_");
+                fileName = caf::Utils::makeValidFileBasename(fileName);
 
                 QString absoluteFileName = caf::Utils::constructFullFileName(absSnapshotPath, fileName, ".png");
 
@@ -226,7 +226,7 @@ void RicSnapshotAllPlotsToFileFeature::createSnapshotOfAllPlotsInFolder(QString
             if (summaryPlot && summaryPlot->viewWidget())
             {
                 QString fileName = summaryPlot->description();
-                fileName.replace(" ", "_");
+                fileName = caf::Utils::makeValidFileBasename(fileName);
 
                 QString absoluteFileName = caf::Utils::constructFullFileName(absSnapshotPath, fileName, ".png");
 

ApplicationCode/ReservoirDataModel/RigLasFileExporter.cpp

@@ -24,6 +24,7 @@
 #include "RimWellLogCurve.h"
 #include "RimWellLogExtractionCurve.h"
 
+#include "cafUtils.h"
 #include "cvfAssert.h"
 
 #include "laswell.hpp"
@@ -146,41 +147,34 @@ public:
 
     std::string generateFilename() const
     {
-        QString f;
+        QString fileBasenameCandidate;
         QString separator("-");
 
         if (!m_wellName.isEmpty())
         {
-            f += m_wellName;
+            fileBasenameCandidate += m_wellName;
         }
 
         if (!m_caseName.isEmpty())
         {
-            if (!f.isEmpty()) f += separator;
+            if (!fileBasenameCandidate.isEmpty()) fileBasenameCandidate += separator;
-            f += m_caseName;
+            fileBasenameCandidate += m_caseName;
         }
 
         // Add property name if only one curve is exported
         if (m_logCurveData.size() == 1)
         {
-            if (!f.isEmpty()) f += separator;
+            if (!fileBasenameCandidate.isEmpty()) fileBasenameCandidate += separator;
-            f += QString::fromStdString(m_logCurveData[0].channelName());
+            fileBasenameCandidate += QString::fromStdString(m_logCurveData[0].channelName());
         }
 
         if (!m_date.isEmpty())
         {
-            if (!f.isEmpty()) f += separator;
+            if (!fileBasenameCandidate.isEmpty()) fileBasenameCandidate += separator;
-            f += m_date;
+            fileBasenameCandidate += m_date;
         }
 
-        QString cleanFileName = f.trimmed();
+        QString cleanFileName = caf::Utils::makeValidFileBasename( fileBasenameCandidate);
-        cleanFileName.replace(".", "_");
-        cleanFileName.replace(",", "_");
-        cleanFileName.replace(":", "_");
-        cleanFileName.replace(";", "_");
-        cleanFileName.replace(" ", "_");
-        cleanFileName.replace("/", "_");
-        cleanFileName.replace(QRegExp("_+"), "_");
 
         cleanFileName += ".las";
 

Fwk/AppFwk/CommonCode/cafUtils.cpp

@@ -121,6 +121,32 @@ QString Utils::constructFullFileName(const QString& folder, const QString& baseF
 }
 
 
+//--------------------------------------------------------------------------------------------------
+/// 
+//--------------------------------------------------------------------------------------------------
+QString Utils::makeValidFileBasename(const QString& fileBasenameCandidate)
+{
+    QString cleanBasename = fileBasenameCandidate.trimmed();
+    cleanBasename.replace(".", "_");
+    cleanBasename.replace(",", "_");
+    cleanBasename.replace(":", "_");
+    cleanBasename.replace(";", "_");
+    cleanBasename.replace(" ", "_");
+    cleanBasename.replace("/", "_");
+    cleanBasename.replace("\\", "_");
+    cleanBasename.replace("<", "_");
+    cleanBasename.replace(">", "_");
+    cleanBasename.replace("\"", "_");
+    cleanBasename.replace("|", "_");
+    cleanBasename.replace("?", "_");
+    cleanBasename.replace("*", "_");
+
+
+    cleanBasename.replace(QRegExp("_+"), "_");
+
+    return cleanBasename;  
+}
+
 //--------------------------------------------------------------------------------------------------
 /// 
 //--------------------------------------------------------------------------------------------------

Fwk/AppFwk/CommonCode/cafUtils.h

@@ -56,6 +56,7 @@ public:
     static QString      absoluteFileName(const QString& fileName);
     static QStringList  getFilesInDirectory(const QString& dirPath, const QString& filter, bool getAbsoluteFileNames);
     static QString      constructFullFileName(const QString& folder, const QString& baseFileName, const QString& extension);
+    static QString      makeValidFileBasename(const QString& fileBasenameCandidate);
 
     static QString      indentString(int numSpacesToIndent, const QString& str);