KReportDocument.cpp

/* This file is part of the KDE project
 * Copyright (C) 2007-2008 by Adam Pigg ([email protected])
 *
 * This library 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "KReportDocument.h"
#include "KReportUnit.h"
#include "KReportDetailSectionData.h"
#include "KReportItemBase.h"
#include "KReportUtils_p.h"
#include "KReportPageSize.h"
 
#include <QDomElement>
#include <QApplication>
#include "kreport_debug.h"
 
class Q_DECL_HIDDEN KReportDocument::Private
{
public:
    bool valid;
    QString title;
    QString name;
    QString query;
#ifdef KREPORT_SCRIPTING
    QString script;
    QString interpreter;
#endif
    bool externalData;
    KReportPrivate::PageLayout pageLayout;
    QString pageSize;
    QString labelType;
    
    KReportSectionData * pageHeaderFirst = nullptr;
    KReportSectionData * pageHeaderOdd = nullptr;
    KReportSectionData * pageHeaderEven = nullptr;
    KReportSectionData * pageHeaderLast = nullptr;
    KReportSectionData * pageHeaderAny = nullptr;
 
    KReportSectionData * reportHeader = nullptr;
    KReportSectionData * reportFooter = nullptr;
 
    KReportSectionData * pageFooterFirst = nullptr;
    KReportSectionData * pageFooterOdd = nullptr;
    KReportSectionData * pageFooterEven = nullptr;
    KReportSectionData * pageFooterLast = nullptr;
    KReportSectionData * pageFooterAny = nullptr;
 
    KReportDetailSectionData* detailSection = nullptr;
};
 
KReportDocument::KReportDocument(QObject *parent)
        : QObject(parent),
        d(new Private)
{
    d->valid = true;
}
 
KReportDocument::KReportDocument(const QDomElement & elemSource, QObject *parent)
        : QObject(parent),
        d(new Private)
{
    d->valid = false;
 
    if (elemSource.tagName() != QLatin1String("report:content")) {
        kreportWarning() << "QDomElement is not <report:content> tag"
                   << elemSource.text();
        return;
    }
    
    QDomNodeList sections = elemSource.childNodes();
    for (int nodeCounter = 0; nodeCounter < sections.count(); nodeCounter++) {
        QDomElement elemThis = sections.item(nodeCounter).toElement();
        if (elemThis.tagName() == QLatin1String("report:title")) {
            d->title = elemThis.text();
#ifdef KREPORT_SCRIPTING
        } else if (elemThis.tagName() == QLatin1String("report:script")) {
            d->script = elemThis.text();
            d->interpreter = elemThis.attribute(QLatin1String("report:script-interpreter"));
#endif
        } else if (elemThis.tagName() == QLatin1String("report:page-style")) {            
            QString pagetype = elemThis.firstChild().nodeValue();
 
            //Full page mode is required to allow margins to be set to whatever the user has specified
            d->pageLayout.setMode(QPageLayout::FullPageMode);
            
            if (pagetype == QLatin1String("predefined")) {
                setPageSize(elemThis.attribute(QLatin1String("report:page-size"), QLatin1String("A4")));
                d->pageLayout.setPageSize(QPageSize(KReportPageSize::pageSize(pageSize())));
            } else if (pagetype == QLatin1String("custom")) {
                kreportDebug() << "Setting custom page size in document to " << KReportUnit::parseValue(elemThis.attribute(QLatin1String("report:custom-page-width"), QLatin1String("5.0cm"))) << KReportUnit::parseValue(elemThis.attribute(QLatin1String("report:custom-page-height"), QLatin1String("5.0cm"))) ;
                QPageSize custom(QSize(KReportUnit::parseValue(elemThis.attribute(QLatin1String("report:custom-page-width"), QLatin1String("5.0cm")))  , KReportUnit::parseValue(elemThis.attribute(QLatin1String("report:custom-page-height"), QLatin1String("5.0cm"))) ), QString(), QPageSize::ExactMatch);
 
                d->pageLayout.setPageSize(custom);
            } else if (pagetype == QLatin1String("label")) {
                setLabelType(elemThis.firstChild().nodeValue());
            }
            //! @todo add config for default margins or add within templates support
            d->pageLayout.setUnits(QPageLayout::Point);
            d->pageLayout.setLeftMargin(KReportUnit::parseValue(elemThis.attribute(
                QLatin1String("fo:margin-left"), DEFAULT_PAGE_MARGIN_STRING)));
            d->pageLayout.setRightMargin(KReportUnit::parseValue(elemThis.attribute(
                QLatin1String("fo:margin-right"), DEFAULT_PAGE_MARGIN_STRING)));
            d->pageLayout.setTopMargin(KReportUnit::parseValue(elemThis.attribute(
                QLatin1String("fo:margin-top"), DEFAULT_PAGE_MARGIN_STRING)));
            d->pageLayout.setBottomMargin(KReportUnit::parseValue(elemThis.attribute(
                QLatin1String("fo:margin-bottom"), DEFAULT_PAGE_MARGIN_STRING)));
            d->pageLayout.setOrientation(
                elemThis.attribute(QLatin1String("report:print-orientation"),
                                   QLatin1String("portrait"))
                        == QLatin1String("portrait")
                    ? QPageLayout::Portrait
                    : QPageLayout::Landscape);
        } else if (elemThis.tagName() == QLatin1String("report:body")) {
            QDomNodeList sectionlist = elemThis.childNodes();
            QDomNode sec;
 
            for (int s = 0; s < sectionlist.count(); ++s) {
                sec = sectionlist.item(s);
                if (sec.isElement()) {
                    QString sn = sec.nodeName().toLower();
                    //kreportDebug() << sn;
                    if (sn == QLatin1String("report:section")) {
                        KReportSectionData * sd = new KReportSectionData(sec.toElement(), this);
                        if (!sd->isValid()) {
                            kreportDebug() << "Invalid section";
                            delete sd;
                        } else {
                            //kreportDebug() << "Adding section of type " << sd->type();
                            switch (sd->type()) {
                            case KReportSectionData::Type::PageHeaderFirst:
                                d->pageHeaderFirst = sd;
                                break;
                            case KReportSectionData::Type::PageHeaderOdd:
                                d->pageHeaderOdd = sd;
                                break;
                            case KReportSectionData::Type::PageHeaderEven:
                                d->pageHeaderEven = sd;
                                break;
                            case KReportSectionData::Type::PageHeaderLast:
                                d->pageHeaderLast = sd;
                                break;
                            case KReportSectionData::Type::PageHeaderAny:
                                d->pageHeaderAny = sd;
                                break;
                            case KReportSectionData::Type::ReportHeader:
                                d->reportHeader = sd;
                                break;
                            case KReportSectionData::Type::ReportFooter:
                                d->reportFooter = sd;
                                break;
                            case KReportSectionData::Type::PageFooterFirst:
                                d->pageFooterFirst = sd;
                                break;
                            case KReportSectionData::Type::PageFooterOdd:
                                d->pageFooterOdd = sd;
                                break;
                            case KReportSectionData::Type::PageFooterEven:
                                d->pageFooterEven = sd;
                                break;
                            case KReportSectionData::Type::PageFooterLast:
                                d->pageFooterLast = sd;
                                break;
                            case KReportSectionData::Type::PageFooterAny:
                                d->pageFooterAny = sd;
                                break;
                            default:
                                ;
                            }
                        }
 
                    } else if (sn == QLatin1String("report:detail")) {
                        KReportDetailSectionData * dsd = new KReportDetailSectionData(sec.toElement(), this);
 
                        if (dsd->isValid()) {
                            d->detailSection = dsd;
                        } else {
                            kreportDebug() << "Invalid detail section";
                            delete dsd;
                        }
                    }
                } else {
                    kreportWarning() << "Encountered an unknown Element: "  << elemThis.tagName();
                }
            }
        }
 
        d->valid = true;
    }
}
 
KReportDocument::~KReportDocument()
{
    delete d;
}
 
QList<KReportItemBase*> KReportDocument::objects() const
{
    QList<KReportItemBase*> obs;
    for (int i = static_cast<int>(KReportSectionData::Type::PageHeaderFirst);
         i <= static_cast<int>(KReportSectionData::Type::PageFooterAny); i++)
    {
        KReportSectionData *sec = section(static_cast<KReportSectionData::Type>(i));
        if (sec) {
            obs << sec->objects();
        }
    }
 
    if (d->detailSection) {
        //kreportDebug() << "Number of groups: " << m_detailSection->m_groupList.count();
        foreach(KReportDetailGroupSectionData* g, d->detailSection->groupList) {
            if (g->groupHeader) {
                obs << g->groupHeader->objects();
            }
            if (g->groupFooter) {
                obs << g->groupFooter->objects();
            }
        }
        if (d->detailSection->detailSection)
            obs << d->detailSection->detailSection->objects();
    }
 
    /*kreportDebug() << "Object List:";
    foreach(KReportItemBase* o, obs) {
        kreportDebug() << o->entityName();
    }*/
    return obs;
}
 
