/*============================================================================= Library: XNAT/Core Copyright (c) University College London, Centre for Medical Image Computing Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "ctkXnatSession.h" #include "ctkXnatDataModel.h" #include "ctkXnatException.h" #include "ctkXnatExperiment.h" #include "ctkXnatFile.h" #include "ctkXnatLoginProfile.h" #include "ctkXnatObject.h" #include "ctkXnatProject.h" #include "ctkXnatReconstruction.h" #include "ctkXnatReconstructionFolder.h" #include "ctkXnatReconstructionResource.h" #include "ctkXnatResource.h" #include "ctkXnatScan.h" #include "ctkXnatScanFolder.h" #include "ctkXnatScanResource.h" #include "ctkXnatSubject.h" #include "ctkXnatDefaultSchemaTypes.h" #include #include #include #include #include #include #include //---------------------------------------------------------------------------- static const char* HEADER_AUTHORIZATION = "Authorization"; static const char* HEADER_USER_AGENT = "User-Agent"; static const char* HEADER_COOKIE = "Cookie"; static QString SERVER_VERSION = "version"; static QString SESSION_EXPIRATION_DATE = "expires"; //---------------------------------------------------------------------------- class ctkXnatSessionPrivate { public: const ctkXnatLoginProfile loginProfile; QScopedPointer xnat; QScopedPointer dataModel; QString sessionId; QMap sessionProperties; ctkXnatSession* q; ctkXnatSessionPrivate(const ctkXnatLoginProfile& loginProfile, ctkXnatSession* q); ~ctkXnatSessionPrivate(); void throwXnatException(const QString& msg); void createConnections(); void setDefaultHttpHeaders(); void checkSession() const; void setSessionProperties(); QDateTime updateExpirationDate(qRestResult* restResult); void close(); static QList results(qRestResult* restResult, QString schemaType); }; //---------------------------------------------------------------------------- ctkXnatSessionPrivate::ctkXnatSessionPrivate(const ctkXnatLoginProfile& loginProfile, ctkXnatSession* q) : loginProfile(loginProfile) , xnat(new ctkXnatAPI()) , q(q) { // TODO This is a workaround for connecting to sites with self-signed // certificate. Should be replaced with something more clever. xnat->setSuppressSslErrors(true); createConnections(); } //---------------------------------------------------------------------------- ctkXnatSessionPrivate::~ctkXnatSessionPrivate() { } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::throwXnatException(const QString& msg) { QString errorMsg = msg.trimmed(); if (!errorMsg.isEmpty()) { errorMsg.append(' '); } errorMsg.append(xnat->errorString()); switch (xnat->error()) { case qRestAPI::TimeoutError: throw ctkXnatTimeoutException(errorMsg); case qRestAPI::ResponseParseError: throw ctkXnatProtocolFailureException(errorMsg); case qRestAPI::UnknownUuidError: throw ctkInvalidArgumentException(errorMsg); case qRestAPI::AuthenticationError: // This signals either an initial authentication error // or a session timeout. this->close(); throw ctkXnatAuthenticationException(errorMsg); default: throw ctkRuntimeException(errorMsg); } } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::createConnections() { // Q_D(ctkXnatSession); // connect(d->xnat, SIGNAL(resultReceived(QUuid,QList)), // this, SLOT(processResult(QUuid,QList))); // connect(d->xnat, SIGNAL(progress(QUuid,double)), // this, SLOT(progress(QUuid,double))); } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::setDefaultHttpHeaders() { ctkXnatAPI::RawHeaders rawHeaders; rawHeaders[HEADER_USER_AGENT] = "Qt"; /* rawHeaders["Authorization"] = "Basic " + QByteArray(QString("%1:%2").arg(d->loginProfile.userName()) .arg(d->loginProfile.password()).toAscii()).toBase64(); */ if (!sessionId.isEmpty()) { rawHeaders[HEADER_COOKIE] = QString("JSESSIONID=%1").arg(sessionId).toLatin1(); } xnat->setDefaultRawHeaders(rawHeaders); } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::checkSession() const { if (sessionId.isEmpty()) { throw ctkXnatInvalidSessionException("Session closed."); } } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::setSessionProperties() { sessionProperties.clear(); QUuid uuid = xnat->get("/data/version"); QScopedPointer restResult(xnat->takeResult(uuid)); if (restResult) { QString version = restResult->result()["content"].toString(); if (version.isEmpty()) { throw ctkXnatProtocolFailureException("No version information available."); } sessionProperties[SERVER_VERSION] = version; } else { this->throwXnatException("Retrieving session properties failed."); } } //---------------------------------------------------------------------------- QDateTime ctkXnatSessionPrivate::updateExpirationDate(qRestResult* restResult) { QByteArray cookieHeader = restResult->rawHeader("Set-Cookie"); QDateTime expirationDate = QDateTime::currentDateTime(); if (!cookieHeader.isEmpty()) { QList cookies = QNetworkCookie::parseCookies(cookieHeader); foreach(const QNetworkCookie& cookie, cookies) { if (cookie.name() == "SESSION_EXPIRATION_TIME") { QList expirationCookie = cookie.value().split(','); if (expirationCookie.size() == 2) { unsigned long long startTime = expirationCookie[0].mid(1).toULongLong(); if (startTime > 0) { expirationDate = QDateTime::fromTime_t(startTime / 1000); } QByteArray timeSpan = expirationCookie[1]; timeSpan.chop(1); expirationDate = expirationDate.addMSecs(timeSpan.toLong()); sessionProperties[SESSION_EXPIRATION_DATE] = expirationDate.toString(Qt::ISODate); emit q->sessionRenewed(expirationDate); } } } } return expirationDate; } //---------------------------------------------------------------------------- void ctkXnatSessionPrivate::close() { sessionProperties.clear(); sessionId.clear(); this->setDefaultHttpHeaders(); dataModel.reset(); } //---------------------------------------------------------------------------- QList ctkXnatSessionPrivate::results(qRestResult* restResult, QString schemaType) { QList results; foreach (const QVariantMap& propertyMap, restResult->results()) { QString customSchemaType; if (propertyMap.contains("xsiType")) { customSchemaType = propertyMap["xsiType"].toString(); } int typeId = 0; // try to create an object based on the custom schema type first if (!customSchemaType.isEmpty()) { typeId = QMetaType::type(qPrintable(customSchemaType)); if (!typeId) { qWarning() << QString("No ctkXnatObject sub-class registered for the schema %1. Falling back to the default class.").arg(customSchemaType); } } // Fall back. Create the default class according to the default schema type if (!typeId) { typeId = QMetaType::type(qPrintable(schemaType)); } if (!typeId) { qWarning() << QString("No ctkXnatObject sub-class registered as a meta-type for the schema %1. Skipping result.").arg(schemaType); continue; } #if (QT_VERSION < QT_VERSION_CHECK(5,0,0)) ctkXnatObject* object = reinterpret_cast(QMetaType::construct(typeId)); #else ctkXnatObject* object = reinterpret_cast(QMetaType(typeId).create()); #endif if (!customSchemaType.isEmpty()) { // We might have created the default ctkXnatObject sub-class, but can still set // the custom schema type. object->setSchemaType(customSchemaType); } // Fill in the properties QMapIterator it(propertyMap); while (it.hasNext()) { it.next(); 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; } //---------------------------------------------------------------------------- // ctkXnatSession class //---------------------------------------------------------------------------- ctkXnatSession::ctkXnatSession(const ctkXnatLoginProfile& loginProfile) : d_ptr(new ctkXnatSessionPrivate(loginProfile, this)) { Q_D(ctkXnatSession); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_PROJECT)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_SUBJECT)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_EXPERIMENT)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_SCAN)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_RECONSTRUCTION)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_SCAN_RESOURCE)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_FILE)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_RECONSTRUCTION_RESOURCE)); qRegisterMetaType(qPrintable(ctkXnatDefaultSchemaTypes::XSI_RESOURCE)); QString url = d->loginProfile.serverUrl().toString(); d->xnat->setServerUrl(url); d->setDefaultHttpHeaders(); } //---------------------------------------------------------------------------- ctkXnatSession::~ctkXnatSession() { this->close(); } //---------------------------------------------------------------------------- void ctkXnatSession::open() { Q_D(ctkXnatSession); if (this->isOpen()) return; qRestAPI::RawHeaders headers; headers[HEADER_AUTHORIZATION] = "Basic " + QByteArray(QString("%1:%2").arg(this->userName()) .arg(this->password()).toLatin1()).toBase64(); QUuid uuid = d->xnat->get("/data/JSESSION", qRestAPI::Parameters(), headers); QScopedPointer restResult(d->xnat->takeResult(uuid)); if (restResult) { QString sessionId = restResult->result()["content"].toString(); d->sessionId = sessionId; d->setDefaultHttpHeaders(); d->setSessionProperties(); d->updateExpirationDate(restResult.data()); } else { d->throwXnatException("Could not get a session id."); } d->dataModel.reset(new ctkXnatDataModel(this)); d->dataModel->setProperty("ID", this->url().toString()); } //---------------------------------------------------------------------------- void ctkXnatSession::close() { Q_D(ctkXnatSession); if (!this->isOpen()) return; d->close(); } //---------------------------------------------------------------------------- bool ctkXnatSession::isOpen() const { Q_D(const ctkXnatSession); return !d->sessionId.isEmpty(); } //---------------------------------------------------------------------------- QString ctkXnatSession::version() const { Q_D(const ctkXnatSession); if (d->sessionProperties.contains(SERVER_VERSION)) { return d->sessionProperties[SERVER_VERSION]; } else { return QString::null; } } //---------------------------------------------------------------------------- QDateTime ctkXnatSession::expirationDate() const { Q_D(const ctkXnatSession); d->checkSession(); return QDateTime::fromString(d->sessionProperties[SESSION_EXPIRATION_DATE], Qt::ISODate); } //---------------------------------------------------------------------------- QDateTime ctkXnatSession::renew() { Q_D(ctkXnatSession); d->checkSession(); QUuid uuid = d->xnat->get("/data/auth"); QScopedPointer restResult(d->xnat->takeResult(uuid)); if (!restResult) { d->throwXnatException("Session renewal failed."); } return d->updateExpirationDate(restResult.data()); } //---------------------------------------------------------------------------- ctkXnatLoginProfile ctkXnatSession::loginProfile() const { Q_D(const ctkXnatSession); return d->loginProfile; } //---------------------------------------------------------------------------- void ctkXnatSession::progress(QUuid /*queryId*/, double /*progress*/) { // qDebug() << "ctkXnatSession::progress(QUuid queryId, double progress)"; // qDebug() << "query id:" << queryId; // qDebug() << "progress:" << (progress * 100.0) << "%"; } //---------------------------------------------------------------------------- QUrl ctkXnatSession::url() const { Q_D(const ctkXnatSession); return d->loginProfile.serverUrl(); } //---------------------------------------------------------------------------- QString ctkXnatSession::userName() const { Q_D(const ctkXnatSession); return d->loginProfile.userName(); } //---------------------------------------------------------------------------- QString ctkXnatSession::password() const { Q_D(const ctkXnatSession); return d->loginProfile.password(); } //---------------------------------------------------------------------------- ctkXnatDataModel* ctkXnatSession::dataModel() const { Q_D(const ctkXnatSession); d->checkSession(); return d->dataModel.data(); } //---------------------------------------------------------------------------- QUuid ctkXnatSession::httpGet(const QString& resource, const ctkXnatSession::UrlParameters& parameters, const ctkXnatSession::HttpRawHeaders& rawHeaders) { Q_D(ctkXnatSession); d->checkSession(); return d->xnat->get(resource, parameters, rawHeaders); } //---------------------------------------------------------------------------- QList ctkXnatSession::httpResults(const QUuid& uuid, const QString& schemaType) { Q_D(ctkXnatSession); d->checkSession(); QScopedPointer restResult(d->xnat->takeResult(uuid)); if (restResult == NULL) { d->throwXnatException("Http request failed."); } return d->results(restResult.data(), schemaType); } //---------------------------------------------------------------------------- QList ctkXnatSession::httpSync(const QUuid& uuid) { Q_D(ctkXnatSession); d->checkSession(); QList result; qRestResult* restResult = d->xnat->takeResult(uuid); if (restResult == NULL) { d->throwXnatException("Syncing with http request failed."); } else { d->updateExpirationDate(restResult); result = restResult->results(); } return result; } //---------------------------------------------------------------------------- bool ctkXnatSession::exists(const ctkXnatObject* object) { Q_D(ctkXnatSession); QString query = object->resourceUri(); bool success = d->xnat->sync(d->xnat->get(query)); return success; } //---------------------------------------------------------------------------- const QMap ctkXnatSession::httpHeadSync(const QUuid &uuid) { Q_D(ctkXnatSession); QScopedPointer 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); QString query = object->resourceUri(); query.append(QString("?%1=%2").arg("xsi:type", object->schemaType())); const QMap& properties = object->properties(); QMapIterator itProperties(properties); while (itProperties.hasNext()) { itProperties.next(); query.append(QString("&%1=%2").arg(itProperties.key(), itProperties.value())); } qDebug() << "ctkXnatSession::save() query:" << query; QUuid queryId = d->xnat->put(query); qRestResult* result = d->xnat->takeResult(queryId); if (!result || !result->error().isNull()) { d->throwXnatException("Error occurred while creating the data."); } const QList& maps = result->results(); if (maps.size() == 1 && maps[0].size() == 1) { QVariant id = maps[0]["ID"]; if (!id.isNull()) { object->setId(id.toString()); } } } //---------------------------------------------------------------------------- void ctkXnatSession::remove(ctkXnatObject* object) { Q_D(ctkXnatSession); QString query = object->resourceUri(); bool success = d->xnat->sync(d->xnat->del(query)); if (!success) { d->throwXnatException("Error occurred while removing the data."); } } //---------------------------------------------------------------------------- //void ctkXnatSession::create(ctkXnatSubject* subject) //{ // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2").arg(projectName, subjectName); // bool success = d->xnat->sync(d->xnat->put(query)); // if (!success) // { // throw ctkXnatException("Error occurred while creating the subject."); // } //} //---------------------------------------------------------------------------- //void ctkXnatSession::downloadScanFiles(ctkXnatExperiment* experiment, const QString& fileName) //{ // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/scans/ALL/files").arg(projectName, subjectName, experimentName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- //void ctkXnatSession::downloadReconstructionFiles(ctkXnatExperiment* experiment, const QString& fileName) //{ // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/reconstructions/ALL/files").arg(projectName, subjectName, experimentName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- //void ctkXnatSession::downloadReconstruction(ctkXnatReconstruction* reconstruction, const QString& fileName) //{ // const QString& reconstructionName = reconstruction->getName(); // ctkXnatObject* experiment = reconstruction->getParent(); // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/reconstructions/%4/ALL/files").arg(projectName, subjectName, experimentName, reconstructionName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- //void ctkXnatSession::downloadReconstructionResourceFiles(ctkXnatReconstructionResource* reconstructionResource, const QString& fileName) //{ // const QString& reconstructionResourceName = reconstructionResource->getName(); // ctkXnatObject* reconstruction = reconstructionResource->getParent(); // const QString& reconstructionName = reconstruction->getName(); // ctkXnatObject* experiment = reconstruction->getParent()->getParent(); // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/reconstructions/%4/ALL/resources/%5/files").arg(projectName, subjectName, experimentName, reconstructionName, reconstructionResourceName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- //void ctkXnatSession::download(ctkXnatReconstructionResourceFile* reconstructionResourceFile, const QString& fileName) //{ // const QString& reconstructionResourceFileName = reconstructionResourceFile->getName(); // ctkXnatObject* reconstructionResource = reconstructionResourceFile->getParent(); // const QString& reconstructionResourceName = reconstructionResource->getName(); // ctkXnatObject* reconstruction = reconstructionResource->getParent(); // const QString& reconstructionName = reconstruction->getName(); // ctkXnatObject* experiment = reconstruction->getParent()->getParent(); // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/reconstructions/%4/resources/%5/files/%6").arg(projectName, subjectName, experimentName, reconstructionName, reconstructionResourceName, reconstructionResourceFileName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- //void ctkXnatSession::download(ctkXnatScan* scan, const QString& fileName) //{ // const QString& scanName = scan->getName(); // ctkXnatObject* experiment = scan->getParent()->getParent(); // const QString& experimentName = experiment->getName(); // ctkXnatObject* subject = experiment->getParent(); // const QString& subjectName = subject->getName(); // ctkXnatObject* project = subject->getParent(); // const QString& projectName = project->getName(); // Q_D(ctkXnatSession); // QString query = QString("/REST/projects/%1/subjects/%2/experiments/%3/scans/%4/files").arg(projectName, subjectName, experimentName, scanName); // qRestAPI::Parameters parameters; // parameters["format"] = "zip"; // QUuid queryId = d->xnat->download(fileName, query, parameters); // d->xnat->sync(queryId); //} //---------------------------------------------------------------------------- void ctkXnatSession::download(ctkXnatFile* file, const QString& fileName) { Q_D(ctkXnatSession); QString query = file->resourceUri(); QUuid queryId = d->xnat->download(fileName, query); d->xnat->sync(queryId); } //---------------------------------------------------------------------------- void ctkXnatSession::download(ctkXnatScanResource* scanResource, const QString& fileName) { Q_D(ctkXnatSession); QString query = scanResource->resourceUri() + "/files"; qRestAPI::Parameters parameters; parameters["format"] = "zip"; QUuid queryId = d->xnat->download(fileName, query, parameters); d->xnat->sync(queryId); } //---------------------------------------------------------------------------- void ctkXnatSession::download(ctkXnatReconstructionResource* reconstructionResource, const QString& fileName) { Q_D(ctkXnatSession); QString query = reconstructionResource->resourceUri() + "/files"; qRestAPI::Parameters parameters; parameters["format"] = "zip"; QUuid queryId = d->xnat->download(fileName, query, parameters); d->xnat->sync(queryId); } //---------------------------------------------------------------------------- void ctkXnatSession::processResult(QUuid queryId, QList parameters) { Q_UNUSED(queryId) Q_UNUSED(parameters) }