Merge pull request #614 from AndreasFetzer/xnat-session-timeout-handling

Xnat session timeout handling

Applications/ctkXnatTreeBrowser/ctkXnatTreeBrowserMainWindow.cpp

@@ -44,6 +44,10 @@
 #include <QFileDialog>
 #include <QFileInfo>
 
+#include <QMessageBox>
+#include <QDateTime>
+#include <QTimer>
+
 ctkXnatTreeBrowserMainWindow::ctkXnatTreeBrowserMainWindow(QWidget *parent) :
   QMainWindow(parent),
   ui(new Ui::ctkXnatTreeBrowserMainWindow),
@@ -54,6 +58,7 @@ ctkXnatTreeBrowserMainWindow::ctkXnatTreeBrowserMainWindow(QWidget *parent) :
 
   ui->treeView->setModel(m_TreeModel);
   ui->downloadLabel->hide();
+  ui->treeView->setHeaderHidden(true);
 
   this->connect(ui->loginButton, SIGNAL(clicked()), SLOT(loginButtonPushed()));
   this->connect(ui->treeView, SIGNAL(clicked(const QModelIndex&)), SLOT(itemSelected(const QModelIndex&)));
@@ -96,6 +101,8 @@ void ctkXnatTreeBrowserMainWindow::loginButtonPushed()
       {
         ui->loginButton->setText("Logout");
         ui->loginLabel->setText(QString("Connected: %1").arg(m_Session->url().toString()));
+        this->connect(m_Session, SIGNAL(timedOut()), this, SLOT(sessionTimedOutMsg()));
+        this->connect(m_Session, SIGNAL(aboutToTimeOut()), this, SLOT(sessionAboutToTimeOutMsg()));
 
         ctkXnatDataModel* dataModel = m_Session->dataModel();
         m_TreeModel->addDataModel(dataModel);
@@ -177,3 +184,35 @@ void ctkXnatTreeBrowserMainWindow::uploadFileClicked()
     m_TreeModel->addChildNode(index, file);
   }
 }
+
+void ctkXnatTreeBrowserMainWindow::sessionTimedOutMsg()
+{
+  ctkXnatDataModel* dataModel = m_Session->dataModel();
+  m_TreeModel->removeDataModel(dataModel);
+  ui->treeView->reset();
+  delete m_Session;
+  m_Session = 0;
+  ui->loginButton->setText("Login");
+  ui->loginLabel->setText("Disconnected");
+  ui->downloadLabel->hide();
+  QMessageBox::warning(this, "Session Timeout", "The session timed out.");
+}
+
+void ctkXnatTreeBrowserMainWindow::sessionAboutToTimeOutMsg()
+{
+  QMessageBox msgBox;
+  msgBox.setIcon(QMessageBox::Warning);
+  msgBox.setWindowTitle("Session Timeout Soon");
+  msgBox.setText("The session will time out in 1 minute.\nDo you want to renew the session?");
+  msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
+  msgBox.setDefaultButton(QMessageBox::No);
+  msgBox.show();
+  QTimer* timer = new QTimer(this);
+  timer->start(60000);
+  this->connect(timer, SIGNAL(timeout()), &msgBox, SLOT(reject()));
+  if (msgBox.exec() == QMessageBox::Yes)
+  {
+    m_Session->renew();
+  }
+  timer->stop();
+}

Applications/ctkXnatTreeBrowser/ctkXnatTreeBrowserMainWindow.h

@@ -48,6 +48,8 @@ private Q_SLOTS:
   void downloadButtonClicked();
   void addResourceClicked();
   void uploadFileClicked();
+  void sessionTimedOutMsg();
+  void sessionAboutToTimeOutMsg();
 
 private:
   Ui::ctkXnatTreeBrowserMainWindow* ui;

Libs/XNAT/Core/ctkXnatSession.cpp

@@ -37,6 +37,7 @@
 
 #include <QCryptographicHash>
 #include <QDateTime>
+#include <QTimer>
 #include <QDebug>
 #include <QDir>
 #include <QScopedPointer>
@@ -69,6 +70,16 @@ public:
 
   ctkXnatSession* q;
 
+  QTimer* timer;
+
+  // The time in milliseconds until the signal aboutToTimeOut gets emitted
+  int timeOutWarningPeriod;
+
+  // The time in milliseconds until the signal timedOut gets emitted
+  // Default XNAT session timeout setting. This value will be updated after
+  // "updateExpirationDate" is called the first time.
+  int timeOutPeriod = 60000;
+
   ctkXnatSessionPrivate(const ctkXnatLoginProfile& loginProfile, ctkXnatSession* q);
   ~ctkXnatSessionPrivate();
 
@@ -92,6 +103,7 @@ ctkXnatSessionPrivate::ctkXnatSessionPrivate(const ctkXnatLoginProfile& loginPro
   , xnat(new ctkXnatAPI())
   , defaultDownloadDir(".")
   , q(q)
+  , timer(new QTimer(q))
 {
   // TODO This is a workaround for connecting to sites with self-signed
   // certificate. Should be replaced with something more clever.
@@ -212,8 +224,10 @@ QDateTime ctkXnatSessionPrivate::updateExpirationDate(qRestResult* restResult)
           }
           QByteArray timeSpan = expirationCookie[1];
           timeSpan.chop(1);
+          this->timeOutWarningPeriod = timeSpan.toLong() - this->timeOutPeriod;
           expirationDate = expirationDate.addMSecs(timeSpan.toLong());
           sessionProperties[SESSION_EXPIRATION_DATE] = expirationDate.toString(Qt::ISODate);
+          this->timer->start(this->timeOutWarningPeriod);
           emit q->sessionRenewed(expirationDate);
         }
       }
