/* This file is part of the KDE project SPDX-FileCopyrightText: 2017 Dag Andersen SPDX-License-Identifier: LGPL-2.0-or-later */ // clazy:excludeall=qstring-arg #include "planmodels_export.h" #include "ReportGeneratorOdt.h" #include "ReportGeneratorDebug.h" #include "kptproject.h" #include "kptschedule.h" #include "kptnodeitemmodel.h" #include "kpttaskstatusmodel.h" #include "kptitemmodelbase.h" #include "kptnodechartmodel.h" #include "kptschedulemodel.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace KPlato { bool addDataToFile(QByteArray &buffer, const QString &destName, KoStore &to) { QBuffer file(&buffer); if (!file.open(QIODevice::ReadOnly)) { dbgRG<<"Failed to open buffer"; return false; } if (!to.open(destName)) { dbgRG<<"Failed to open file for writing:"< 0; total += block) { data.resize(block); if (to.write(data) != block) { dbgRG<<"Failed to write block of data"; return false; } data.resize(8*1024); } to.close(); file.close(); return true; } //-------------------------------------- ReportGeneratorOdt::ReportGeneratorOdt() : ReportGenerator() , m_templateStore(nullptr) { } ReportGeneratorOdt::~ReportGeneratorOdt() { for (QAbstractItemModel *m : std::as_const(m_datamodels)) { if (!m_basemodels.contains(qobject_cast(m))) { delete m; } } qDeleteAll(m_basemodels); delete m_templateStore; } bool ReportGeneratorOdt::initiateInternal() { if (m_templateStore) { delete m_templateStore; } m_templateStore = KoStore::createStore(m_templateFile, KoStore::Read); if (!m_templateStore) { dbgRG<<"Failed to open store:"<urlOfStore(); KoOdfReadStore reader(m_templateStore); if (!reader.loadAndParse(m_lastError)) { dbgRG<<"Failed to loadAndParse:"<endElement(); // office:document-content writer->endDocument(); if (!outStore->addDataToFile(buffer.buffer(), QStringLiteral("content.xml"))) { dbgRG<<"Failed to open 'content.xml' for writing"; m_lastError = i18n("Failed to write to store: %1", QStringLiteral("content.xml")); delete writer; delete outStore; return false; } buffer.close(); if (m_manifestfiles.contains(QStringLiteral("styles.xml"))) { dbgRG << '\n' << "---- treat styles.xml (for master-page headers/footers) ----" << '\n'; QBuffer buffer2; KoXmlWriter *styles = createOasisXmlWriter(reader, &buffer2, QStringLiteral("styles.xml"), "office:document-styles"); if (!styles) { dbgRG<<"Failed to create styles.xml writer"; return false; } KoXmlDocument stylesDoc; if (!reader.loadAndParse("styles.xml", stylesDoc, m_lastError)) { debugPlan<<"Failed to read styles.xml"<endElement(); // office:document-styles styles->endDocument(); if (!outStore->addDataToFile(buffer2.buffer(), QStringLiteral("styles.xml"))) { dbgRG<<"Failed to open 'styles.xml' for writing"; m_lastError = i18n("Failed to write to store: %1", QStringLiteral("styles.xml")); delete writer; delete outStore; } m_manifestfiles.removeAt(m_manifestfiles.indexOf(QStringLiteral("styles.xml"))); } dbgRG << '\n' << "---- treat the embedded files ----" << '\n'; treatEmbededObjects(reader, *outStore); dbgRG << '\n' << "---- copy rest of files ----" << '\n'; for (int i = 0; i < m_manifestfiles.count(); ++i) { copyFile(*reader.store(), *outStore, m_manifestfiles.at(i)); } if (!outStore->finalize()) { dbgRG<<"Failed to write store:"<urlOfStore(); m_lastError = i18n("Failed to write report file: %1", outStore->urlOfStore().path()); delete writer; delete outStore; return false; } delete writer; delete outStore; dbgRG<<"finished"; return true; } bool ReportGeneratorOdt::handleTextP(KoXmlWriter &writer, const KoXmlElement &textp) { Q_UNUSED(writer); dbgRG<<"Check:"<finish(); dbgRG<<"Found:"<type + QLatin1Char('.') + field->dataName; field->setModel(dataModel(modelName), m_headerrole[modelName]); dbgRGChart<<"Found chart:"<seqNr = USERFIELD_NONE; dbgRGTable<type != QStringLiteral("table")) { return false; } dbgRGTable; UserField *field = m_userfields[m_activefields.last()]; field->seqNr = USERFIELD_HEADER; // we are in header row return false; } bool ReportGeneratorOdt::treatTableRow(KoXmlWriter &writer, const KoXmlElement &rowElement) { if (m_activefields.isEmpty() || m_userfields[m_activefields.last()]->type != QStringLiteral("table")) { return false; } UserField *field = m_userfields[m_activefields.last()]; dbgRGTable<seqNr; if (field->seqNr == USERFIELD_NONE) { // there is no header row, so start with data rows directly field->seqNr = USERFIELD_DATA; } if (field->seqNr == USERFIELD_HEADER) { // header row writer.startElement("table:table-row"); writeElementAttributes(writer, rowElement); writeChildElements(writer, rowElement); writer.endElement(); field->seqNr = USERFIELD_DATA; // next is first row } else { dbgRGTable<<" add rows:"<rowCount(); for (field->begin(); field->next();) { writer.startElement("table:table-row"); writeElementAttributes(writer, rowElement); writeChildElements(writer, rowElement); writer.endElement(); } field->finish(); } return true; } ReportGeneratorOdt::UserField *ReportGeneratorOdt::findUserField(const KoXmlElement &decl) const { UserField *field = nullptr; QString name = decl.attributeNS(KoXmlNS::text, "name"); // eg: table1 or table1.Type or project.name or tr.bcws field = m_userfields.value(name); // if Variable or Translation if (!field) { QStringList lst = name.split(QLatin1Char('.')); QMap::const_iterator it; for (it = m_userfields.constBegin(); it != m_userfields.constEnd(); ++it) { if (lst.first().startsWith(it.key())) { field = it.value(); break; } } } return field; } void ReportGeneratorOdt::treatUserFieldGet(KoXmlWriter &writer, const KoXmlElement &e) { dbgRG<variant() == UserField::Rows) { QString name = e.attributeNS(KoXmlNS::text, "name"); // eg: table1.type QString value = e.text(); // eg: type or name QString data = field->data(value); writer.addTextNode(data); dbgRGTable<<"rows:"<variant() == UserField::Header) { QString name = e.attributeNS(KoXmlNS::text, "name"); // eg: table1.type QString value = e.text(); // eg: type or BCWS Cost QString data = field->headerData(value); writer.addTextNode(data); dbgRGTable<<"header row:"<variant() == UserField::Variable) { QString name = e.attributeNS(KoXmlNS::text, "name"); // eg: project.name dbgRGVariable<<"variable:"<columns.value(0)<data(field->columns.value(0)); writer.addTextNode(field->data(field->columns.value(0))); // a variable has only one column } else if (field->variant() == UserField::Translation) { QString name = e.attributeNS(KoXmlNS::text, "name"); // eg: tr.bcws QString data = i18n(field->dataName.toLatin1().constData()); if (field->headerNames.contains(field->dataName)) { data = field->data(field->dataName); } dbgRGTr<<"translation:"<dataName<<'='<name = name; m_userfields[field->name] = field; field->dataName = value; field->seqNr = USERFIELD_TRANSLATION; field->columns << value; field->setModel(dataModel(QStringLiteral("tr")), m_headerrole[QStringLiteral("tr")]); dbgRGTr<<" added translation"<name<dataName; } else if (m_variables.contains(tags.first())) { Q_ASSERT(tags.count() >= 2); Q_ASSERT(!m_userfields.contains(tags.first())); UserField *field = new UserField(); field->name = name; m_userfields[field->name] = field; field->dataName = tags.first(); field->seqNr = USERFIELD_VARIABLE; QStringList vl = value.split(QLatin1Char(';')); if (!vl.isEmpty()) { field->columns << vl.takeFirst(); field->properties = vl; } field->setModel(dataModel(field->dataName), m_headerrole[field->dataName]); dbgRGVariable<<" added variable"<name<columns<properties; } else { for (const QString &k : std::as_const(m_keys)) { const QString vname = tags.first(); if (!vname.startsWith(k)) { continue; } if (tags.count() == 1) { // this is the main definition (eg: name: "table1", value: "project; values=bcws effort, bcwp effort, acwp effort;") if (!m_userfields.contains(vname)) { m_userfields[vname] = new UserField(); } UserField *field = m_userfields[vname]; field->name = vname; field->type = k; QStringList vl = trimmed(value.toLower().split(QLatin1Char(';'), Qt::SkipEmptyParts)); field->dataName = vl.takeFirst(); field->properties += vl; field->setModel(dataModel(field->dataName), m_headerrole[field->dataName]); if (k == QStringLiteral("chart")) { dbgRGChart<<" "<<"added tag:"<properties; } else { dbgRG<<" "<<"added tag:"<properties; } } else { // this is the fields column definitions (eg: name: "table1.type" value: "") if (!m_userfields.contains(vname)) { m_userfields[vname] = new UserField(); UserField *field = m_userfields[vname]; field->name = vname; } UserField *field = m_userfields[vname]; field->columns << value.trimmed().toLower(); Q_ASSERT(field->name == vname); dbgRG<<" "<<"added column:"<name<columns; } } } } writer.startElement("text:user-field-decls"); writeElementAttributes(writer, decls); writeChartElements(writer, decls); writer.endElement(); } void ReportGeneratorOdt::writeElementAttributes(KoXmlWriter &writer, const KoXmlElement &element, const QStringList &exclude) { const auto elements = element.attributeFullNames(); for (const QPair &a : elements) { QString prefix = QLatin1String(KoXmlNS::nsURI2NS(a.first)); if (prefix.isEmpty()) { dbgRG<<" Skipping unknown namespace:"<"<hasFile("META-INF/manifest.xml")) { dbgRG<<"No manifest file"; return nullptr; } KoXmlDocument manifest; if (!reader.loadAndParse("META-INF/manifest.xml", manifest, m_lastError)) { dbgRG<<"Failed to read manifest:"<hasFile("mimetype")) { if (!copyFile(*reader.store(), *out, "mimetype")) { if (!m_lastError.isEmpty()) { m_lastError.prepend(QLatin1String("\n\n")); } m_lastError.prepend(i18n("Failed to load mimetype file")); delete out; return nullptr; } } if (!copyFile(*reader.store(), *out, "META-INF/manifest.xml")) { if (!m_lastError.isEmpty()) { m_lastError.prepend(QLatin1String("\n\n")); } m_lastError.prepend(i18n("Failed to write manifest file")); delete out; return nullptr; } KoXmlElement e; forEachElement(e, manifest.documentElement()) { dbgRG<hasFile(fileName); if (reader.store()->isOpen()) { reader.store()->close(); } if (!reader.store()->open(fileName)) { dbgRG << "Entry " << fileName << " not found!"; m_lastError = xi18nc("@info", "Failed to open file %1 from store.", fileName); return nullptr; } if (!reader.store()->device()->isOpen()) { reader.store()->device()->open(QIODevice::ReadOnly); } KoXmlWriter *writer = nullptr; QXmlStreamReader xml(reader.store()->device()); xml.setNamespaceProcessing(true); while (!xml.atEnd()) { xml.readNext(); if (xml.tokenType() == QXmlStreamReader::StartElement && !xml.namespaceDeclarations().isEmpty()) { writer = new KoXmlWriter(buffer); writer->startDocument(rootElementName); writer->startElement(rootElementName); writer->addAttribute("xmlns:calligra", KoXmlNS::calligra); // Note: windows needs this type of iteration QXmlStreamNamespaceDeclarations dcl = xml.namespaceDeclarations(); for (int ns = 0; ns < dcl.count(); ++ns) { dbgRGTmp<<"add namespace:"<<(QStringLiteral("xmlns:") + dcl[ns].prefix())<addAttribute((QStringLiteral("xmlns:") + dcl[ns].prefix()).toLatin1().constData(), dcl[ns].namespaceUri().toUtf8()); } QXmlStreamAttributes attr = xml.attributes(); for (int a = 0; a < attr.count(); ++a) { dbgRGTmp<<"add attribute:"<addAttribute(attr[a].qualifiedName().toLatin1().constData(), attr[a].value().toUtf8()); } } } reader.store()->close(); if (!writer) { dbgRG<<"Failed to find a start element with namespace declarations in"<%1", fileName); } return writer; } void ReportGeneratorOdt::treatEmbededObjects(KoOdfReadStore &reader, KoStore &outStore) { dbgRGChart; {QMap::const_iterator it; for (it = m_embededcharts.constBegin(); it != m_embededcharts.constEnd(); ++it) { treatChart(reader, outStore, it.key(), it.value()); }} {QMap::const_iterator it; for (it = m_embededgantts.constBegin(); it != m_embededgantts.constEnd(); ++it) { treatGantt(reader, outStore, it.key(), it.value()); }} } void ReportGeneratorOdt::treatChart(KoOdfReadStore &reader, KoStore &outStore, const QString &name, const QString &dir) { dbgRGChart<dataName == QStringLiteral("project")) { ChartItemModel *m = findChartItemModel(field->model); if (m) { m->setNodes(QList() << m_project); } if (field->properties.isEmpty()) { // default: take all for (const QString &c : std::as_const(field->headerNames)) { field->columns << c; } } else { QStringList values; for (const QString &p : std::as_const(field->properties)) { if (p.startsWith(QStringLiteral("values"))) { QStringList vl = p.split(QStringLiteral("=")); Q_ASSERT(vl.count() > 1); Q_ASSERT(vl.at(0) == QStringLiteral("values")); const auto strings = vl.at(1).split(QLatin1Char(',')); for (const auto &v : strings) { values << v.toLower().trimmed(); } } } field->columns = values; } dbgRGChart<endElement(); // office:document-content writer->endDocument(); dbgRGChart<toString(); if (!outStore.addDataToFile(buffer.buffer(), file)) { dbgRGChart<<"Failed to open"<hasLabels = e.attributeNS(KoXmlNS::chart, "data-source-has-labels"); writer.startElement(tag.constData()); writeElementAttributes(writer, e); writeChartElements(writer, e); writer.endElement(); } else if (tag == "chart:categories") { // assume this is x-axis UserField *field = m_userfields[m_activefields.last()]; int columns = field->columnCount(); if (columns > 0) { writer.startElement(tag.constData()); writeElementAttributes(writer, e, QStringList() << QStringLiteral("table:cell-range-address")); int startRow = 1; if (field->hasLabels == QStringLiteral("both") || field->hasLabels == QStringLiteral("primary-x")) { ++startRow; } QString end = QStringLiteral("local-table.$A$%1:$A$%2").arg(startRow).arg(startRow+field->rowCount()-1); writer.addAttribute("table:cell-range-address", end); writeChartElements(writer, e); writer.endElement(); } } else if (tag == "chart:series") { UserField *field = m_userfields[m_activefields.last()]; int columns = field->columnCount(); if (columns > 0 && field->serieNr < columns) { int startRow = 1; if (field->hasLabels == QStringLiteral("both") || field->hasLabels == QStringLiteral("primary-x")) { ++startRow; } char startColumn = 'A'; if (field->hasLabels == QStringLiteral("both") || field->hasLabels == QStringLiteral("primary-y")) { ++startColumn; } writer.startElement(tag.constData()); writeElementAttributes(writer, e, QStringList() << QStringLiteral("chart:values-cell-range-address")<serieNr); QString lab = QStringLiteral("local-table.$%1$1").arg(c); writer.addAttribute("chart:values-cell-address", lab); QString end = QStringLiteral("local-table.$%1$%2:$%1$%3").arg(c).arg(startRow).arg(startRow+field->rowCount()-1); writer.addAttribute("chart:values-cell-range-address", end); writer.startElement("chart:data-point"); writer.addAttribute("chart:repeated", field->rowCount()); writer.endElement(); writer.endElement(); ++field->serieNr; } } else if (tag == "chart:data-point") { // do nothing handled under chart:series } else if (tag == "table:table-header-columns") { writer.startElement(tag.constData()); writer.startElement("table:table-column"); // just an empty tag writer.endElement(); writer.endElement(); } else if (tag == "table:table-columns") { writer.startElement(tag.constData()); writeChartElements(writer, e); writer.endElement(); } else if (tag == "table:table-column") { int columns = m_userfields[m_activefields.last()]->columnCount(); writer.startElement(tag.constData()); writer.addAttribute("table:number-columns-repeated", columns); writer.endElement(); } else if (tag == "table:table-header-rows") { writer.startElement(tag.constData()); writer.startElement("table:table-row"); // first column not used, just an empty cell writer.startElement("table:table-cell"); writer.startElement("text:p"); writer.endElement(); writer.endElement(); // write legends UserField *field = m_userfields[m_activefields.last()]; for (const QString &name : std::as_const(field->columns)) { QString value = field->headerData(name); writer.startElement("table:table-cell"); writer.addAttribute("office:value-type", "string"); writer.startElement("text:p"); writer.addTextNode(value); writer.endElement(); writer.endElement(); } writer.endElement(); writer.endElement(); } else if (tag == "table:table-rows") { writer.startElement(tag.constData()); UserField *field = m_userfields[m_activefields.last()]; int columns = field->columnCount(); if (columns > 0) { int rows = field->model.rowCount(); for (int r = 0; r < rows; ++r) { writer.startElement("table:table-row"); // first x-axis labels QDate date = QDate(field->model.headerData(r, Qt::Vertical, Qt::EditRole).toDate()); // NOTE: 1899-12-30 is the reference date, but could it depend on style? int day = QDate(1899, 12, 30).daysTo(date); writer.startElement("table:table-cell"); writer.addAttribute("office:value", day); writer.addAttribute("office:value-type", "float"); writer.startElement("text:p"); writer.addTextNode(QString::number(day)); writer.endElement(); writer.endElement(); // then the data for (const QString &name : std::as_const(field->columns)) { QVariant value = field->model.index(r, field->column(name)).data(); writer.startElement("table:table-cell"); writer.addAttribute("office:value-type", "float"); writer.addAttribute("office:value", value.toDouble()); writer.startElement("text:p"); writer.addTextNode(QString::number(value.toDouble())); writer.endElement(); writer.endElement(); } writer.endElement(); } } writer.endElement(); } else if (tag == "chart:legend") { writer.startElement(tag.constData()); if (!e.hasAttributeNS(KoXmlNS::chart, "legend-align") && e.hasAttributeNS(KoXmlNS::chart, "legend-position")) { // lowriter does not specify this attribute // If legend-position is start, end, top or bottom // we need to have legend-align == center so that words // repositions the legend correctly QStringList lst = QStringList() << QStringLiteral("start") << QStringLiteral("end") << QStringLiteral("top") << QStringLiteral("bottom"); if (lst.contains(e.attributeNS(KoXmlNS::chart, "legend-position"))) { writer.addAttribute("chart:legend-align", "center"); dbgRGChart<<"adding legend-align"; } } writeElementAttributes(writer, e); writeChartElements(writer, e); writer.endElement(); } else { writer.startElement(tag.constData()); writeElementAttributes(writer, e); writeChartElements(writer, e); writer.endElement(); } } } void ReportGeneratorOdt::listChildNodes(const QDomNode &parent) { QDomNodeList lst = parent.childNodes(); for (int i = 0; i < lst.count(); ++i) { if (lst.at(i).isElement()) { QDomElement e = lst.at(i).toElement(); dbgRG<<"Element:"<model.setSourceModel(model); for (int c = 0; c < this->model.columnCount(); ++c) { headerNames << this->model.headerData(c, Qt::Horizontal, role).toString().toLower(); } } int ReportGeneratorOdt::UserField::column(const QString &columnName) const { QStringList l = columnName.split(QLatin1Char('.')); int c = l.isEmpty() ? -1 : headerNames.indexOf(l.last().toLower()); dbgRGTable<<" column:"< USERFIELD_NONE) { seqNr = USERFIELD_NONE; } } QString ReportGeneratorOdt::UserField::data(const QString &column) const { QModelIndex idx; if (currentIndex.isValid()) { idx = model.index(currentIndex.row(), this->column(column), currentIndex.parent()); } else { idx = model.index(0, this->column(column)); } QString s = QStringLiteral("No data"); if (idx.isValid()) { s = model.data(idx).toString(); } dbgRG<