/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ /* Warning: The SvXMLElementExport helper class creates the beginning and closing tags of xml elements in its constructor and destructor, so there's hidden stuff going on, on occasion the ordering of these classes declarations may be significant */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace ::com::sun::star::beans; using namespace ::com::sun::star::document; using namespace ::com::sun::star::lang; using namespace ::com::sun::star::uno; using namespace ::com::sun::star; using namespace ::xmloff::token; namespace { bool IsInPrivateUseArea(sal_uInt32 cChar) { return 0xE000 <= cChar && cChar <= 0xF8FF; } sal_uInt32 ConvertMathToMathML(std::u16string_view rText, sal_Int32 nIndex = 0) { auto cRes = o3tl::iterateCodePoints(rText, &nIndex); if (IsInPrivateUseArea(cRes)) { SAL_WARN("starmath", "Error: private use area characters should no longer be in use!"); cRes = u'@'; // just some character that should easily be notice as odd in the context } return cRes; } } bool SmXMLExportWrapper::Export(SfxMedium& rMedium) { bool bRet = true; uno::Reference xContext(comphelper::getProcessComponentContext()); //Get model uno::Reference xModelComp = xModel; bool bEmbedded = false; SmModel* pModel = comphelper::getFromUnoTunnel(xModel); SmDocShell* pDocShell = pModel ? static_cast(pModel->GetObjectShell()) : nullptr; if (pDocShell && SfxObjectCreateMode::EMBEDDED == pDocShell->GetCreateMode()) bEmbedded = true; uno::Reference xStatusIndicator; if (!bEmbedded) { if (pDocShell /*&& pDocShell->GetMedium()*/) { OSL_ENSURE(pDocShell->GetMedium() == &rMedium, "different SfxMedium found"); const SfxUnoAnyItem* pItem = rMedium.GetItemSet().GetItem(SID_PROGRESS_STATUSBAR_CONTROL); if (pItem) pItem->GetValue() >>= xStatusIndicator; } // set progress range and start status indicator if (xStatusIndicator.is()) { sal_Int32 nProgressRange = bFlat ? 1 : 3; xStatusIndicator->start(SmResId(STR_STATSTR_WRITING), nProgressRange); } } static constexpr OUString sUsePrettyPrinting(u"UsePrettyPrinting"_ustr); static constexpr OUString sBaseURI(u"BaseURI"_ustr); static constexpr OUString sStreamRelPath(u"StreamRelPath"_ustr); static constexpr OUString sStreamName(u"StreamName"_ustr); // create XPropertySet with three properties for status indicator static const comphelper::PropertyMapEntry aInfoMap[] = { { sUsePrettyPrinting, 0, cppu::UnoType::get(), beans::PropertyAttribute::MAYBEVOID, 0 }, { sBaseURI, 0, ::cppu::UnoType::get(), beans::PropertyAttribute::MAYBEVOID, 0 }, { sStreamRelPath, 0, ::cppu::UnoType::get(), beans::PropertyAttribute::MAYBEVOID, 0 }, { sStreamName, 0, ::cppu::UnoType::get(), beans::PropertyAttribute::MAYBEVOID, 0 } }; uno::Reference xInfoSet( comphelper::GenericPropertySet_CreateInstance(new comphelper::PropertySetInfo(aInfoMap))); bool bUsePrettyPrinting = bFlat || officecfg::Office::Common::Save::Document::PrettyPrinting::get(); xInfoSet->setPropertyValue(sUsePrettyPrinting, Any(bUsePrettyPrinting)); // Set base URI xInfoSet->setPropertyValue(sBaseURI, Any(rMedium.GetBaseURL(true))); sal_Int32 nSteps = 0; if (xStatusIndicator.is()) xStatusIndicator->setValue(nSteps++); if (!bFlat) //Storage (Package) of Stream { uno::Reference xStg = rMedium.GetOutputStorage(); bool bOASIS = (SotStorage::GetVersion(xStg) > SOFFICE_FILEFORMAT_60); // TODO/LATER: handle the case of embedded links gracefully if (bEmbedded) //&& !pStg->IsRoot() ) { OUString aName; const SfxStringItem* pDocHierarchItem = rMedium.GetItemSet().GetItem(SID_DOC_HIERARCHICALNAME); if (pDocHierarchItem) aName = pDocHierarchItem->GetValue(); if (!aName.isEmpty()) { xInfoSet->setPropertyValue(sStreamRelPath, Any(aName)); } } if (!bEmbedded) { if (xStatusIndicator.is()) xStatusIndicator->setValue(nSteps++); bRet = WriteThroughComponent(xStg, xModelComp, "meta.xml", xContext, xInfoSet, (bOASIS ? "com.sun.star.comp.Math.XMLOasisMetaExporter" : "com.sun.star.comp.Math.XMLMetaExporter")); } if (bRet) { if (xStatusIndicator.is()) xStatusIndicator->setValue(nSteps++); bRet = WriteThroughComponent(xStg, xModelComp, "content.xml", xContext, xInfoSet, "com.sun.star.comp.Math.XMLContentExporter"); } if (bRet) { if (xStatusIndicator.is()) xStatusIndicator->setValue(nSteps++); bRet = WriteThroughComponent(xStg, xModelComp, "settings.xml", xContext, xInfoSet, (bOASIS ? "com.sun.star.comp.Math.XMLOasisSettingsExporter" : "com.sun.star.comp.Math.XMLSettingsExporter")); } } else { SvStream* pStream = rMedium.GetOutStream(); uno::Reference xOut(new utl::OOutputStreamWrapper(*pStream)); if (xStatusIndicator.is()) xStatusIndicator->setValue(nSteps++); bRet = WriteThroughComponent(xOut, xModelComp, xContext, xInfoSet, "com.sun.star.comp.Math.XMLContentExporter"); } if (xStatusIndicator.is()) xStatusIndicator->end(); return bRet; } /// export through an XML exporter component (output stream version) bool SmXMLExportWrapper::WriteThroughComponent(const Reference& xOutputStream, const Reference& xComponent, Reference const& rxContext, Reference const& rPropSet, const char* pComponentName) { OSL_ENSURE(xOutputStream.is(), "I really need an output stream!"); OSL_ENSURE(xComponent.is(), "Need component!"); OSL_ENSURE(nullptr != pComponentName, "Need component name!"); // get component Reference xSaxWriter = xml::sax::Writer::create(rxContext); // connect XML writer to output stream xSaxWriter->setOutputStream(xOutputStream); if (m_bUseHTMLMLEntities) xSaxWriter->setCustomEntityNames(starmathdatabase::icustomMathmlHtmlEntitiesExport); // prepare arguments (prepend doc handler to given arguments) Sequence aArgs{ Any(xSaxWriter), Any(rPropSet) }; // get filter component Reference xExporter( rxContext->getServiceManager()->createInstanceWithArgumentsAndContext( OUString::createFromAscii(pComponentName), aArgs, rxContext), UNO_QUERY); OSL_ENSURE(xExporter.is(), "can't instantiate export filter component"); if (!xExporter.is()) return false; // connect model and filter xExporter->setSourceDocument(xComponent); // filter! Reference xFilter(xExporter, UNO_QUERY); uno::Sequence aProps(0); xFilter->filter(aProps); auto pFilter = dynamic_cast(xFilter.get()); return pFilter == nullptr || pFilter->GetSuccess(); } /// export through an XML exporter component (storage version) bool SmXMLExportWrapper::WriteThroughComponent(const Reference& xStorage, const Reference& xComponent, const char* pStreamName, Reference const& rxContext, Reference const& rPropSet, const char* pComponentName) { OSL_ENSURE(xStorage.is(), "Need storage!"); OSL_ENSURE(nullptr != pStreamName, "Need stream name!"); // open stream Reference xStream; OUString sStreamName = OUString::createFromAscii(pStreamName); try { xStream = xStorage->openStreamElement(sStreamName, embed::ElementModes::READWRITE | embed::ElementModes::TRUNCATE); } catch (const uno::Exception&) { DBG_UNHANDLED_EXCEPTION("starmath", "Can't create output stream in package"); return false; } uno::Reference xSet(xStream, uno::UNO_QUERY); static constexpr OUStringLiteral sMediaType = u"MediaType"; static constexpr OUStringLiteral sTextXml = u"text/xml"; xSet->setPropertyValue(sMediaType, Any(OUString(sTextXml))); // all streams must be encrypted in encrypted document static constexpr OUStringLiteral sUseCommonStoragePasswordEncryption = u"UseCommonStoragePasswordEncryption"; xSet->setPropertyValue(sUseCommonStoragePasswordEncryption, Any(true)); // set Base URL if (rPropSet.is()) { rPropSet->setPropertyValue(u"StreamName"_ustr, Any(sStreamName)); } // write the stuff bool bRet = WriteThroughComponent(xStream->getOutputStream(), xComponent, rxContext, rPropSet, pComponentName); return bRet; } SmXMLExport::SmXMLExport(const css::uno::Reference& rContext, OUString const& implementationName, SvXMLExportFlags nExportFlags) : SvXMLExport(rContext, implementationName, util::MeasureUnit::INCH, XML_MATH, nExportFlags) , pTree(nullptr) , bSuccess(false) { } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport(context, u"com.sun.star.comp.Math.XMLExporter"_ustr, SvXMLExportFlags::OASIS | SvXMLExportFlags::ALL)); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLMetaExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport(context, u"com.sun.star.comp.Math.XMLMetaExporter"_ustr, SvXMLExportFlags::META)); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLOasisMetaExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport(context, u"com.sun.star.comp.Math.XMLOasisMetaExporter"_ustr, SvXMLExportFlags::OASIS | SvXMLExportFlags::META)); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLSettingsExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport( context, u"com.sun.star.comp.Math.XMLSettingsExporter"_ustr, SvXMLExportFlags::SETTINGS)); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLOasisSettingsExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport(context, u"com.sun.star.comp.Math.XMLOasisSettingsExporter"_ustr, SvXMLExportFlags::OASIS | SvXMLExportFlags::SETTINGS)); } extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface* Math_XMLContentExporter_get_implementation(css::uno::XComponentContext* context, css::uno::Sequence const&) { return cppu::acquire(new SmXMLExport(context, u"com.sun.star.comp.Math.XMLContentExporter"_ustr, SvXMLExportFlags::OASIS | SvXMLExportFlags::CONTENT)); } ErrCode SmXMLExport::exportDoc(enum XMLTokenEnum eClass) { if (!(getExportFlags() & SvXMLExportFlags::CONTENT)) { SvXMLExport::exportDoc(eClass); } else { uno::Reference xModel = GetModel(); SmModel* pModel = comphelper::getFromUnoTunnel(xModel); if (pModel) { SmDocShell* pDocShell = static_cast(pModel->GetObjectShell()); pTree = pDocShell->GetFormulaTree(); aText = pDocShell->GetText(); } GetDocHandler()->startDocument(); addChaffWhenEncryptedStorage(); /*Add xmlns line*/ comphelper::AttributeList& rList = GetAttrList(); // make use of a default namespace ResetNamespaceMap(); // Math doesn't need namespaces from xmloff, since it now uses default namespaces (because that is common with current MathML usage in the web) GetNamespaceMap_().Add(OUString(), GetXMLToken(XML_N_MATH), XML_NAMESPACE_MATH); rList.AddAttribute(GetNamespaceMap().GetAttrNameByKey(XML_NAMESPACE_MATH), GetNamespaceMap().GetNameByKey(XML_NAMESPACE_MATH)); //I think we need something like ImplExportEntities(); ExportContent_(); GetDocHandler()->endDocument(); } bSuccess = true; return ERRCODE_NONE; } void SmXMLExport::ExportContent_() { uno::Reference xModel = GetModel(); SmModel* pModel = comphelper::getFromUnoTunnel(xModel); SmDocShell* pDocShell = pModel ? static_cast(pModel->GetObjectShell()) : nullptr; OSL_ENSURE(pDocShell, "doc shell missing"); if (pDocShell) { if (!pDocShell->GetFormat().IsTextmode()) { // If the Math equation is not in text mode, we attach a display="block" // attribute on the

root. We don't do anything if it is in
            // text mode, the default display="inline" value will be used.
            AddAttribute(XML_NAMESPACE_MATH, XML_DISPLAY, XML_BLOCK);
        }
        if (pDocShell->GetFormat().IsRightToLeft())
        {
            // If the Math equation is set right-to-left, we attach a dir="rtl"
            // attribute on the root. We don't do anything if it is set
            // left-to-right, the default dir="ltr" value will be used.
            AddAttribute(XML_NAMESPACE_MATH, XML_DIR, XML_RTL);
        }
    }

    SvXMLElementExport aEquation(*this, XML_NAMESPACE_MATH, XML_MATH, true, true);
    std::unique_ptr pSemantics;

    if (!aText.isEmpty())
    {
        pSemantics.reset(
            new SvXMLElementExport(*this, XML_NAMESPACE_MATH, XML_SEMANTICS, true, true));
    }

    ExportNodes(pTree, 0);

    if (aText.isEmpty())
        return;

    SmModule* pMod = SM_MOD();
    sal_Int16 nSmSyntaxVersion = pMod->GetConfig()->GetDefaultSmSyntaxVersion();

    // Convert symbol names
    if (pDocShell)
    {
        nSmSyntaxVersion = pDocShell->GetSmSyntaxVersion();
        AbstractSmParser* rParser = pDocShell->GetParser();
        bool bVal = rParser->IsExportSymbolNames();
        rParser->SetExportSymbolNames(true);
        auto pTmpTree = rParser->Parse(aText);
        aText = rParser->GetText();
        pTmpTree.reset();
        rParser->SetExportSymbolNames(bVal);
    }

    OUStringBuffer sStrBuf(12);
    sStrBuf.append(u"StarMath ");
    if (nSmSyntaxVersion == 5)
        sStrBuf.append(u"5.0");
    else
        sStrBuf.append(static_cast (nSmSyntaxVersion));

    AddAttribute(XML_NAMESPACE_MATH, XML_ENCODING, sStrBuf.makeStringAndClear());
    SvXMLElementExport aAnnotation(*this, XML_NAMESPACE_MATH, XML_ANNOTATION, true, false);
    GetDocHandler()->characters(aText);
}