@@ -363,6 +377,8 @@ void ctkXnatSession::open()
   QScopedPointer<qRestResult> restResult(d->xnat->takeResult(uuid));
   if (restResult)
   {
+    QObject::connect(d->timer, SIGNAL(timeout()), this, SLOT(emitTimeOut()));
+
     QString sessionId = restResult->result()["content"].toString();
     d->sessionId = sessionId;
     d->setDefaultHttpHeaders();
@@ -514,6 +530,7 @@ QUuid ctkXnatSession::httpGet(const QString& resource, const ctkXnatSession::Url
 {
   Q_D(ctkXnatSession);
   d->checkSession();
+  d->timer->start(d->timeOutWarningPeriod);
   return d->xnat->get(resource, parameters, rawHeaders);
 }
 
@@ -528,6 +545,7 @@ QList<ctkXnatObject*> ctkXnatSession::httpResults(const QUuid& uuid, const QStri
   {
     d->throwXnatException("Http request failed.");
   }
+  d->timer->start(d->timeOutWarningPeriod);
   return d->results(restResult.data(), schemaType);
 }
 
@@ -536,6 +554,7 @@ QUuid ctkXnatSession::httpPut(const QString& resource, const ctkXnatSession::Url
 {
   Q_D(ctkXnatSession);
   d->checkSession();
+  d->timer->start(d->timeOutWarningPeriod);
   return d->xnat->put(resource, parameters);
 }
 
@@ -553,7 +572,7 @@ QList<QVariantMap> ctkXnatSession::httpSync(const QUuid& uuid)
   }
   else
   {
-    d->updateExpirationDate(restResult);
+    d->updateExpirationDate(restResult); // restarts session timer as well
     result = restResult->results();
   }
   return result;
@@ -564,6 +583,7 @@ const QMap<QByteArray, QByteArray> ctkXnatSession::httpHeadSync(const QUuid &uui
 {
   Q_D(ctkXnatSession);
   QScopedPointer<qRestResult> result (d->xnat->takeResult(uuid));
+  d->timer->start(d->timeOutWarningPeriod);
   if (result == NULL)
   {
     d->throwXnatException("Sending HEAD request failed.");
@@ -576,6 +596,7 @@ QUuid ctkXnatSession::httpHead(const QString& resourceUri)
 {
   Q_D(ctkXnatSession);
   QUuid queryId = d->xnat->head(resourceUri);
+  d->timer->start(d->timeOutWarningPeriod);
   return queryId;
 }
 
@@ -586,6 +607,7 @@ bool ctkXnatSession::exists(const ctkXnatObject* object)
 
   QString query = object->resourceUri();
   bool success = d->xnat->sync(d->xnat->get(query));
+  d->timer->start(d->timeOutWarningPeriod);
 
   return success;
 }
@@ -597,6 +619,7 @@ void ctkXnatSession::remove(ctkXnatObject* object)
 
   QString query = object->resourceUri();
   bool success = d->xnat->sync(d->xnat->del(query));
+  d->timer->start(d->timeOutWarningPeriod);
 
   if (!success)
   {
@@ -614,6 +637,7 @@ void ctkXnatSession::download(const QString& fileName,
 
   QUuid queryId = d->xnat->download(fileName, resource, parameters, rawHeaders);
   d->xnat->sync(queryId);
+  d->timer->start(d->timeOutWarningPeriod);
 }
 
 //----------------------------------------------------------------------------
@@ -642,6 +666,8 @@ void ctkXnatSession::upload(ctkXnatFile *xnatFile,
   QUuid md5QueryID = this->httpGet(md5Query);
   QList<QVariantMap> result = this->httpSync(md5QueryID);
 
+  d->timer->start(d->timeOutWarningPeriod);
+
   QString md5ChecksumRemote ("0");
   // Newly added files are usually at the end of the catalog
   // and hence at the end of the result list.
@@ -676,6 +702,7 @@ void ctkXnatSession::upload(ctkXnatFile *xnatFile,
     {
       // Remove corrupted file from server
       xnatFile->erase();
+      d->timer->start(d->timeOutWarningPeriod);
       throw ctkXnatException("Upload failed! An error occurred during file upload.");
     }
   }
@@ -691,3 +718,20 @@ void ctkXnatSession::processResult(QUuid queryId, QList<QVariantMap> parameters)
   Q_UNUSED(queryId)
   Q_UNUSED(parameters)
 }
+
+//----------------------------------------------------------------------------
+void ctkXnatSession::emitTimeOut()
+{
+  Q_D(ctkXnatSession);
+
+  if (d->timer->interval() == d->timeOutWarningPeriod)
+  {
+    d->timer->start(d->timeOutPeriod);
+    emit aboutToTimeOut();
+  }
+  else if (d->timer->interval() == d->timeOutPeriod)
+  {
+    d->timer->stop();
+    emit timedOut();
+  }
+}

Libs/XNAT/Core/ctkXnatSession.h

@@ -272,6 +272,16 @@ public:
 
   Q_SIGNAL void progress(QUuid, double);
 
+  /**
+   * @brief Signals that the session has timed out.
+   */
+  Q_SIGNAL void timedOut();
+
+  /**
+   * @brief Signals that the session will time out in one minute.
+   */
+  Q_SIGNAL void aboutToTimeOut();
+
 public slots:
   void processResult(QUuid queryId, QList<QVariantMap> parameters);
   void onProgress(QUuid queryId, double onProgress);
@@ -282,6 +292,7 @@ protected:
 private:
   Q_DECLARE_PRIVATE(ctkXnatSession)
   Q_DISABLE_COPY(ctkXnatSession)
+  Q_SLOT void emitTimeOut();
 };
 
 #endif