KReportItemBase* KReportDocument::object(const QString& n) const
{
    QList<KReportItemBase*> obs = objects();
 
    foreach(KReportItemBase* o, obs) {
        if (o->entityName() == n) {
            return o;
        }
    }
    return nullptr;
}
 
QList<KReportSectionData*> KReportDocument::sections() const
{
    QList<KReportSectionData*> secs;
    for (int i = static_cast<int>(KReportSectionData::Type::PageHeaderFirst);
         i <= static_cast<int>(KReportSectionData::Type::PageFooterAny); i++)
    {
        KReportSectionData *sec = section(static_cast<KReportSectionData::Type>(i));
        if (sec) {
            secs << sec;
        }
    }
 
    if (d->detailSection) {
        //kreportDebug() << "Number of groups: " << m_detailSection->m_groupList.count();
        foreach(KReportDetailGroupSectionData* g, d->detailSection->groupList) {
            if (g->groupHeader) {
                secs << g->groupHeader;
            }
            if (g->groupFooter) {
                secs << g->groupFooter;
            }
        }
        if (d->detailSection->detailSection)
            secs << d->detailSection->detailSection;
    }
 
    return secs;
}
 
KReportSectionData* KReportDocument::section(const QString& sn) const
{
    QList<KReportSectionData*> secs = sections();
 
    foreach(KReportSectionData *sec, secs) {
        if (sec->name() == sn) {
            return sec;
        }
    }
    return nullptr;
}
 
