cxXmlOptionItem.cpp

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/


/*
 * sscXmlOptionItem.cpp
 *
 *  Created on: May 28, 2010
 *      Author: christiana
 */
#include "cxXmlOptionItem.h"

#include <map>
#include <iostream>
#include <QFile>
#include <QDir>
#include <QFileInfo>
#include <QTextStream>
#include <QDomElement>
#include <QDataStream>
#include <QStringList>
#include <QMutex>
#include <QBuffer>
#include "cxLogger.h"
#include "cxTypeConversions.h"

namespace cx
{

class SharedDocuments
{
public:
        static SharedDocuments* getInstance()
        {
                if (!mInstance)
                        mInstance = new SharedDocuments();
                return mInstance;
        }

        QDomDocument loadDocument(const QString& filename)
        {
                QDomDocument retval;
                retval = this->getDocument(filename);
                if (retval.isNull())
                {
                        retval = this->readFromFile(filename);
                        this->addDocument(filename, retval);
                }
                return retval;
        }

private:
        SharedDocuments() : mDocumentMutex(QMutex::Recursive) {}

        QDomDocument getDocument(const QString& filename)
        {
                QMutexLocker lock(&mDocumentMutex);
                DocumentMap::iterator iter = mDocuments.find(filename);
                // if filename found, attempt to retrieve document from node.
                if (iter != mDocuments.end())
                {
                        return iter->second.ownerDocument();
                }
                return QDomDocument(); // null node
        }

        void addDocument(const QString& filename, QDomDocument document)
        {
                QMutexLocker lock(&mDocumentMutex);
                mDocuments[filename] = document.documentElement();
        }

        QDomDocument readFromFile(QString filename)
        {
                QFile file(filename);
                if (!file.open(QIODevice::ReadOnly))
                {
                        QDomDocument doc;
                        doc.appendChild(doc.createElement("root"));
                        return doc;
                }

                QDomDocument loadedDoc;
                QString error;
                int line, col;
                if (!loadedDoc.setContent(&file, &error, &line, &col))
                {
                        QString msg = QString("error setting xml content [%1,%2] %3").arg(line).arg(col).arg(error);
                        reportWarning(msg);
                }
                file.close();
                return loadedDoc;
        }

