ENH: Stream DCMTK logging per each job to the job list UI

This enhancement streams the DCMTK logging for each individual job directly to the Job List User Interface.
This improves visibility and accessibility of log information for each job, aiding in debugging and monitoring job performance.

Libs/Core/ctkAbstractJob.cpp

@@ -45,12 +45,6 @@ ctkAbstractJob::~ctkAbstractJob()
 {
 }
 
-//----------------------------------------------------------------------------
-void ctkAbstractJob::setJobUID(const QString &jobUID)
-{
-  this->JobUID = jobUID;
-}
-
 //----------------------------------------------------------------------------
 QString ctkAbstractJob::className() const
 {
@@ -67,6 +61,12 @@ QString ctkAbstractJob::jobUID() const
   return this->JobUID;
 }
 
+//----------------------------------------------------------------------------
+void ctkAbstractJob::setJobUID(const QString &jobUID)
+{
+  this->JobUID = jobUID;
+}
+
 //----------------------------------------------------------------------------
 ctkAbstractJob::JobStatus ctkAbstractJob::status() const
 {
@@ -199,6 +199,35 @@ QDateTime ctkAbstractJob::completionDateTime() const
   return this->CompletionDateTime;
 }
 
+//----------------------------------------------------------------------------
+QString ctkAbstractJob::runningThreadID() const
+{
+  return this->RunningThreadID;
+}
+
+//----------------------------------------------------------------------------
+void ctkAbstractJob::setRunningThreadID(QString runningThreadID)
+{
+  this->RunningThreadID = runningThreadID;
+}
+
+//----------------------------------------------------------------------------
+QString ctkAbstractJob::loggedText() const
+{
+  return this->LoggedText;
+}
+
+//----------------------------------------------------------------------------
+void ctkAbstractJob::setLoggedText(QString loggedText)
+{
+  if (loggedText.isEmpty())
+  {
+    return;
+  }
+
+  this->LoggedText += loggedText;
+}
+
 //----------------------------------------------------------------------------
 QVariant ctkAbstractJob::toVariant()
 {

Libs/Core/ctkAbstractJob.h

@@ -54,6 +54,8 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   Q_PROPERTY(QDateTime creationDateTime READ creationDateTime);
   Q_PROPERTY(QDateTime startDateTime READ startDateTime);
   Q_PROPERTY(QDateTime completionDateTime READ completionDateTime);
+  Q_PROPERTY(QString runningThreadID READ runningThreadID WRITE setRunningThreadID);
+  Q_PROPERTY(QString loggedText READ loggedText WRITE setLoggedText);
 
 public:
   explicit ctkAbstractJob();
@@ -133,20 +135,32 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   ///@}
 
   ///@{
-  /// CreationDateTime
+  /// Creation Date Time
   QDateTime creationDateTime() const;
   ///@}
 
   ///@{
-  /// StartDateTime
+  /// Start Date Time
   QDateTime startDateTime() const;
   ///@}
 
   ///@{
-  /// CompletionDateTime
+  /// Completion Date Time
   QDateTime completionDateTime() const;
   ///@}
 
+  ///@{
+  /// Running ThreadID
+  QString runningThreadID() const;
+  void setRunningThreadID(QString runningThreadID);
+  ///@}
+
+  ///@{
+  /// Logged Text
+  QString loggedText() const;
+  void setLoggedText(QString loggedText);
+  ///@}
+
   /// Generate worker for job
   Q_INVOKABLE virtual ctkAbstractWorker* createWorker() = 0;
 
@@ -182,6 +196,8 @@ class CTK_CORE_EXPORT ctkAbstractJob : public QObject
   QDateTime CreationDateTime;
   QDateTime StartDateTime;
   QDateTime CompletionDateTime;
+  QString RunningThreadID;
+  QString LoggedText;
 
 private:
   Q_DISABLE_COPY(ctkAbstractJob)
@@ -198,6 +214,8 @@ struct CTK_CORE_EXPORT ctkJobDetail {
     this->CreationDateTime = job.creationDateTime().toString("HH:mm:ss.zzz ddd dd MMM yyyy");
     this->StartDateTime = job.startDateTime().toString("HH:mm:ss.zzz ddd dd MMM yyyy");
     this->CompletionDateTime = job.completionDateTime().toString("HH:mm:ss.zzz ddd dd MMM yyyy");
+    this->RunningThreadID = job.runningThreadID();
+    this->Logging = job.loggedText();
   }
   virtual ~ctkJobDetail() = default;
 
@@ -206,6 +224,8 @@ struct CTK_CORE_EXPORT ctkJobDetail {
   QString CreationDateTime;
   QString StartDateTime;
   QString CompletionDateTime;
+  QString RunningThreadID;
+  QString Logging;
 };
 Q_DECLARE_METATYPE(ctkJobDetail);
 

Libs/Core/ctkJobScheduler.h

@@ -40,6 +40,9 @@ class ctkJobSchedulerPrivate;
 class CTK_CORE_EXPORT ctkJobScheduler : public QObject
 {
   Q_OBJECT
+  Q_PROPERTY(int numberOfJobs READ numberOfJobs);
+  Q_PROPERTY(int numberOfPersistentJobs READ numberOfPersistentJobs);
+  Q_PROPERTY(int numberOfRunningJobs READ numberOfRunningJobs);
   Q_PROPERTY(int freezeJobsScheduling READ freezeJobsScheduling WRITE setFreezeJobsScheduling);
   Q_PROPERTY(int maximumThreadCount READ maximumThreadCount WRITE setMaximumThreadCount);
   Q_PROPERTY(int maximumNumberOfRetry READ maximumNumberOfRetry WRITE setMaximumNumberOfRetry);
@@ -52,22 +55,17 @@ class CTK_CORE_EXPORT ctkJobScheduler : public QObject
 
   ///@{
   /// Jobs managment
-  Q_INVOKABLE int numberOfJobs();
-  Q_INVOKABLE int numberOfPersistentJobs();
-  Q_INVOKABLE int numberOfRunningJobs();
-
+  int numberOfJobs();
+  int numberOfPersistentJobs();
+  int numberOfRunningJobs();
   Q_INVOKABLE void addJob(ctkAbstractJob* job);
-
   Q_INVOKABLE virtual void deleteJob(const QString& jobUID);
   Q_INVOKABLE virtual void deleteWorker(const QString& jobUID);
-
   QSharedPointer<ctkAbstractJob> getJobSharedByUID(const QString& jobUID);
   Q_INVOKABLE ctkAbstractJob* getJobByUID(const QString& jobUID);
-
   Q_INVOKABLE void waitForFinish(bool waitForPersistentJobs = false,
                                  bool processEvents = false);
   Q_INVOKABLE void waitForDone(int msec = -1);
-
   Q_INVOKABLE void stopAllJobs(bool stopPersistentJobs = false);
   Q_INVOKABLE void stopJobsByJobUIDs(const QStringList& jobUIDs);
   ///@}

Libs/DICOM/Core/Testing/Cpp/ctkDICOMSchedulerTest1.cpp

@@ -137,8 +137,6 @@ int ctkDICOMSchedulerTest1(int argc, char* argv[])
   QStringList urls = database.urlsForSeries(seriesIstanceUID);
   urls.removeAll(QString(""));
 
-
-
   CHECK_INT(instances.count(), numberOfImages);
   CHECK_INT(files.count(), 0);
   CHECK_INT(urls.count(), numberOfImages);

Libs/DICOM/Core/ctkDICOMInserterWorker.cpp

@@ -32,6 +32,9 @@
 #include "ctkDICOMInserterWorker_p.h"
 #include "ctkDICOMJobResponseSet.h"
 
+// DCMTK includes
+#include <dcmtk/oflog/spi/logevent.h>
+
 static ctkLogger logger ("org.commontk.dicom.DICOMInserterWorker");
 
 //------------------------------------------------------------------------------
@@ -100,6 +103,9 @@ void ctkDICOMInserterWorker::run()
     return;
   }
 
+  QString currentThread = dcmtk::log4cplus::thread::getCurrentThreadName().c_str();
+  inserterJob->setRunningThreadID(currentThread);
+
   if (d->Inserter->wasCanceled())
   {
     this->onJobCanceled(d->Inserter->wasCanceled());

Libs/DICOM/Core/ctkDICOMJob.h

@@ -140,7 +140,6 @@ struct CTK_DICOM_CORE_EXPORT ctkDICOMJobDetail : ctkJobDetail
 
   explicit ctkDICOMJobDetail(const ctkDICOMJob& job) : ctkJobDetail(job)
   {
-
     this->DICOMLevel = job.dicomLevel();
     this->JobType = job.getJobType();
     this->PatientID = job.patientID();

Libs/DICOM/Core/ctkDICOMJobResponseSet.cpp

@@ -57,6 +57,7 @@ class ctkDICOMJobResponseSetPrivate : public QObject
   QString SeriesInstanceUID;
   QString SOPInstanceUID;
   QString ConnectionName;
+  QString RunningThreadID;
   QMap<QString, QSharedPointer<ctkDICOMItem>> Datasets;
 };
 

Libs/DICOM/Core/ctkDICOMQueryWorker.cpp

@@ -30,6 +30,9 @@
 #include "ctkDICOMScheduler.h"
 #include "ctkDICOMServer.h"
 
+// DCMTK includes
+#include <dcmtk/oflog/spi/logevent.h>
+
 static ctkLogger logger ("org.commontk.dicom.DICOMQueryWorker");
 
 //------------------------------------------------------------------------------
@@ -109,6 +112,9 @@ void ctkDICOMQueryWorker::run()
     return;
   }
 
+  QString currentThread = dcmtk::log4cplus::thread::getCurrentThreadName().c_str();
+  queryJob->setRunningThreadID(currentThread);
+
   QSharedPointer<ctkDICOMScheduler> scheduler =
     qobject_cast<QSharedPointer<ctkDICOMScheduler>>(this->Scheduler);
   if (!scheduler ||

Libs/DICOM/Core/ctkDICOMRetrieveWorker.cpp

@@ -31,6 +31,9 @@
 #include "ctkDICOMScheduler.h"
 #include "ctkDICOMServer.h"
 
+// DCMTK includes
+#include <dcmtk/oflog/spi/logevent.h>
+
 static ctkLogger logger ("org.commontk.dicom.DICOMRetrieveWorker");
 
 //------------------------------------------------------------------------------
@@ -129,6 +132,9 @@ void ctkDICOMRetrieveWorker::run()
     return;
   }
 
+  QString currentThread = dcmtk::log4cplus::thread::getCurrentThreadName().c_str();
+  retrieveJob->setRunningThreadID(currentThread);
+
   QSharedPointer<ctkDICOMScheduler> scheduler =
       qSharedPointerObjectCast<ctkDICOMScheduler>(this->Scheduler);
   ctkDICOMServer* server = retrieveJob->server();