/* -*- 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 . */ #include "SettingsTable.hxx" #include "DocumentProtection.hxx" #include "TagLogger.hxx" #include "WriteProtection.hxx" #include #include #include #include #include #include #include #include #include #include #include #include #include "ConversionHelper.hxx" #include "DomainMapper.hxx" #include "util.hxx" using namespace com::sun::star; namespace writerfilter { namespace { /// Maps OOXML to SvxZoomType. sal_Int16 lcl_GetZoomType(Id nType) { switch (nType) { case NS_ooxml::LN_Value_doc_ST_Zoom_fullPage: return sal_Int16(SvxZoomType::WHOLEPAGE); case NS_ooxml::LN_Value_doc_ST_Zoom_bestFit: return sal_Int16(SvxZoomType::PAGEWIDTH); case NS_ooxml::LN_Value_doc_ST_Zoom_textFit: return sal_Int16(SvxZoomType::OPTIMAL); } return sal_Int16(SvxZoomType::PERCENT); } } namespace dmapper { struct SettingsTable_Impl { int m_nDefaultTabStop; bool m_bRecordChanges; bool m_bShowInsDelChanges; bool m_bShowFormattingChanges; bool m_bShowMarkupChanges; bool m_bLinkStyles; sal_Int16 m_nZoomFactor; sal_Int16 m_nZoomType = 0; sal_Int32 m_nWordCompatibilityMode; Id m_nView; bool m_bEvenAndOddHeaders; bool m_bUsePrinterMetrics; bool embedTrueTypeFonts; bool embedSystemFonts; bool m_bDoNotUseHTMLParagraphAutoSpacing; bool m_bNoColumnBalance; bool m_bAutoHyphenation; bool m_bNoHyphenateCaps; sal_Int16 m_nHyphenationZone; bool m_bWidowControl; bool m_bLongerSpaceSequence; bool m_bSplitPgBreakAndParaMark; bool m_bMirrorMargin; bool m_bDoNotExpandShiftReturn; bool m_bDisplayBackgroundShape; bool m_bNoLeading = false; OUString m_sDecimalSymbol; OUString m_sListSeparator; uno::Sequence m_pThemeFontLangProps; std::vector m_aCompatSettings; uno::Sequence m_pCurrentCompatSetting; OUString m_sCurrentDatabaseDataSource; std::shared_ptr m_pDocumentProtection; std::shared_ptr m_pWriteProtection; bool m_bGutterAtTop = false; SettingsTable_Impl() : m_nDefaultTabStop( 720 ) //default is 1/2 in , m_bRecordChanges(false) , m_bShowInsDelChanges(true) , m_bShowFormattingChanges(false) , m_bShowMarkupChanges(true) , m_bLinkStyles(false) , m_nZoomFactor(0) , m_nWordCompatibilityMode(-1) , m_nView(0) , m_bEvenAndOddHeaders(false) , m_bUsePrinterMetrics(false) , embedTrueTypeFonts(false) , embedSystemFonts(false) , m_bDoNotUseHTMLParagraphAutoSpacing(false) , m_bNoColumnBalance(false) , m_bAutoHyphenation(false) , m_bNoHyphenateCaps(false) , m_nHyphenationZone(0) , m_bWidowControl(false) , m_bLongerSpaceSequence(false) , m_bSplitPgBreakAndParaMark(false) , m_bMirrorMargin(false) , m_bDoNotExpandShiftReturn(false) , m_bDisplayBackgroundShape(false) , m_sDecimalSymbol(".") , m_sListSeparator(",") , m_pThemeFontLangProps(3) , m_pCurrentCompatSetting(3) {} }; SettingsTable::SettingsTable(const DomainMapper& rDomainMapper) : LoggedProperties("SettingsTable") , LoggedTable("SettingsTable") , m_pImpl( new SettingsTable_Impl ) { if (rDomainMapper.IsRTFImport()) { // HTML paragraph auto-spacing is opt-in for RTF, opt-out for OOXML. m_pImpl->m_bDoNotUseHTMLParagraphAutoSpacing = true; // Longer space sequence is opt-in for RTF, and not in OOXML. m_pImpl->m_bLongerSpaceSequence = true; } m_pImpl->m_pDocumentProtection = std::make_shared(); m_pImpl->m_pWriteProtection = std::make_shared(); } SettingsTable::~SettingsTable() { } void SettingsTable::lcl_attribute(Id nName, Value & val) { int nIntValue = val.getInt(); OUString sStringValue = val.getString(); switch(nName) { case NS_ooxml::LN_CT_Zoom_percent: m_pImpl->m_nZoomFactor = nIntValue; break; case NS_ooxml::LN_CT_Zoom_val: m_pImpl->m_nZoomType = lcl_GetZoomType(nIntValue); break; case NS_ooxml::LN_CT_Language_val: m_pImpl->m_pThemeFontLangProps.getArray()[0] = comphelper::makePropertyValue("val", sStringValue); break; case NS_ooxml::LN_CT_Language_eastAsia: m_pImpl->m_pThemeFontLangProps.getArray()[1] = comphelper::makePropertyValue("eastAsia", sStringValue); break; case NS_ooxml::LN_CT_Language_bidi: m_pImpl->m_pThemeFontLangProps.getArray()[2] = comphelper::makePropertyValue("bidi", sStringValue); break; case NS_ooxml::LN_CT_View_val: m_pImpl->m_nView = nIntValue; break; case NS_ooxml::LN_CT_CompatSetting_name: m_pImpl->m_pCurrentCompatSetting.getArray()[0] = comphelper::makePropertyValue("name", sStringValue); break; case NS_ooxml::LN_CT_CompatSetting_uri: m_pImpl->m_pCurrentCompatSetting.getArray()[1] = comphelper::makePropertyValue("uri", sStringValue); break; case NS_ooxml::LN_CT_CompatSetting_val: m_pImpl->m_pCurrentCompatSetting.getArray()[2] = comphelper::makePropertyValue("val", sStringValue); break; case NS_ooxml::LN_CT_TrackChangesView_insDel: m_pImpl->m_bShowInsDelChanges = (nIntValue != 0); break; case NS_ooxml::LN_CT_TrackChangesView_formatting: m_pImpl->m_bShowFormattingChanges = (nIntValue != 0); break; case NS_ooxml::LN_CT_TrackChangesView_markup: m_pImpl->m_bShowMarkupChanges = (nIntValue != 0); break; default: { #ifdef DBG_UTIL TagLogger::getInstance().element("unhandled"); #endif } } } void SettingsTable::lcl_sprm(Sprm& rSprm) { sal_uInt32 nSprmId = rSprm.getId(); Value::Pointer_t pValue = rSprm.getValue(); sal_Int32 nIntValue = pValue->getInt(); switch(nSprmId) { case NS_ooxml::LN_CT_Settings_zoom: // 92469; case NS_ooxml::LN_CT_Settings_proofState: // 92489; case NS_ooxml::LN_CT_Settings_attachedTemplate: // 92491; case NS_ooxml::LN_CT_Settings_hdrShapeDefaults: // 92544; case NS_ooxml::LN_CT_Settings_footnotePr: // 92545; case NS_ooxml::LN_CT_Settings_endnotePr: // 92546; case NS_ooxml::LN_CT_Settings_compat: // 92547; case NS_ooxml::LN_CT_Settings_themeFontLang: // 92552; case NS_ooxml::LN_CT_Settings_shapeDefaults: // 92560; case NS_ooxml::LN_CT_Settings_view: //PropertySetValues - need to be resolved { resolveSprmProps(*this, rSprm); } break; case NS_ooxml::LN_CT_Settings_stylePaneFormatFilter: // 92493; break; case NS_ooxml::LN_CT_Settings_defaultTabStop: // 92505; m_pImpl->m_nDefaultTabStop = nIntValue; break; case NS_ooxml::LN_CT_Settings_linkStyles: // 92663; m_pImpl->m_bLinkStyles = nIntValue; break; case NS_ooxml::LN_CT_Settings_evenAndOddHeaders: m_pImpl->m_bEvenAndOddHeaders = nIntValue; break; case NS_ooxml::LN_CT_Settings_noPunctuationKerning: // 92526; break; case NS_ooxml::LN_CT_Settings_characterSpacingControl: // 92527; // doNotCompress, compressPunctuation, compressPunctuationAndJapaneseKana break; case NS_ooxml::LN_CT_Settings_doNotIncludeSubdocsInStats: // 92554; // Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics) break; case NS_ooxml::LN_CT_Settings_decimalSymbol: // 92562; m_pImpl->m_sDecimalSymbol = pValue->getString(); break; case NS_ooxml::LN_CT_Settings_listSeparator: // 92563; m_pImpl->m_sListSeparator = pValue->getString(); break; case NS_ooxml::LN_CT_Settings_rsids: // 92549; revision save Ids - probably not necessary break; case NS_ooxml::LN_CT_Settings_hyphenationZone: // 92508; m_pImpl->m_nHyphenationZone = nIntValue; break; case NS_ooxml::LN_CT_Compat_useFELayout: // 92422; // useFELayout (Do Not Bypass East Asian/Complex Script Layout Code - support of old versions of Word - ignored) break; case NS_ooxml::LN_CT_Settings_trackRevisions: { m_pImpl->m_bRecordChanges = bool(rSprm.getValue( )->getInt( ) ); } break; case NS_ooxml::LN_CT_Settings_revisionView: resolveSprmProps(*this, rSprm); break; case NS_ooxml::LN_CT_Settings_documentProtection: resolveSprmProps(*(m_pImpl->m_pDocumentProtection), rSprm); break; case NS_ooxml::LN_CT_Settings_writeProtection: resolveSprmProps(*(m_pImpl->m_pWriteProtection), rSprm); break; case NS_ooxml::LN_CT_Compat_usePrinterMetrics: m_pImpl->m_bUsePrinterMetrics = nIntValue; break; case NS_ooxml::LN_CT_Settings_embedTrueTypeFonts: m_pImpl->embedTrueTypeFonts = nIntValue != 0; break; case NS_ooxml::LN_CT_Settings_embedSystemFonts: m_pImpl->embedSystemFonts = nIntValue != 0; break; case NS_ooxml::LN_CT_Compat_doNotUseHTMLParagraphAutoSpacing: m_pImpl->m_bDoNotUseHTMLParagraphAutoSpacing = nIntValue; break; case NS_ooxml::LN_CT_Compat_splitPgBreakAndParaMark: m_pImpl->m_bSplitPgBreakAndParaMark = nIntValue; break; case NS_ooxml::LN_CT_Settings_mirrorMargins: m_pImpl->m_bMirrorMargin = nIntValue; break; case NS_ooxml::LN_CT_Settings_mailMerge: { writerfilter::Reference::Pointer_t pProperties = rSprm.getProps(); if (pProperties) pProperties->resolve(*this); } break; case NS_ooxml::LN_CT_MailMerge_query: { // try to get the "database.table" name from the query saved previously OUString sVal = pValue->getString(); if ( sVal.endsWith("$") && sVal.indexOf(".dbo.") > 0 ) { sal_Int32 nSpace = sVal.lastIndexOf(' '); sal_Int32 nDbo = sVal.lastIndexOf(".dbo."); if ( nSpace > 0 && nSpace < nDbo - 1 ) { m_pImpl->m_sCurrentDatabaseDataSource = OUString::Concat(sVal.subView(nSpace + 1, nDbo - nSpace - 1)) + sVal.subView(nDbo + 4, sVal.getLength() - nDbo - 5); } } } break; case NS_ooxml::LN_CT_Compat_compatSetting: { writerfilter::Reference::Pointer_t pProperties = rSprm.getProps(); if (pProperties) { pProperties->resolve(*this); beans::PropertyValue aValue; aValue.Name = "compatSetting"; aValue.Value <<= m_pImpl->m_pCurrentCompatSetting; m_pImpl->m_aCompatSettings.push_back(aValue); } } break; case NS_ooxml::LN_CT_Compat_noColumnBalance: m_pImpl->m_bNoColumnBalance = nIntValue; break; case NS_ooxml::LN_CT_Settings_autoHyphenation: m_pImpl->m_bAutoHyphenation = nIntValue; break; case NS_ooxml::LN_CT_Settings_doNotHyphenateCaps: m_pImpl->m_bNoHyphenateCaps = nIntValue; break; case NS_ooxml::LN_CT_Settings_widowControl: m_pImpl->m_bWidowControl = nIntValue; break; case NS_ooxml::LN_CT_Settings_longerSpaceSequence: m_pImpl->m_bLongerSpaceSequence = nIntValue; break; case NS_ooxml::LN_CT_Compat_doNotExpandShiftReturn: m_pImpl->m_bDoNotExpandShiftReturn = true; break; case NS_ooxml::LN_CT_Settings_displayBackgroundShape: m_pImpl->m_bDisplayBackgroundShape = nIntValue; break; case NS_ooxml::LN_CT_Compat_noLeading: m_pImpl->m_bNoLeading = nIntValue != 0; break; case NS_ooxml::LN_CT_Settings_gutterAtTop: m_pImpl->m_bGutterAtTop = nIntValue != 0; break; default: { #ifdef DBG_UTIL TagLogger::getInstance().element("unhandled"); #endif } } } void SettingsTable::lcl_entry(writerfilter::Reference::Pointer_t ref) { ref->resolve(*this); } //returns default TabStop in 1/100th mm int SettingsTable::GetDefaultTabStop() const { return ConversionHelper::convertTwipToMM100( m_pImpl->m_nDefaultTabStop ); } bool SettingsTable::GetLinkStyles() const { return m_pImpl->m_bLinkStyles; } sal_Int16 SettingsTable::GetZoomFactor() const { return m_pImpl->m_nZoomFactor; } sal_Int16 SettingsTable::GetZoomType() const { return m_pImpl->m_nZoomType; } Id SettingsTable::GetView() const { return m_pImpl->m_nView; } bool SettingsTable::GetUsePrinterMetrics() const { return m_pImpl->m_bUsePrinterMetrics; } bool SettingsTable::GetEvenAndOddHeaders() const { return m_pImpl->m_bEvenAndOddHeaders; } bool SettingsTable::GetEmbedTrueTypeFonts() const { return m_pImpl->embedTrueTypeFonts; } bool SettingsTable::GetEmbedSystemFonts() const { return m_pImpl->embedSystemFonts; } bool SettingsTable::GetDoNotUseHTMLParagraphAutoSpacing() const { return m_pImpl->m_bDoNotUseHTMLParagraphAutoSpacing; } bool SettingsTable::GetNoColumnBalance() const { return m_pImpl->m_bNoColumnBalance; } bool SettingsTable::GetSplitPgBreakAndParaMark() const { return m_pImpl->m_bSplitPgBreakAndParaMark; } bool SettingsTable::GetMirrorMarginSettings() const { return m_pImpl->m_bMirrorMargin; } bool SettingsTable::GetDisplayBackgroundShape() const { return m_pImpl->m_bDisplayBackgroundShape; } bool SettingsTable::GetDoNotExpandShiftReturn() const { return m_pImpl->m_bDoNotExpandShiftReturn; } bool SettingsTable::GetProtectForm() const { return m_pImpl->m_pDocumentProtection->getProtectForm() && m_pImpl->m_pDocumentProtection->getEnforcement(); } bool SettingsTable::GetReadOnly() const { return m_pImpl->m_pWriteProtection->getRecommended() || (m_pImpl->m_pDocumentProtection->getReadOnly() && m_pImpl->m_pDocumentProtection->getEnforcement()); } bool SettingsTable::GetNoHyphenateCaps() const { return m_pImpl->m_bNoHyphenateCaps; } sal_Int16 SettingsTable::GetHyphenationZone() const { return m_pImpl->m_nHyphenationZone; } const OUString & SettingsTable::GetDecimalSymbol() const { return m_pImpl->m_sDecimalSymbol; } const OUString & SettingsTable::GetListSeparator() const { return m_pImpl->m_sListSeparator; } uno::Sequence const & SettingsTable::GetThemeFontLangProperties() const { return m_pImpl->m_pThemeFontLangProps; } uno::Sequence SettingsTable::GetCompatSettings() const { if ( GetWordCompatibilityMode() == -1 ) { // the default value for an undefined compatibilityMode is 12 (Word 2007) uno::Sequence aCompatSetting( comphelper::InitPropertySequence({ { "name", uno::Any(OUString("compatibilityMode")) }, { "uri", uno::Any(OUString("http://schemas.microsoft.com/office/word")) }, { "val", uno::Any(OUString("12")) } //12: Use word processing features specified in ECMA-376. This is the default. })); beans::PropertyValue aValue; aValue.Name = "compatSetting"; aValue.Value <<= aCompatSetting; m_pImpl->m_aCompatSettings.push_back(aValue); } return comphelper::containerToSequence(m_pImpl->m_aCompatSettings); } uno::Sequence SettingsTable::GetDocumentProtectionSettings() const { return m_pImpl->m_pDocumentProtection->toSequence(); } uno::Sequence SettingsTable::GetWriteProtectionSettings() const { return m_pImpl->m_pWriteProtection->toSequence(); } const OUString & SettingsTable::GetCurrentDatabaseDataSource() const { return m_pImpl->m_sCurrentDatabaseDataSource; } static bool lcl_isDefault(const uno::Reference& xPropertyState, const OUString& rPropertyName) { return xPropertyState->getPropertyState(rPropertyName) == beans::PropertyState_DEFAULT_VALUE; } void SettingsTable::ApplyProperties(uno::Reference const& xDoc) { uno::Reference< beans::XPropertySet> xDocProps( xDoc, uno::UNO_QUERY ); uno::Reference xTextFactory(xDoc, uno::UNO_QUERY_THROW); uno::Reference xDocumentSettings(xTextFactory->createInstance("com.sun.star.document.Settings"), uno::UNO_QUERY_THROW); xDocumentSettings->setPropertyValue("TableRowKeep", uno::Any(true)); if (GetWordCompatibilityMode() <= 14) { xDocumentSettings->setPropertyValue("MsWordCompMinLineHeightByFly", uno::Any(true)); xDocumentSettings->setPropertyValue("TabOverMargin", uno::Any(true)); } // Show changes value if (xDocProps.is()) { bool bHideChanges = !m_pImpl->m_bShowInsDelChanges || !m_pImpl->m_bShowMarkupChanges; xDocProps->setPropertyValue("ShowChanges", uno::Any( !bHideChanges || m_pImpl->m_bShowFormattingChanges ) ); } // Record changes value if (xDocProps.is()) { xDocProps->setPropertyValue("RecordChanges", uno::Any( m_pImpl->m_bRecordChanges ) ); // Password protected Record changes if (m_pImpl->m_bRecordChanges && m_pImpl->m_pDocumentProtection->getRedlineProtection() && m_pImpl->m_pDocumentProtection->getEnforcement()) { // use dummy protection key to forbid disabling of Record changes without a notice // (extending the recent GrabBag support) TODO support password verification... css::uno::Sequence aDummyKey { 1 }; xDocProps->setPropertyValue("RedlineProtectionKey", uno::Any( aDummyKey )); } } // Auto hyphenation: turns on hyphenation by default, may still disable it at a paragraph level. // Situation is similar for RTF_WIDOWCTRL, which turns on widow / orphan control by default. if (!(m_pImpl->m_bAutoHyphenation || m_pImpl->m_bNoHyphenateCaps || m_pImpl->m_bWidowControl)) return; uno::Reference xStyleFamiliesSupplier(xDoc, uno::UNO_QUERY); if (!xStyleFamiliesSupplier.is()) return; uno::Reference xStyleFamilies = xStyleFamiliesSupplier->getStyleFamilies(); uno::Reference xParagraphStyles = xStyleFamilies->getByName("ParagraphStyles").get< uno::Reference >(); uno::Reference xDefault = xParagraphStyles->getByName("Standard").get< uno::Reference >(); uno::Reference xPropertyState(xDefault, uno::UNO_QUERY); if (m_pImpl->m_bAutoHyphenation && lcl_isDefault(xPropertyState, "ParaIsHyphenation")) { uno::Reference xPropertySet(xDefault, uno::UNO_QUERY); xPropertySet->setPropertyValue("ParaIsHyphenation", uno::Any(true)); } if (m_pImpl->m_bNoHyphenateCaps) { uno::Reference xPropertySet(xDefault, uno::UNO_QUERY); xPropertySet->setPropertyValue("ParaHyphenationNoCaps", uno::Any(true)); } if (m_pImpl->m_nHyphenationZone) { uno::Reference xPropertySet(xDefault, uno::UNO_QUERY); xPropertySet->setPropertyValue("ParaHyphenationZone", uno::Any(GetHyphenationZone())); } if (m_pImpl->m_bWidowControl && lcl_isDefault(xPropertyState, "ParaWidows") && lcl_isDefault(xPropertyState, "ParaOrphans")) { uno::Reference xPropertySet(xDefault, uno::UNO_QUERY); uno::Any aAny(static_cast(2)); xPropertySet->setPropertyValue("ParaWidows", aAny); xPropertySet->setPropertyValue("ParaOrphans", aAny); } } bool SettingsTable::GetCompatSettingValue( std::u16string_view sCompatName ) const { bool bRet = false; for (const auto& rProp : m_pImpl->m_aCompatSettings) { if (rProp.Name == "compatSetting") //always true { css::uno::Sequence aCurrentCompatSettings; rProp.Value >>= aCurrentCompatSettings; OUString sName; aCurrentCompatSettings[0].Value >>= sName; if ( sName != sCompatName ) continue; OUString sUri; aCurrentCompatSettings[1].Value >>= sUri; if ( sUri != "http://schemas.microsoft.com/office/word" ) continue; OUString sVal; aCurrentCompatSettings[2].Value >>= sVal; // if repeated, what happens? Last one wins bRet = sVal.toBoolean(); } } return bRet; } //Keep this function in-sync with the one in sw/.../docxattributeoutput.cxx sal_Int32 SettingsTable::GetWordCompatibilityMode() const { if ( m_pImpl->m_nWordCompatibilityMode != -1 ) return m_pImpl->m_nWordCompatibilityMode; for (const auto& rProp : m_pImpl->m_aCompatSettings) { if (rProp.Name == "compatSetting") //always true { css::uno::Sequence aCurrentCompatSettings; rProp.Value >>= aCurrentCompatSettings; OUString sName; aCurrentCompatSettings[0].Value >>= sName; if ( sName != "compatibilityMode" ) continue; OUString sUri; aCurrentCompatSettings[1].Value >>= sUri; if ( sUri != "http://schemas.microsoft.com/office/word" ) continue; OUString sVal; aCurrentCompatSettings[2].Value >>= sVal; const sal_Int32 nValidMode = sVal.toInt32(); // if repeated, highest mode wins in MS Word. 11 is the first valid mode. if ( nValidMode > 10 && nValidMode > m_pImpl->m_nWordCompatibilityMode ) m_pImpl->m_nWordCompatibilityMode = nValidMode; } } return m_pImpl->m_nWordCompatibilityMode; } bool SettingsTable::GetLongerSpaceSequence() const { return m_pImpl->m_bLongerSpaceSequence; } bool SettingsTable::GetNoLeading() const { return m_pImpl->m_bNoLeading; } bool SettingsTable::GetGutterAtTop() const { return m_pImpl->m_bGutterAtTop; } }//namespace dmapper } //namespace writerfilter /* vim:set shiftwidth=4 softtabstop=4 expandtab: */