        static SharedDocuments* mInstance;
        typedef std::map<QString, QDomElement> DocumentMap;
        QMutex mDocumentMutex;
        DocumentMap mDocuments; 
};
SharedDocuments* SharedDocuments::mInstance = NULL;


QString XmlOptionItem::SerializeDataToB64String(const QVariant& data)
{
        QByteArray byteArray;
        QBuffer writeBuffer(&byteArray);
        writeBuffer.open(QIODevice::WriteOnly);
        QDataStream out(&writeBuffer);

        out << data;

        writeBuffer.close();

        QString s = QString(byteArray.toBase64());

//      qDebug() << "array size when written:" << byteArray.size();

        return s;
}


QVariant XmlOptionItem::DeserializeB64String(const QString& serializedVariant)
{
        QByteArray readArr = QByteArray::fromBase64(serializedVariant.toUtf8());
        QBuffer readBuffer(&readArr);
        readBuffer.open(QIODevice::ReadOnly);
        QDataStream in(&readBuffer);

        QVariant data;

        in >> data;

//      qDebug() << "array size when read:" << readArr.size();

        return data;
}

XmlOptionItem::XmlOptionItem(const QString& uid, QDomElement root) :
        mUid(uid), mRoot(root)
{

}

QVariant XmlOptionItem::readVariant(const QVariant& defval) const
{
        QString text = this->readValue("");
        if (text.isEmpty())
                return defval;
        QVariant val = DeserializeB64String(text);
        return val;
}

void XmlOptionItem::writeVariant(const QVariant& val)
{
        QString text = SerializeDataToB64String(val);
        this->writeValue(text);
}

QString XmlOptionItem::readValue(const QString& defval) const
{
        // read value is present
        QDomElement item = this->findElemFromUid(mUid, mRoot);
        if (!item.isNull() && item.hasAttribute("value"))
        {
                return item.attribute("value");
        }
        return defval;
}

void XmlOptionItem::writeValue(const QString& val)
{
        if (mRoot.isNull())
                return;
        QDomElement item = findElemFromUid(mUid, mRoot);
        // create option if not present
        if (item.isNull())
        {
                item = mRoot.ownerDocument().createElement("option");
                item.setAttribute("id", mUid);
                mRoot.appendChild(item);
        }
        item.setAttribute("value", val);
}

QDomElement XmlOptionItem::findElemFromUid(const QString& uid, QDomNode root) const
{
        QDomNodeList settings = root.childNodes();
        for (int i = 0; i < settings.size(); ++i)
        {
                QDomElement item = settings.item(i).toElement();
                if (item.attribute("id") == uid)
                        return item;
        }
        return QDomElement();
}


XmlOptionFile XmlOptionFile::createNull()
{
        XmlOptionFile retval;
        retval.mDocument = QDomDocument();
        retval.mCurrentElement = QDomElement();
        return retval;
}

XmlOptionFile::XmlOptionFile()
{
        mDocument.appendChild(mDocument.createElement("root"));
        mCurrentElement = mDocument.documentElement();
}

XmlOptionFile::XmlOptionFile(QString filename) :
        mFilename(filename)
{
        mDocument = SharedDocuments::getInstance()->loadDocument(filename);

        mCurrentElement = mDocument.documentElement();

        if (mCurrentElement.isNull())
        {
                mDocument.appendChild(mDocument.createElement("root"));
                mCurrentElement = mDocument.documentElement();
        }
}

XmlOptionFile::~XmlOptionFile()
{
}

QString XmlOptionFile::getFileName()
{
        return mFilename;
}

bool XmlOptionFile::isNull() const
{
        if(mCurrentElement.isNull() || mDocument.isNull())
                return true;
        return false;
}

XmlOptionFile XmlOptionFile::root() const
{
        XmlOptionFile retval = *this;
        retval.mCurrentElement = mDocument.documentElement();
        return retval;
}

XmlOptionFile XmlOptionFile::descend(QString element) const
{
        XmlOptionFile retval = *this;
        retval.mCurrentElement = retval.getElement(element);
        return retval;
}

XmlOptionFile XmlOptionFile::descend(QString element, QString attributeName, QString attributeValue) const
{
        XmlOptionFile retval = this->tryDescend(element, attributeName, attributeValue);
        if (!retval.getDocument().isNull())
                return retval;

        // create a new element if not found
        retval = *this;
        QDomElement current = retval.getDocument().createElement(element);
        current.setAttribute(attributeName, attributeValue);
        retval.mCurrentElement.appendChild(current);
        retval.mCurrentElement = current;
        return retval;
}

XmlOptionFile XmlOptionFile::tryDescend(QString element, QString attributeName, QString attributeValue) const
{
        XmlOptionFile retval = *this;

        QDomNodeList presetNodeList = retval.getElement().elementsByTagName(element);
        for (int i = 0; i < presetNodeList.count(); ++i)
        {
                QDomElement current = presetNodeList.item(i).toElement();
                QString name = current.attribute(attributeName);
                if (attributeValue == name)
                {
                        retval.mCurrentElement = current;
                        return retval;
                }
        }

        return XmlOptionFile::createNull();
}

XmlOptionFile XmlOptionFile::ascend() const
{
        XmlOptionFile retval = *this;
        retval.mCurrentElement = mCurrentElement.parentNode().toElement();
        if (retval.mCurrentElement.isNull())
                return *this;
        return retval;
}

QDomElement XmlOptionFile::safeGetElement(QDomElement parent, QString childName)
{
        QDomElement child = parent.namedItem(childName).toElement();

        if (child.isNull())
        {
                child = mDocument.createElement(childName);
                parent.appendChild(child);
        }

        return child;
}

void XmlOptionFile::printDocument()
{
    printDocument(mDocument);
}

void XmlOptionFile::printElement()
{
    printElement(mCurrentElement);
}

void XmlOptionFile::printDocument(QDomDocument document)
{
    QTextStream stream(stdout);
    stream << "\nTEST" << document.toString(4) << "\n";
}

void XmlOptionFile::printElement(QDomElement element)
{
    QTextStream stream(stdout);
    stream << "\n";
    element.save(stream, 4);
    stream << "\n";
}

QDomDocument XmlOptionFile::getDocument()
{
        return mDocument;
}

QDomElement XmlOptionFile::getElement()
{
        return mCurrentElement;
}

QDomElement XmlOptionFile::getElement(QString level1)
{
        QDomElement elem1 = this->safeGetElement(mCurrentElement, level1);
        return elem1;
}

QDomElement XmlOptionFile::getElement(QString level1, QString level2)
{
        QDomElement elem1 = this->safeGetElement(mCurrentElement, level1);
        QDomElement elem2 = this->safeGetElement(elem1, level2);
        return elem2;
}

void XmlOptionFile::removeChildren()
{
        while (mCurrentElement.hasChildNodes())
                mCurrentElement.removeChild(mCurrentElement.firstChild());
}

void XmlOptionFile::deleteNode()
{
        QDomNode parentNode = mCurrentElement.parentNode();
        parentNode.removeChild(mCurrentElement);
        mCurrentElement = QDomElement();// Create null element
}

void XmlOptionFile::save()
{
        if (mFilename.isEmpty())
        {
                reportWarning("XmlOptionFile::save() No file name");
                return; //Don't do anything if on filename isn't supplied
        }

        QString path = QFileInfo(mFilename).absolutePath();
        QDir().mkpath(path);
        QFile file(mFilename);
        if (file.open(QIODevice::WriteOnly | QIODevice::Truncate))
        {
                QTextStream stream(&file);
                stream << mDocument.toString(4);
                file.close();
//              report("Created " + file.fileName());
        }
        else
        {
                reportError("XmlOptionFile::save() Could not open " + file.fileName() + " Error: "
                        + file.errorString());
        }
}


} // namespace cx