void SmXMLExport::GetViewSettings(Sequence & aProps)
{
    uno::Reference xModel = GetModel();
    if (!xModel.is())
        return;

    SmModel* pModel = comphelper::getFromUnoTunnel (xModel);

    if (!pModel)
        return;

    SmDocShell* pDocShell = static_cast (pModel->GetObjectShell());
    if (!pDocShell)
        return;

    aProps.realloc(4);
    PropertyValue* pValue = aProps.getArray();
    sal_Int32 nIndex = 0;

    tools::Rectangle aRect(pDocShell->GetVisArea());

    pValue[nIndex].Name = "ViewAreaTop";
    pValue[nIndex++].Value <<= aRect.Top();

    pValue[nIndex].Name = "ViewAreaLeft";
    pValue[nIndex++].Value <<= aRect.Left();

    pValue[nIndex].Name = "ViewAreaWidth";
    pValue[nIndex++].Value <<= aRect.GetWidth();

    pValue[nIndex].Name = "ViewAreaHeight";
    pValue[nIndex++].Value <<= aRect.GetHeight();
}

void SmXMLExport::GetConfigurationSettings(Sequence & rProps)
{
    Reference xProps(GetModel(), UNO_QUERY);
    if (!xProps.is())
        return;

    Reference xPropertySetInfo = xProps->getPropertySetInfo();
    if (!xPropertySetInfo.is())
        return;

    const Sequence aProps = xPropertySetInfo->getProperties();
    const sal_Int32 nCount = aProps.getLength();
    if (!nCount)
        return;

    rProps.realloc(nCount);
    SmMathConfig* pConfig = SM_MOD()->GetConfig();
    const bool bUsedSymbolsOnly = pConfig && pConfig->IsSaveOnlyUsedSymbols();

    std::transform(aProps.begin(), aProps.end(), rProps.getArray(),
                   [bUsedSymbolsOnly, &xProps](const Property& prop) {
                       PropertyValue aRet;
                       if (prop.Name != "Formula" && prop.Name != "BasicLibraries"
                           && prop.Name != "DialogLibraries" && prop.Name != "RuntimeUID")
                       {
                           aRet.Name = prop.Name;
                           OUString aActualName(prop.Name);
                           // handle 'save used symbols only'
                           static constexpr OUStringLiteral sUserDefinedSymbolsInUse
                               = u"UserDefinedSymbolsInUse";
                           if (bUsedSymbolsOnly && prop.Name == "Symbols")
                               aActualName = sUserDefinedSymbolsInUse;
                           aRet.Value = xProps->getPropertyValue(aActualName);
                       }
                       return aRet;
                   });
}

