printscp.h

/*
 * Copyright (C) 2014-2018 Softus Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; version 2.
 *
 * 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PRINTSCP_H
#define PRINTSCP_H

#include <QObject>
#include <QDate>
#include <QRegExp>
#include <QSettings>
#ifdef WITH_TESSERACT
#include <tesseract/baseapi.h>
#endif

#define DEFAULT_LISTEN_PORT  10005
#define DEFAULT_TIMEOUT      30
#define DEFAULT_OCR_LANG     "eng"
#define DEFAULT_CONTENT_TYPE "application/xml"
#define DEFAULT_CHARSET      "UTF-8"

#ifdef UNICODE
#define DCMTK_UNICODE_BUG_WORKAROUND
#undef UNICODE
#endif

#define HAVE_CONFIG_H
#include <dcmtk/config/osconfig.h>   // make sure OS specific configuration is included first
#include <dcmtk/dcmpstat/dvpstyp.h>  // for enum types
#include <dcmtk/dcmnet/dimse.h>

#ifdef DCMTK_UNICODE_BUG_WORKAROUND
#define UNICODE
#undef DCMTK_UNICODE_BUG_WORKAROUND
#endif

class DicomImage;
struct T_ASC_Association;

class PrintSCP : public QObject
{
    Q_OBJECT

public:
    PrintSCP(T_ASC_Association *assoc, QObject *parent = 0, const QString& printer = QString());
    ~PrintSCP();

    /** performs association negotiation for the Print SCP. Depending on the
     *  configuration file settings, Basic Grayscale Print and Presentation LUT
     *  are accepted with all uncompressed transfer syntaxes.
     *  If association negotiation is unsuccessful, an A-ASSOCIATE-RQ is sent
     *  and the association is dropped. If successful, an A-ASSOCIATE-AC is
     *  prepared but not (yet) sent.
     *  @param associatePDU
     *  @param associatePDUlength
     *  @return result indicating whether association negotiation was successful.
     */
    bool negotiateAssociation();

    /** confirms an association negotiated with negotiateAssociation() and sends
     *  all DIMSE communication to upstream printer or process by itself.
     *  Returns after the association has been released or aborted.
     */
    void handleClient();

    /** destroys the association managed by this object.
     */
    void dropAssociations();

    /** Add attributes from the web service.
     *  @param rqDataset request dataset, may not be NULL
     */
    bool webQuery(DcmDataset *rqDataset);

