--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PalanthirServer/DicomProtocol/DicomUserConnection.cpp	Wed Sep 05 13:24:59 2012 +0200
@@ -0,0 +1,639 @@
+/**
+ * Palantir - A Lightweight, RESTful DICOM Store
+ * Copyright (C) 2012 Medical Physics Department, CHU of Liege,
+ * Belgium
+ *
+ * This program is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+
+#include "DicomUserConnection.h"
+
+#include "../../Core/PalantirException.h"
+#include "../ToDcmtkBridge.h"
+#include "../FromDcmtkBridge.h"
+
+#include <dcmtk/dcmnet/assoc.h>
+#include <dcmtk/dcmnet/dimse.h>
+#include <dcmtk/dcmdata/dcistrmb.h>
+#include <dcmtk/dcmdata/dcistrmf.h>
+#include <dcmtk/dcmdata/dcfilefo.h>
+#include <dcmtk/dcmnet/diutil.h>
+
+#include <set>
+
+
+
+#ifdef _WIN32
+/**
+ * "The maximum length, in bytes, of the string returned in the buffer 
+ * pointed to by the name parameter is dependent on the namespace provider,
+ * but this string must be 256 bytes or less.
+ * http://msdn.microsoft.com/en-us/library/windows/desktop/ms738527(v=vs.85).aspx
+ **/
+#define HOST_NAME_MAX 256
+#endif 
+
+
+namespace Palantir
+{
+  struct DicomUserConnection::PImpl
+  {
+    // Connection state
+    T_ASC_Network* net_;
+    T_ASC_Parameters* params_;
+    T_ASC_Association* assoc_;
+
+    bool IsOpen() const
+    {
+      return assoc_ != NULL;
+    }
+
+    void CheckIsOpen() const;
+
+    void Store(DcmInputStream& is);
+  };
+
+
+  static void Check(const OFCondition& cond)
+  {
+    if (cond.bad())
+    {
+      throw PalantirException("DicomUserConnection: " + std::string(cond.text()));
+    }
+  }
+
+  void DicomUserConnection::PImpl::CheckIsOpen() const
+  {
+    if (!IsOpen())
+    {
+      throw PalantirException("DicomUserConnection: First open the connection");
+    }
+  }
+
+
+  void DicomUserConnection::CheckIsOpen() const
+  {
+    pimpl_->CheckIsOpen();
+  }
+
+
+  void DicomUserConnection::CopyParameters(const DicomUserConnection& other)
+  {
+    Close();
+    localAet_ = other.localAet_;
+    distantAet_ = other.distantAet_;
+    distantHost_ = other.distantHost_;
+    distantPort_ = other.distantPort_;
+  }
+
+
+  void DicomUserConnection::SetupPresentationContexts()
+  {
+    // The preferred abstract syntax
+    std::string preferredSyntax = UID_LittleEndianImplicitTransferSyntax;
+
+    // Fallback abstract syntaxes
+    std::set<std::string> abstractSyntaxes;
+    abstractSyntaxes.insert(UID_LittleEndianExplicitTransferSyntax);
+    abstractSyntaxes.insert(UID_BigEndianExplicitTransferSyntax);
+    abstractSyntaxes.insert(UID_LittleEndianImplicitTransferSyntax);
+    abstractSyntaxes.erase(preferredSyntax);
+    assert(abstractSyntaxes.size() == 2);
+
+    // Transfer syntaxes for C-ECHO, C-FIND and C-MOVE
+    std::vector<std::string> transferSyntaxes;
+    transferSyntaxes.push_back(UID_VerificationSOPClass);
+    transferSyntaxes.push_back(UID_FINDPatientRootQueryRetrieveInformationModel);
+    transferSyntaxes.push_back(UID_FINDStudyRootQueryRetrieveInformationModel);
+    transferSyntaxes.push_back(UID_MOVEStudyRootQueryRetrieveInformationModel);
+
+    // TODO: Allow the set below to be configured
+    std::set<std::string> uselessSyntaxes;
+    uselessSyntaxes.insert(UID_BlendingSoftcopyPresentationStateStorage);
+    uselessSyntaxes.insert(UID_GrayscaleSoftcopyPresentationStateStorage);
+    uselessSyntaxes.insert(UID_ColorSoftcopyPresentationStateStorage);
+    uselessSyntaxes.insert(UID_PseudoColorSoftcopyPresentationStateStorage);
+
+    // Add the transfer syntaxes for C-STORE
+    for (int i = 0; i < numberOfDcmShortSCUStorageSOPClassUIDs - 1; i++)
+    {
+      // Test to make some room to allow the ECHO and FIND requests
+      if (uselessSyntaxes.find(dcmShortSCUStorageSOPClassUIDs[i]) == uselessSyntaxes.end())
+      {
+        transferSyntaxes.push_back(dcmShortSCUStorageSOPClassUIDs[i]);
+      }
+    }
+
+    // Flatten the fallback abstract syntaxes array
+    const char* asPreferred[1] = { preferredSyntax.c_str() };
+    const char* asFallback[2];
+    std::set<std::string>::const_iterator it = abstractSyntaxes.begin();
+    asFallback[0] = it->c_str();
+    it++;
+    asFallback[1] = it->c_str();
+
+    unsigned int presentationContextId = 1;
+    for (size_t i = 0; i < transferSyntaxes.size(); i++)
+    {
+      Check(ASC_addPresentationContext(pimpl_->params_, presentationContextId, 
+                                       transferSyntaxes[i].c_str(), asPreferred, 1));
+      presentationContextId += 2;
+
+      Check(ASC_addPresentationContext(pimpl_->params_, presentationContextId, 
+                                       transferSyntaxes[i].c_str(), asFallback, 2));
+      presentationContextId += 2;
+    }
+  }
+
+
+  void DicomUserConnection::PImpl::Store(DcmInputStream& is)
+  {
+    CheckIsOpen();
+
+    DcmFileFormat dcmff;
+    Check(dcmff.read(is, EXS_Unknown, EGL_noChange, DCM_MaxReadLength));
+
+    // Figure out which SOP class and SOP instance is encapsulated in the file
+    DIC_UI sopClass;
+    DIC_UI sopInstance;
+    if (!DU_findSOPClassAndInstanceInDataSet(dcmff.getDataset(), sopClass, sopInstance))
+    {
+      throw PalantirException("DicomUserConnection: Unable to find the SOP class and instance");
+    }
+
+    // Figure out which of the accepted presentation contexts should be used
+    int presID = ASC_findAcceptedPresentationContextID(assoc_, sopClass);
+    if (presID == 0)
+    {
+      const char *modalityName = dcmSOPClassUIDToModality(sopClass);
+      if (!modalityName) modalityName = dcmFindNameOfUID(sopClass);
+      if (!modalityName) modalityName = "unknown SOP class";
+      throw PalantirException("DicomUserConnection: No presentation context for modality " + 
+                              std::string(modalityName));
+    }
+
+    // Prepare the transmission of data
+    T_DIMSE_C_StoreRQ req;
+    memset(&req, 0, sizeof(req));
+    req.MessageID = assoc_->nextMsgID++;
+    strcpy(req.AffectedSOPClassUID, sopClass);
+    strcpy(req.AffectedSOPInstanceUID, sopInstance);
+    req.DataSetType = DIMSE_DATASET_PRESENT;
+    req.Priority = DIMSE_PRIORITY_MEDIUM;
+
+    // Finally conduct transmission of data
+    T_DIMSE_C_StoreRSP rsp;
+    DcmDataset* statusDetail = NULL;
+    Check(DIMSE_storeUser(assoc_, presID, &req,
+                          NULL, dcmff.getDataset(), /*progressCallback*/ NULL, NULL,
+                          /*opt_blockMode*/ DIMSE_BLOCKING, /*opt_dimse_timeout*/ 0,
+                          &rsp, &statusDetail, NULL));
+
+    if (statusDetail != NULL) 
+    {
+      delete statusDetail;
+    }
+  }
+
+
+  static void FindCallback(
+    /* in */
+    void *callbackData,
+    T_DIMSE_C_FindRQ *request,      /* original find request */
+    int responseCount,
+    T_DIMSE_C_FindRSP *response,    /* pending response received */
+    DcmDataset *responseIdentifiers /* pending response identifiers */
+    )
+  {
+    DicomFindAnswers& answers = *(DicomFindAnswers*) callbackData;
+
+    if (responseIdentifiers != NULL)
+    {
+      DicomMap m;
+      FromDcmtkBridge::Convert(m, *responseIdentifiers);
+      answers.Add(m);
+    }
+  }
+
+  void DicomUserConnection::Find(DicomFindAnswers& result,
+                                 FindRootModel model,
+                                 const DicomMap& fields)
+  {
+    CheckIsOpen();
+
+    const char* sopClass;
+    std::auto_ptr<DcmDataset> dataset(ToDcmtkBridge::Convert(fields));
+    switch (model)
+    {
+    case FindRootModel_Patient:
+      DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0052), "PATIENT");
+      sopClass = UID_FINDPatientRootQueryRetrieveInformationModel;
+      
+      // Accession number
+      if (!fields.HasTag(0x0008, 0x0050))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0050), "");
+
+      // Patient ID
+      if (!fields.HasTag(0x0010, 0x0020))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0010, 0x0020), "");
+
+      break;
+
+    case FindRootModel_Study:
+      DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0052), "STUDY");
+      sopClass = UID_FINDStudyRootQueryRetrieveInformationModel;
+
+      // Accession number
+      if (!fields.HasTag(0x0008, 0x0050))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0050), "");
+
+      // Study instance UID
+      if (!fields.HasTag(0x0020, 0x000d))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0020, 0x000d), "");
+
+      break;
+
+    case FindRootModel_Series:
+      DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0052), "SERIES");
+      sopClass = UID_FINDStudyRootQueryRetrieveInformationModel;
+
+      // Accession number
+      if (!fields.HasTag(0x0008, 0x0050))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0050), "");
+
+      // Study instance UID
+      if (!fields.HasTag(0x0020, 0x000d))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0020, 0x000d), "");
+
+      // Series instance UID
+      if (!fields.HasTag(0x0020, 0x000e))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0020, 0x000e), "");
+
+      break;
+
+    case FindRootModel_Instance:
+      DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0052), "INSTANCE");
+      sopClass = UID_FINDStudyRootQueryRetrieveInformationModel;
+
+      // Accession number
+      if (!fields.HasTag(0x0008, 0x0050))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0050), "");
+
+      // Study instance UID
+      if (!fields.HasTag(0x0020, 0x000d))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0020, 0x000d), "");
+
+      // Series instance UID
+      if (!fields.HasTag(0x0020, 0x000e))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0020, 0x000e), "");
+
+      // SOP Instance UID
+      if (!fields.HasTag(0x0008, 0x0018))
+        DU_putStringDOElement(dataset.get(), DcmTagKey(0x0008, 0x0018), "");
+
+      break;
+
+    default:
+      throw PalantirException(ErrorCode_ParameterOutOfRange);
+    }
+
+    // Figure out which of the accepted presentation contexts should be used
+    int presID = ASC_findAcceptedPresentationContextID(pimpl_->assoc_, sopClass);
+    if (presID == 0)
+    {
+      throw PalantirException("DicomUserConnection: The C-FIND command is not supported by the distant AET");
+    }
+
+    T_DIMSE_C_FindRQ request;
+    memset(&request, 0, sizeof(request));
+    request.MessageID = pimpl_->assoc_->nextMsgID++;
+    strcpy(request.AffectedSOPClassUID, sopClass);
+    request.DataSetType = DIMSE_DATASET_PRESENT;
+    request.Priority = DIMSE_PRIORITY_MEDIUM;
+
+    T_DIMSE_C_FindRSP response;
+    DcmDataset* statusDetail = NULL;
+    OFCondition cond = DIMSE_findUser(pimpl_->assoc_, presID, &request, dataset.get(),
+                                      FindCallback, &result,
+                                      /*opt_blockMode*/ DIMSE_BLOCKING, /*opt_dimse_timeout*/ 0,
+                                      &response, &statusDetail);
+
+    if (statusDetail)
+    {
+      delete statusDetail;
+    }
+
+    Check(cond);
+  }
+
+
+  void DicomUserConnection::FindPatient(DicomFindAnswers& result,
+                                        const DicomMap& fields)
+  {
+    // Only keep the filters from "fields" that are related to the patient
+    DicomMap s;
+    fields.ExtractPatientInformation(s);
+    Find(result, FindRootModel_Patient, s);
+  }
+
+  void DicomUserConnection::FindStudy(DicomFindAnswers& result,
+                                      const DicomMap& fields)
+  {
+    // Only keep the filters from "fields" that are related to the study
+    DicomMap s;
+    fields.ExtractStudyInformation(s);
+
+    s.CopyTagIfExists(fields, DicomTag::PATIENT_ID);
+    s.CopyTagIfExists(fields, DicomTag::ACCESSION_NUMBER);
+
+    Find(result, FindRootModel_Study, s);
+  }
+
+  void DicomUserConnection::FindSeries(DicomFindAnswers& result,
+                                       const DicomMap& fields)
+  {
+    // Only keep the filters from "fields" that are related to the series
+    DicomMap s;
+    fields.ExtractSeriesInformation(s);
+
+    s.CopyTagIfExists(fields, DicomTag::PATIENT_ID);
+    s.CopyTagIfExists(fields, DicomTag::ACCESSION_NUMBER);
+    s.CopyTagIfExists(fields, DicomTag::STUDY_UID);
+
+    Find(result, FindRootModel_Series, s);
+  }
+
+  void DicomUserConnection::FindInstance(DicomFindAnswers& result,
+                                         const DicomMap& fields)
+  {
+    // Only keep the filters from "fields" that are related to the instance
+    DicomMap s;
+    fields.ExtractInstanceInformation(s);
+
+    s.CopyTagIfExists(fields, DicomTag::PATIENT_ID);
+    s.CopyTagIfExists(fields, DicomTag::ACCESSION_NUMBER);
+    s.CopyTagIfExists(fields, DicomTag::STUDY_UID);
+    s.CopyTagIfExists(fields, DicomTag::SERIES_UID);
+
+    Find(result, FindRootModel_Instance, s);
+  }
+
+
+  void DicomUserConnection::Move(const std::string& targetAet,
+                                 const DicomMap& fields)
+  {
+    CheckIsOpen();
+
+    const char* sopClass = UID_MOVEStudyRootQueryRetrieveInformationModel;
+    std::auto_ptr<DcmDataset> dataset(ToDcmtkBridge::Convert(fields));
+
+    // Figure out which of the accepted presentation contexts should be used
+    int presID = ASC_findAcceptedPresentationContextID(pimpl_->assoc_, sopClass);
+    if (presID == 0)
+    {
+      throw PalantirException("DicomUserConnection: The C-MOVE command is not supported by the distant AET");
+    }
+
+    T_DIMSE_C_MoveRQ request;
+    memset(&request, 0, sizeof(request));
+    request.MessageID = pimpl_->assoc_->nextMsgID++;
+    strcpy(request.AffectedSOPClassUID, sopClass);
+    request.DataSetType = DIMSE_DATASET_PRESENT;
+    request.Priority = DIMSE_PRIORITY_MEDIUM;
+    strncpy(request.MoveDestination, targetAet.c_str(), sizeof(DIC_AE) / sizeof(char));
+
+    T_DIMSE_C_MoveRSP response;
+    DcmDataset* statusDetail = NULL;
+    DcmDataset* responseIdentifiers = NULL;
+    OFCondition cond = DIMSE_moveUser(pimpl_->assoc_, presID, &request, dataset.get(),
+                                      NULL, NULL,
+                                      /*opt_blockMode*/ DIMSE_BLOCKING, /*opt_dimse_timeout*/ 0,
+                                      pimpl_->net_, NULL, NULL,
+                                      &response, &statusDetail, &responseIdentifiers);
+
+    if (statusDetail)
+    {
+      delete statusDetail;
+    }
+
+    if (responseIdentifiers)
+    {
+      delete responseIdentifiers;
+    }
+
+    Check(cond);
+  }
+
+
+  DicomUserConnection::DicomUserConnection() : pimpl_(new PImpl)
+  {
+    localAet_ = "STORESCU";
+    distantAet_ = "ANY-SCP";
+    distantPort_ = 104;
+    distantHost_ = "127.0.0.1";
+
+    pimpl_->net_ = NULL;
+    pimpl_->params_ = NULL;
+    pimpl_->assoc_ = NULL;
+  }
+
+  DicomUserConnection::~DicomUserConnection()
+  {
+    Close();
+  }
+
+  void DicomUserConnection::SetLocalApplicationEntityTitle(const std::string& aet)
+  {
+    Close();
+    localAet_ = aet;
+  }
+
+  void DicomUserConnection::SetDistantApplicationEntityTitle(const std::string& aet)
+  {
+    Close();
+    distantAet_ = aet;
+  }
+
+
+  void DicomUserConnection::SetDistantHost(const std::string& host)
+  {
+    if (host.size() > HOST_NAME_MAX - 10)
+    {
+      throw PalantirException("Distant host name is too long");
+    }
+
+    Close();
+    distantHost_ = host;
+  }
+
+  void DicomUserConnection::SetDistantPort(uint16_t port)
+  {
+    Close();
+    distantPort_ = port;
+  }
+
+  void DicomUserConnection::Open()
+  {
+    Close();
+
+    Check(ASC_initializeNetwork(NET_REQUESTOR, 0, /*opt_acse_timeout*/ 30, &pimpl_->net_));
+    Check(ASC_createAssociationParameters(&pimpl_->params_, /*opt_maxReceivePDULength*/ ASC_DEFAULTMAXPDU));
+
+    // Set this application's title and the called application's title in the params
+    Check(ASC_setAPTitles(pimpl_->params_, localAet_.c_str(), distantAet_.c_str(), NULL));
+
+    // Set the network addresses of the local and distant entities
+    char localHost[HOST_NAME_MAX];
+    gethostname(localHost, HOST_NAME_MAX - 1);
+
+    char distantHostAndPort[HOST_NAME_MAX];
+
+#ifdef _MSC_VER
+	_snprintf
+#else
+	snprintf
+#endif
+		(distantHostAndPort, HOST_NAME_MAX - 1, "%s:%d", distantHost_.c_str(), distantPort_);
+
+    Check(ASC_setPresentationAddresses(pimpl_->params_, localHost, distantHostAndPort));
+
+    // Set various options
+    Check(ASC_setTransportLayerType(pimpl_->params_, /*opt_secureConnection*/ false));
+
+    SetupPresentationContexts();
+
+    // Do the association
+    Check(ASC_requestAssociation(pimpl_->net_, pimpl_->params_, &pimpl_->assoc_));
+
+    if (ASC_countAcceptedPresentationContexts(pimpl_->params_) == 0)
+    {
+      throw PalantirException("DicomUserConnection: No Acceptable Presentation Contexts");
+    }
+  }
+
+  void DicomUserConnection::Close()
+  {
+    if (pimpl_->assoc_ != NULL)
+    {
+      ASC_releaseAssociation(pimpl_->assoc_);
+      ASC_destroyAssociation(&pimpl_->assoc_);
+      pimpl_->assoc_ = NULL;
+      pimpl_->params_ = NULL;
+    }
+    else
+    {
+      if (pimpl_->params_ != NULL)
+      {
+        ASC_destroyAssociationParameters(&pimpl_->params_);
+        pimpl_->params_ = NULL;
+      }
+    }
+
+    if (pimpl_->net_ != NULL)
+    {
+      ASC_dropNetwork(&pimpl_->net_);
+      pimpl_->net_ = NULL;
+    }
+  }
+
+  bool DicomUserConnection::IsOpen() const
+  {
+    return pimpl_->IsOpen();
+  }
+
+  void DicomUserConnection::Store(const char* buffer, size_t size)
+  {
+    // Prepare an input stream for the memory buffer
+    DcmInputBufferStream is;
+    if (size > 0)
+      is.setBuffer(buffer, size);
+    is.setEos();
+      
+    pimpl_->Store(is);
+  }
+
+  void DicomUserConnection::Store(const std::string& buffer)
+  {
+    if (buffer.size() > 0)
+      Store(reinterpret_cast<const char*>(&buffer[0]), buffer.size());
+    else
+      Store(NULL, 0);
+  }
+
+  void DicomUserConnection::StoreFile(const std::string& path)
+  {
+    // Prepare an input stream for the file
+    DcmInputFileStream is(path.c_str());
+    pimpl_->Store(is);
+  }
+
+  bool DicomUserConnection::Echo()
+  {
+    CheckIsOpen();
+    DIC_US status;
+    Check(DIMSE_echoUser(pimpl_->assoc_, pimpl_->assoc_->nextMsgID++, 
+                         /*opt_blockMode*/ DIMSE_BLOCKING, /*opt_dimse_timeout*/ 0,
+                         &status, NULL));
+    return status == STATUS_Success;
+  }
+
+
+  void DicomUserConnection::MoveSeries(const std::string& targetAet,
+                                       const DicomMap& findResult)
+  {
+    DicomMap simplified;
+    simplified.SetValue(DicomTag::STUDY_UID, findResult.GetValue(DicomTag::STUDY_UID));
+    simplified.SetValue(DicomTag::SERIES_UID, findResult.GetValue(DicomTag::SERIES_UID));
+    Move(targetAet, simplified);
+  }
+
+  void DicomUserConnection::MoveSeries(const std::string& targetAet,
+                                       const std::string& studyUid,
+                                       const std::string& seriesUid)
+  {
+    DicomMap map;
+    map.SetValue(DicomTag::STUDY_UID, studyUid);
+    map.SetValue(DicomTag::SERIES_UID, seriesUid);
+    Move(targetAet, map);
+  }
+
+  void DicomUserConnection::MoveInstance(const std::string& targetAet,
+                                         const DicomMap& findResult)
+  {
+    DicomMap simplified;
+    simplified.SetValue(DicomTag::STUDY_UID, findResult.GetValue(DicomTag::STUDY_UID));
+    simplified.SetValue(DicomTag::SERIES_UID, findResult.GetValue(DicomTag::SERIES_UID));
+    simplified.SetValue(DicomTag::INSTANCE_UID, findResult.GetValue(DicomTag::INSTANCE_UID));
+    Move(targetAet, simplified);
+  }
+
+  void DicomUserConnection::MoveInstance(const std::string& targetAet,
+                                         const std::string& studyUid,
+                                         const std::string& seriesUid,
+                                         const std::string& instanceUid)
+  {
+    DicomMap map;
+    map.SetValue(DicomTag::STUDY_UID, studyUid);
+    map.SetValue(DicomTag::SERIES_UID, seriesUid);
+    map.SetValue(DicomTag::INSTANCE_UID, instanceUid);
+    Move(targetAet, map);
+  }
+
+  void DicomUserConnection::SetConnectionTimeout(uint32_t seconds)
+  {
+    dcmConnectionTimeout.set(seconds);
+  }
+
+}