void SmXMLExport::ExportLine(const SmNode* pNode, int nLevel) { ExportExpression(pNode, nLevel); }

void SmXMLExport::ExportBinaryHorizontal(const SmNode* pNode, int nLevel)
{
    TG nGroup = pNode->GetToken().nGroup;

    SvXMLElementExport aRow(*this, XML_NAMESPACE_MATH, XML_MROW, true, true);

    // Unfold the binary tree structure as long as the nodes are SmBinHorNode
    // with the same nGroup. This will reduce the number of nested // elements e.g. we only need three levels to export

    // "a*b*c*d+e*f*g*h+i*j*k*l = a*b*c*d+e*f*g*h+i*j*k*l =
    //  a*b*c*d+e*f*g*h+i*j*k*l = a*b*c*d+e*f*g*h+i*j*k*l"

    // See https://www.libreoffice.org/bugzilla/show_bug.cgi?id=66081
    ::std::stack s;
    s.push(pNode);
    while (!s.empty())
    {
        const SmNode* node = s.top();
        s.pop();
        if (node->GetType() != SmNodeType::BinHor || node->GetToken().nGroup != nGroup)
        {
            ExportNodes(node, nLevel + 1);
            continue;
        }
        const SmBinHorNode* binNode = static_cast (node);
        s.push(binNode->RightOperand());
        s.push(binNode->Symbol());
        s.push(binNode->LeftOperand());
    }
}