KReportSectionData* KReportDocument::section(KReportSectionData::Type type) const
{
    KReportSectionData *sec;
    switch (type) {
    case KReportSectionData::Type::PageHeaderAny:
        sec = d->pageHeaderAny;
        break;
    case KReportSectionData::Type::PageHeaderEven:
        sec = d->pageHeaderEven;
        break;
    case KReportSectionData::Type::PageHeaderOdd:
        sec = d->pageHeaderOdd;
        break;
    case KReportSectionData::Type::PageHeaderFirst:
        sec = d->pageHeaderFirst;
        break;
    case KReportSectionData::Type::PageHeaderLast:
        sec = d->pageHeaderLast;
        break;
    case KReportSectionData::Type::PageFooterAny:
        sec = d->pageFooterAny;
        break;
    case KReportSectionData::Type::PageFooterEven:
        sec = d->pageFooterEven;
        break;
    case KReportSectionData::Type::PageFooterOdd:
        sec = d->pageFooterOdd;
        break;
    case KReportSectionData::Type::PageFooterFirst:
        sec = d->pageFooterFirst;
        break;
    case KReportSectionData::Type::PageFooterLast:
        sec = d->pageFooterLast;
        break;
    case KReportSectionData::Type::ReportHeader:
        sec = d->reportHeader;
        break;
    case KReportSectionData::Type::ReportFooter:
        sec = d->reportFooter;
        break;
    default:
        sec = nullptr;
    }
    return sec;
}
 
QPageLayout KReportDocument::pageLayout() const
{
    return d->pageLayout;
}
 
bool KReportDocument::isValid() const
{
    return d->valid;
}
 
QString KReportDocument::title() const
{
    return d->title;
}
 
bool KReportDocument::externalData() const
{
    return d->externalData;
}
 
#ifdef KREPORT_SCRIPTING
QString KReportDocument::script() const
{
    return d->script;
}
 
QString KReportDocument::interpreter() const
{
    return d->interpreter;
}
#endif
 
QString KReportDocument::name() const
{
    return d->name;
}
 
void KReportDocument::setName(const QString& n)
{
    d->name = n;
}
 
QString KReportDocument::query() const
{
    return d->query;
}
 
QString KReportDocument::pageSize()
{
    return d->pageSize;
}
 
void KReportDocument::setPageSize(const QString& size)
{
    d->pageSize = size;
}
 
QString KReportDocument::labelType() const
{
    return d->labelType;
}
 
void KReportDocument::setLabelType(const QString& label)
{
    d->labelType = label;
}
 
KReportDetailSectionData * KReportDocument::detail() const
{
    return d->detailSection;
}