Merge branch 'support-xnat-modification-time'

* support-xnat-modification-time:
  Always use brackets for if statements.
  Cleanup
  Adaptions to changes in qRestAPI
  Added support for modification time in xnat

CMakeExternals/qRestAPI.cmake

@@ -24,7 +24,7 @@ endif()
 
 if(NOT DEFINED ${proj}_DIR)
 
-  set(revision_tag "836c87dbbc")
+  set(revision_tag "5f3a03b15d")
   if(${proj}_REVISION_TAG)
     set(revision_tag ${${proj}_REVISION_TAG})
   endif()

Libs/XNAT/Core/ctkXnatObject.cpp

@@ -25,7 +25,9 @@
 #include "ctkXnatSession.h"
 #include "ctkXnatDataModel.h"
 
+#include <QDateTime>
 #include <QDebug>
+#include <QStringList>
 #include <QVariant>
 
 
@@ -103,6 +105,53 @@ QString ctkXnatObject::childDataType() const
   return "Resources";
 }
 
+QDateTime ctkXnatObject::lastModifiedTime()
+{
+  Q_D(ctkXnatObject);
+  QUuid queryId = this->session()->httpHead(this->resourceUri());
+  QMap<QByteArray, QByteArray> header = this->session()->httpHeadSync(queryId);
+  QVariant lastModifiedHeader = header.value("Last-Modified");
+  QDateTime lastModifiedTime;
+
+  if (lastModifiedHeader.isValid())
+  {
+    QStringList dateformates;
+    // In case http date formate RFC 822 ( "Sun, 06 Nov 1994 08:49:37 GMT" )
+    dateformates<<"ddd, dd MMM yyyy HH:mm:ss";
+    // In case http date formate ANSI ( "Sun Nov  6 08:49:37 1994" )
+    dateformates<<"ddd MMM  d HH:mm:ss yyyy";
+    // In case http date formate RFC 850 ( "Sunday, 06-Nov-94 08:49:37 GMT" )
+    dateformates<<"dddd, dd-MMM-yy HH:mm:ss";
+
+    QString dateText = lastModifiedHeader.toString();
+    // Remove "GMT" addition at the end of the http timestamp
+    if (dateText.indexOf("GMT") != -1)
+    {
+      dateText = dateText.left(dateText.length()-4);
+    }
+
+    foreach (QString format, dateformates)
+    {
+      lastModifiedTime = QDateTime::fromString(dateText, format);
+      if (lastModifiedTime.isValid())
+        break;
+    }
+  }
+
+  if (lastModifiedTime.isValid() && d->lastModifiedTime < lastModifiedTime)
+    this->setLastModifiedTime(lastModifiedTime);
+  return lastModifiedTime;
+}
+
+void ctkXnatObject::setLastModifiedTime(const QDateTime &lastModifiedTime)
+{
+  Q_D(ctkXnatObject);
+  if (d->lastModifiedTime < lastModifiedTime)
+  {
+    d->lastModifiedTime = lastModifiedTime;
+  }
+}
+
 //----------------------------------------------------------------------------
 QString ctkXnatObject::property(const QString& name) const
 {

Libs/XNAT/Core/ctkXnatObject.h

@@ -76,6 +76,12 @@ public:
   /// Sets the value of the property with the given name.
   void setProperty(const QString& name, const QVariant& value);
 
+  /// Gets the last modification time from the server
+  QDateTime lastModifiedTime();
+
+  /// Sets the last modfication time on the server
+  void setLastModifiedTime(const QDateTime& lastModifiedTime);
+
   /// Gets the properties of the object.
   const QMap<QString, QString>& properties() const;
 

Libs/XNAT/Core/ctkXnatObjectPrivate.h

@@ -22,6 +22,7 @@
 #ifndef CTKXNATOBJECTPRIVATE_H
 #define CTKXNATOBJECTPRIVATE_H
 
+#include <QDateTime>
 #include <QMap>
 #include <QString>
 
@@ -48,6 +49,8 @@ private:
 
   QList<ctkXnatObject*> children;
 
+  QDateTime lastModifiedTime;
+
   bool fetched;
 
   ctkXnatObject* parent;

Libs/XNAT/Core/ctkXnatSession.cpp

@@ -37,11 +37,11 @@
 #include "ctkXnatSubject.h"
 #include "ctkXnatDefaultSchemaTypes.h"
 
+#include <QDateTime>
 #include <QDebug>
 #include <QScopedPointer>
 #include <QStringBuilder>
 #include <QNetworkCookie>
-#include <QDateTime>
 
 #include <ctkXnatAPI_p.h>
 #include <qRestResult.h>
@@ -285,6 +285,17 @@ QList<ctkXnatObject*> ctkXnatSessionPrivate::results(qRestResult* restResult, QS
       object->setProperty(it.key().toLatin1().data(), it.value());
     }
 
+    QVariant lastModifiedHeader = restResult->rawHeader("Last-Modified");
+    QDateTime lastModifiedTime;
+    if (lastModifiedHeader.isValid())
+    {
+      lastModifiedTime = lastModifiedHeader.toDateTime();
+    }
+    if (lastModifiedTime.isValid())
+    {
+      object->setLastModifiedTime(lastModifiedTime);
+    }
+
     results.push_back(object);
   }
   return results;
@@ -503,6 +514,26 @@ bool ctkXnatSession::exists(const ctkXnatObject* object)
 }
 
 //----------------------------------------------------------------------------
+const QMap<QByteArray, QByteArray> ctkXnatSession::httpHeadSync(const QUuid &uuid)
+{
+  Q_D(ctkXnatSession);
+  QScopedPointer<qRestResult> result (d->xnat->takeResult(uuid));
+  if (result == NULL)
+  {
+    d->throwXnatException("Sending HEAD request failed.");
+  }
+  return result->rawHeaders();
+}
+
+//----------------------------------------------------------------------------
+QUuid ctkXnatSession::httpHead(const QString& resourceUri)
+{
+  Q_D(ctkXnatSession);
+  QUuid queryId = d->xnat->head(resourceUri);
+  return queryId;
+}
+
+//----------------------------------------------------------------------------
 void ctkXnatSession::save(ctkXnatObject* object)
 {
   Q_D(ctkXnatSession);

Libs/XNAT/Core/ctkXnatSession.h

@@ -174,6 +174,15 @@ public:
    */
   QList<QVariantMap> httpSync(const QUuid& uuid);
 
+  /**
+   * @brief Reads the result of a head request
+   * @param uuid the uid of the related query
+   *
+   * @throws ctkXnatInvalidSessionException if the session is closed.
+   * @return a QMap containing the retrieved header information
+   */
+  const QMap<QByteArray, QByteArray> httpHeadSync(const QUuid& uuid);
+
   bool exists(const ctkXnatObject* object);
 
   void save(ctkXnatObject* object);
@@ -189,6 +198,13 @@ public:
   void download(ctkXnatScanResource* scanResource, const QString& zipFileName);
   void download(ctkXnatReconstructionResource* reconstructionResource, const QString& zipFileName);
 
+  /**
+   * @brief Sends a http HEAD request to the xnat instance
+   * @param resourceUri the URL to the server
+   * @return the query uid
+   */
+  QUuid httpHead(const QString& resourceUri);
+
 //  void downloadReconstruction(ctkXnatReconstruction* reconstruction, const QString& zipFilename);
 
 //  void downloadReconstructionResourceFiles(ctkXnatReconstructionResource* reconstructionResource, const QString& zipFilename);