Better error messages when CSV import fails due to an unexpected EOF

MKleusberg · MKleusberg · commit f75a35877e53 · 2020-07-17T22:45:33.000+02:00
When the CSV import fails because of an unexpected end of file show a better error message. When the file ends but we are still expected more data to come, i.e. we are still in quote mode, no INSERT statement failed. So showing the last SQLite error message will never show you a proper error message. Instead tell the user that their settings might be wrong or the file malformed. See issue #2330.
diff --git a/src/ImportCsvDialog.cpp b/src/ImportCsvDialog.cpp
@@ -674,17 +674,19 @@ bool ImportCsvDialog::importCsv(const QString& fileName, const QString& name)
         // Some error occurred or the user cancelled the action
 
         // Rollback the entire import. If the action was cancelled, don't show an error message. If it errored, show an error message.
-        if(result == CSVParser::ParserResult::ParserResultCancelled)
+        QString message;
+        if(result == CSVParser::ParserResult::ParserResultError)
         {
-            sqlite3_finalize(stmt);
-            rollback(this, pdb, &pDb, restorepointName, 0, QString());
-            return false;
-        } else {
             QString error(sqlite3_errmsg(pDb.get()));
-            sqlite3_finalize(stmt);
-            rollback(this, pdb, &pDb, restorepointName, lastRowNum, tr("Inserting row failed: %1").arg(error));
-            return false;
+            message = tr("Inserting row failed: %1").arg(error);
+        } else if(result == CSVParser::ParserResult::ParserResultUnexpectedEOF) {
+            message = tr("Unexpected end of file. Please make sure that you have configured the correct quote characters and "
+                         "the file is not malformed.");
         }
+
+        sqlite3_finalize(stmt);
+        rollback(this, pdb, &pDb, restorepointName, lastRowNum, message);
+        return false;
     }
 
     // Clean up prepared statement
diff --git a/src/csvparser.cpp b/src/csvparser.cpp
@@ -294,7 +294,7 @@ CSVParser::ParserResult CSVParser::parse(csvRowFunction insertFunction, QTextStr
 
     // Check if we are in StateNormal or StateEndQuote state. The first is what we should be in for unquoted data and all files which
     // end with a line break. The latter is what we are in for quoted data with no final line break.
-    return (state == StateNormal || state == StateEndQuote) ? ParserResult::ParserResultSuccess : ParserResult::ParserResultError;
+    return (state == StateNormal || state == StateEndQuote) ? ParserResult::ParserResultSuccess : ParserResult::ParserResultUnexpectedEOF;
 }
 
 bool CSVParser::look_ahead(QTextStream& stream, QByteArray& sBuffer, const char** it, const char** sBufferEnd, char expected)
diff --git a/src/csvparser.h b/src/csvparser.h
@@ -60,7 +60,8 @@ class CSVParser
     {
         ParserResultSuccess,
         ParserResultCancelled,
-        ParserResultError
+        ParserResultError,
+        ParserResultUnexpectedEOF
     };
 
     /*!

Original file line number	Diff line number	Diff line change
`@@ -294,7 +294,7 @@ CSVParser::ParserResult CSVParser::parse(csvRowFunction insertFunction, QTextStr`
`294`	`294`
`295`	`295`	`// Check if we are in StateNormal or StateEndQuote state. The first is what we should be in for unquoted data and all files which`
`296`	`296`	`// end with a line break. The latter is what we are in for quoted data with no final line break.`
`297`		`- return (state == StateNormal \|\| state == StateEndQuote) ? ParserResult::ParserResultSuccess : ParserResult::ParserResultError;`
	`297`	`+ return (state == StateNormal \|\| state == StateEndQuote) ? ParserResult::ParserResultSuccess : ParserResult::ParserResultUnexpectedEOF;`
`298`	`298`	`}`
`299`	`299`
`300`	`300`	`bool CSVParser::look_ahead(QTextStream& stream, QByteArray& sBuffer, const char it, const char sBufferEnd, char expected)`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,8 @@ class CSVParser`
`60`	`60`	`{`
`61`	`61`	`ParserResultSuccess,`
`62`	`62`	`ParserResultCancelled,`
`63`		`- ParserResultError`
	`63`	`+ ParserResultError,`
	`64`	`+ ParserResultUnexpectedEOF`
`64`	`65`	`};`
`65`	`66`
`66`	`67`	`/*!`