Update the OSCAR data zip to use the live debug log instead of creating one.

Also fix the logger so that messages are logged immediately rather than once
per second.

oscar/logger.cpp

@@ -48,8 +48,9 @@ void MyOutputHandler(QtMsgType type, const QMessageLogContext &context, const QS
 
     if (logger && logger->isRunning()) {
         logger->append(msg);
-    }
+    } else {
         fprintf(stderr, "%s\n", msg.toLocal8Bit().constData());
+    }
 
     if (type == QtFatalMsg) {
         abort();
@@ -81,12 +82,18 @@ void LogThread::connectionReady()
 {
     strlock.lock();
     connected = true;
+    logTrigger.wakeAll();
     strlock.unlock();
     qDebug() << "Logging UI initialized";
 }
 
 void LogThread::logToFile()
 {
+    if (m_logStream) {
+        qWarning().noquote() << "Already logging to" << m_logFile->fileName();
+        return;
+    }
+
     QString debugLog = GetLogDir() + "/debug.txt";
     rotateLogs(debugLog);  // keep a limited set of previous logs
     
@@ -96,6 +103,7 @@ void LogThread::logToFile()
     if (m_logFile->open(QFile::ReadWrite | QFile::Text)) {
         m_logStream = new QTextStream(m_logFile);
     }
+    logTrigger.wakeAll();
     strlock.unlock();
     if (m_logStream) {
         qDebug().noquote() << "Logging to" << debugLog;
@@ -104,6 +112,14 @@ void LogThread::logToFile()
     }
 }
 
+QString LogThread::logFileName()
+{
+    if (!m_logFile) {
+        return "";
+    }
+    return m_logFile->fileName();
+}
+
 void shutdownLogger()
 {
     if (logger) {
@@ -119,16 +135,15 @@ LogThread * logger = NULL;
 void LogThread::append(QString msg)
 {
     QString tmp = QString("%1: %2").arg(logtime.elapsed(), 5, 10, QChar('0')).arg(msg);
-    //QStringList appears not to be threadsafe
-    strlock.lock();
-    buffer.append(tmp);
-    strlock.unlock();
+    appendClean(tmp);
 }
 
 void LogThread::appendClean(QString msg)
 {
+    fprintf(stderr, "%s\n", msg.toLocal8Bit().constData());
     strlock.lock();
     buffer.append(msg);
+    logTrigger.wakeAll();
     strlock.unlock();
 }
 
@@ -160,8 +175,7 @@ void LogThread::run()
     s_LoggerRunning.unlock();  // unlock as soon as the thread begins to run
     do {
         strlock.lock();
-        //int r = receivers(SIGNAL(outputLog(QString())));
-        // Wait to flush the buffer until the UI is connected and the log file has been opened.
+        logTrigger.wait(&strlock);
         while (connected && m_logFile && !buffer.isEmpty()) {
             QString msg = buffer.takeFirst();
             if (m_logStream) {
@@ -170,7 +184,6 @@ void LogThread::run()
             emit outputLog(msg);
         }
         strlock.unlock();
-        QThread::msleep(1000);
     } while (running);
 }
 

oscar/logger.h

@@ -5,6 +5,7 @@
 #include <QRunnable>
 #include <QThreadPool>
 #include <QMutex>
+#include <QWaitCondition>
 #include <QTime>
 
 void initializeLogger();
@@ -29,6 +30,7 @@ public:
     bool isRunning() { return running; }
     void connectionReady();
     void logToFile();
+    QString logFileName();
 
     void quit();
 
@@ -43,6 +45,7 @@ protected:
     bool connected;
     class QFile* m_logFile;
     class QTextStream* m_logStream;
+    QWaitCondition logTrigger;
 };
 
 extern LogThread * logger;

oscar/mainwindow.cpp

@@ -2682,7 +2682,7 @@ void MainWindow::on_actionCreate_Card_zip_triggered()
                 infostr = datacard.loader->loaderName();
             }
             prefix = infostr;
-            folder += QDir::separator() + infostr + ".zip";
+            folder += "/" + infostr + ".zip";
 
             filename = QFileDialog::getSaveFileName(this, tr("Choose where to save zip"), folder, tr("ZIP files (*.zip)"));
 
@@ -2734,7 +2734,7 @@ void MainWindow::on_actionCreate_OSCAR_Data_zip_triggered()
     // Note: macOS ignores this and points to OSCAR's most recently used directory for saving.
     folder = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
 
-    folder += QDir::separator() + STR_AppData + ".zip";
+    folder += "/" + STR_AppData + ".zip";
 
     QString filename = QFileDialog::getSaveFileName(this, tr("Choose where to save zip"), folder, tr("ZIP files (*.zip)"));
 
@@ -2749,7 +2749,6 @@ void MainWindow::on_actionCreate_OSCAR_Data_zip_triggered()
     qDebug() << "Create zip of OSCAR data folder:" << filename;
 
     QDir oscarData(GetAppData());
-    QFile debugLog(oscarData.canonicalPath() + QDir::separator() + "debuglog.txt");
 
     ZipFile z;
     bool ok = z.Open(filename);
@@ -2759,29 +2758,22 @@ void MainWindow::on_actionCreate_OSCAR_Data_zip_triggered()
         prog->setWindowModality(Qt::ApplicationModal);
         prog->open();
 
-        // Build the list of files and exclude any existing debug log.
+        // Build the list of files.
         FileQueue files;
         files.AddDirectory(oscarData.canonicalPath(), oscarData.dirName());
-        files.Remove(debugLog.fileName());
+
+        // Defer the current debug log to the end.
+        QString debugLog = logger->logFileName();
+        QString debugLogZipName;
+        int exists = files.Remove(debugLog, &debugLogZipName);
+        if (exists) {
+            files.AddFile(debugLog, debugLogZipName);
+        }
 
         prog->setMessage(tr("Creating zip..."));
 
         // Create the zip.
         ok = z.AddFiles(files, prog);
-        if (ok && z.aborted() == false) {
-            // Update the debug log and add it last.
-            ok = debugLog.open(QIODevice::WriteOnly);
-            if (ok) {
-                debugLog.write(ui->logText->toPlainText().toLocal8Bit().data());
-                debugLog.close();
-                QString debugLogName = oscarData.dirName() + "/" + QFileInfo(debugLog).fileName();
-                ok = z.AddFile(debugLog.fileName(), debugLogName);
-                if (!ok) {
-                    qWarning() << "Unable to add debug log to zip!";
-                }
-            }
-        }
-
         z.Close();
     } else {
         qWarning() << "Unable to open" << filename;

oscar/zip.cpp

@@ -225,7 +225,7 @@ bool FileQueue::AddFile(const QString & path, const QString & prefix)
     return true;
 }
 