void SmXMLExport::ExportUnaryHorizontal(const SmNode* pNode, int nLevel)
{
    ExportExpression(pNode, nLevel);
}

void SmXMLExport::ExportExpression(const SmNode* pNode, int nLevel,
                                   bool bNoMrowContainer /*=false*/)
{
    std::unique_ptr pRow;
    size_t nSize = pNode->GetNumSubNodes();

    // #i115443: nodes of type expression always need to be grouped with mrow statement
    if (!bNoMrowContainer && (nSize > 1 || pNode->GetType() == SmNodeType::Expression))
        pRow.reset(new SvXMLElementExport(*this, XML_NAMESPACE_MATH, XML_MROW, true, true));

    for (size_t i = 0; i < nSize; ++i)
    {
        if (const SmNode* pTemp = pNode->GetSubNode(i))
            ExportNodes(pTemp, nLevel + 1);
    }
}

void SmXMLExport::ExportBinaryVertical(const SmNode* pNode, int nLevel)
{
    assert(pNode->GetNumSubNodes() == 3);
    const SmNode* pNum = pNode->GetSubNode(0);
    const SmNode* pDenom = pNode->GetSubNode(2);
    if (pNum->GetType() == SmNodeType::Align && pNum->GetToken().eType != TALIGNC)
    {
        // A left or right alignment is specified on the numerator:
        // attach the corresponding numalign attribute.
        AddAttribute(XML_NAMESPACE_MATH, XML_NUMALIGN,
                     pNum->GetToken().eType == TALIGNL ? XML_LEFT : XML_RIGHT);
    }
    if (pDenom->GetType() == SmNodeType::Align && pDenom->GetToken().eType != TALIGNC)
    {
        // A left or right alignment is specified on the denominator:
        // attach the corresponding denomalign attribute.
        AddAttribute(XML_NAMESPACE_MATH, XML_DENOMALIGN,
                     pDenom->GetToken().eType == TALIGNL ? XML_LEFT : XML_RIGHT);
    }
    SvXMLElementExport aFraction(*this, XML_NAMESPACE_MATH, XML_MFRAC, true, true);
    ExportNodes(pNum, nLevel);
    ExportNodes(pDenom, nLevel);
}

void SmXMLExport::ExportBinaryDiagonal(const SmNode* pNode, int nLevel)
{
    assert(pNode->GetNumSubNodes() == 3);

    if (pNode->GetToken().eType == TWIDESLASH)
    {
        // wideslash
        // export the node as \frac{AddAttribute(XML_NAMESPACE_MATH, XML_BEVELLED, XML_TRUE);
        SvXMLElementExport aFraction(*this, XML_NAMESPACE_MATH, XML_MFRAC, true, true);
        ExportNodes(pNode->GetSubNode(0), nLevel);
        ExportNodes(pNode->GetSubNode(1), nLevel);
    }
    else
    {
        // widebslash
        // We can not use}{\frac{to a backslash, so just use}{\}}