private:

    /// private undefined assignment operator
    PrintSCP& operator=(const PrintSCP&);

    /// private undefined copy constructor
    PrintSCP(const PrintSCP& copy);

    /** sends A-ASSOCIATION-RQ as the result of an unsuccesful association
     *  negotiation.
     *  @param isBadContext defines the reason for the A-ASSOCIATE-RQ.
     *    true indicates an incorrect application context, false sends back
     *    an unspecified reject with no reason and is used when termination
     *    of the server application has been initiated.
     *  @return ASC_NORMAL if successful, an error code otherwise.
     */
    OFCondition refuseAssociation(T_ASC_RejectParametersResult result, T_ASC_RejectParametersReason reson);

    /** handles any incoming N-GET-RQ message and sends back N-GET-RSP.
     *  @param rq request message
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message
     *  @param rspDataset response dataset passed back in this parameter (if any)
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleNGet(T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** handles any incoming N-SET-RQ message and sends back N-SET-RSP.
     *  @param rq request message
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message
     *  @param rspDataset response dataset passed back in this parameter (if any)
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleNSet(T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** handles any incoming N-ACTION-RQ message and sends back N-ACTION-RSP.
     *  @param rq request message
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message
     *  @param rspDataset response dataset passed back in this parameter (if any)
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleNAction(T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** handles any incoming N-CREATE-RQ message and sends back N-CREATE-RSP.
     *  @param rq request message
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message
     *  @param rspDataset response dataset passed back in this parameter (if any)
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleNCreate(T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** handles any incoming N-DELETE-RQ message and sends back N-DELETE-RSP.
     *  @param rq request message
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message
     *  @param rspDataset response dataset passed back in this parameter (if any)
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleNDelete(T_DIMSE_Message &rq, DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** handles any incoming C-ECHO-RQ message and sends back C-ECHO-RSP.
     *  @param rq request message
     *  @param rsp response message
     *  @return DIMSE_NORMAL if successful, an error code otherwise
     */
    OFCondition handleCEcho(T_DIMSE_Message &rq, DcmDataset *, T_DIMSE_Message &rsp, DcmDataset *&);

    /** implements the N-GET operation for the Printer SOP Class.
     *  @param rq request message
     *  @param rsp response message, already initialized
     *  @param rspDataset response dataset passed back in this parameter (if any)
     */
    void printerNGet(T_DIMSE_Message &rq, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** implements the N-CREATE operation for the Basic Film Session SOP Class.
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message, already initialized
     *  @param rspDataset response dataset passed back in this parameter (if any)
     */
    void filmSessionNCreate(DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** implements the N-CREATE operation for the Basic Film Box SOP Class.
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message, already initialized
     *  @param rspDataset response dataset passed back in this parameter (if any)
     */
    void filmBoxNCreate(DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** implements the N-CREATE operation for the Presentation LUT SOP Class.
     *  @param rqDataset request dataset, may be NULL
     *  @param rsp response message, already initialized
     *  @param rspDataset response dataset passed back in this parameter (if any)
     */
    void presentationLUTNCreate(DcmDataset *rqDataset, T_DIMSE_Message &rsp, DcmDataset *&rspDataset);

    /** implements the N-DELETE operation for the Basic Film Session SOP Class.
     *  @param rq request message
     *  @param rsp response message, already initialized
     */
    void filmSessionNDelete(T_DIMSE_Message &rq, T_DIMSE_Message &rsp);

    /** implements the N-DELETE operation for the Basic Film Box SOP Class.
     *  @param rq request message
     *  @param rsp response message, already initialized
     */
    void filmBoxNDelete(T_DIMSE_Message &rq, T_DIMSE_Message &rsp);

    /** implements the N-DELETE operation for the Presentation LUT SOP Class.
     *  @param rq request message
     *  @param rsp response message, already initialized
     */
    void presentationLUTNDelete(T_DIMSE_Message &rq, T_DIMSE_Message &rsp);

    /** stores image to the storage servers.
     *  @param rqDataset request dataset, may not be NULL
     */
    void storeImage(DcmDataset *rqDataset);

    /** Add attributes from the printer settings.
     *  @param rqDataset request dataset, may not be NULL
     *  @param queryParams for the web service
     *  @param di image from dataset, may not be NULL
     *  @param settings to read attributes from
     */
    void insertTags(DcmDataset *rqDataset, QVariantMap &queryParams, DicomImage *di, QSettings &settings);

    void dump(const char* desc, DcmItem *dataset);
    void dumpIn(T_DIMSE_Message &msg, DcmItem *dataset);
    void dumpOut(T_DIMSE_Message &msg, DcmItem *dataset);

    /* class data */

    // blocking mode for receive
    //
    T_DIMSE_BlockingMode blockMode;

    // timeout for receive
    //
    int timeout;

    // basic film session instance
    //
    QString studyInstanceUID;
    QString seriesInstanceUID;
    QString SOPInstanceUID;

    // Workarounds for some spooler "optimizatins"
    //
    bool forceUniqueSeries;
    bool forceUniqueStudy;

    // the dataset to log all session attributes
    //
    DcmDataset* sessionDataset;

    // Printer AETITLE. Must have a section in the settings file
    //
    QString printer;

    // the DICOM network and listen port
    //
    T_ASC_Network *upstreamNet;

    // the network association over which the print SCP is operating
    //
    T_ASC_Association *assoc;

    // the network association over which the real printer is operating
    //
    T_ASC_Association *upstream;

#ifdef WITH_TESSERACT
    // OCR
    //
    tesseract::TessBaseAPI tess;
#endif

    // Log upstream printer traffic (off by default)
    //
    bool debugUpstream;

    // Regular expression to remove non printable symbols
    // For example, [^a-zA-Z .] will remove everything
    // except latin chars, the dot and the space.
    // "W PE=RAE=RAE=s-HK<©" will be "W PERAERAEsHK"
    //
    QRegExp reBadSymbols;
};

bool saveToDisk(const QString& spoolPath, DcmDataset* rqDataset);

#endif // PRINTSCP_H