-int FileQueue::Remove(const QString & path)
+int FileQueue::Remove(const QString & path, QString* outName)
 {
     QFileInfo fi(path);
     QString canonicalPath = fi.canonicalFilePath();
@@ -235,6 +235,13 @@ int FileQueue::Remove(const QString & path)
     while (i.hasNext()) {
         Entry & entry = i.next();
         if (entry.path == canonicalPath) {
+            if (outName) {
+                // If the caller cares about the name, it will most likely be re-added later rather than skipped.
+                *outName = entry.name;
+            } else {
+                qDebug().noquote() << "skipping file:" << path;
+            }
+
             if (fi.isDir()) {
                 m_dir_count--;
             } else {
@@ -243,10 +250,12 @@ int FileQueue::Remove(const QString & path)
             }
             i.remove();
             removed++;
-            qDebug().noquote() << "skipping file:" << path;
         }
     }
     
+    if (removed > 1) {
+        qWarning().noquote() << removed << "copies found in zip queue:" << path;
+    }
     return removed;
 }
 

oscar/zip.h

@@ -63,7 +63,7 @@ public:
     ~FileQueue() = default;
 
     //!brief Remove a file from the queue, return the number of instances removed.
-    int Remove(const QString & path);
+    int Remove(const QString & path, QString* outName=nullptr);
     
     //!brief Recursively add a directory and its contents to the queue along with the prefix to be used in an archive.
     bool AddDirectory(const QString & path, const QString & prefix="");