core/MsBinaryFile/DocFile/OleObjectMapping.cpp

/*
 * Copyright (C) Ascensio System SIA, 2009-2026
 *
 * This program is a free software product. You can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License (AGPL)
 * version 3 as published by the Free Software Foundation, together with the
 * additional terms provided in the LICENSE file.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For
 * details, see the GNU AGPL at: https://www.gnu.org/licenses/agpl-3.0.html
 *
 * You can contact Ascensio System SIA by email at info@onlyoffice.com
 * or by postal mail at 20A-6 Ernesta Birznieka-Upisha Street, Riga,
 * LV-1050, Latvia, European Union.
 *
 * The interactive user interfaces in modified versions of the Program
 * are required to display Appropriate Legal Notices in accordance with
 * Section 5 of the GNU AGPL version 3.
 *
 * No trademark rights are granted under this License.
 *
 * All non-code elements of the Product, including illustrations,
 * icon sets, and technical writing content, are licensed under the
 * Creative Commons Attribution-ShareAlike 4.0 International License:
 * https://creativecommons.org/licenses/by-sa/4.0/legalcode
 *
 * This license applies only to such non-code elements and does not
 * modify or replace the licensing terms applicable to the Program's
 * source code, which remains licensed under the GNU Affero General
 * Public License v3.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

#include "OleObjectMapping.h"

namespace DocFileFormat
{	
	OleObjectMapping::OleObjectMapping(XMLTools::CStringXmlWriter* writer, ConversionContext* context, PictureDescriptor* pict, IMapping* caller, const std::wstring& shapeId)
		:
	OleObjectMapping::AbstractOpenXmlMapping(writer), m_context(NULL), _pict(NULL), _caller(NULL), _shapeId(shapeId)
	{
		m_context	=	context;
		_pict		=	pict;
		_caller		=	caller;
	}

	void OleObjectMapping::Apply(IVisitable* visited)
	{
		OleObject* ole = dynamic_cast<OleObject*>(visited);
		if (!ole) return;
		
		if (ole->isEmbedded || ole->isPackage)
		{
			if (ole->isEquation) ole->ClipboardFormat = L"Equation";
			else if (ole->ClipboardFormat.empty()) ole->ClipboardFormat = L"MSWordDocx";

			ole->Program = L"Word.Document";
		}
		m_pXmlWriter->WriteNodeBegin(L"o:OLEObject", TRUE);

		int relID = -1;

		if (ole->isLinked)
		{
			relID = m_context->_docx->RegisterExternalOLEObject(_caller, ole->ClipboardFormat, ole->Link);

			m_pXmlWriter->WriteAttribute(L"Type", L"Link");
			m_pXmlWriter->WriteAttribute(L"UpdateMode", ole->UpdateMode);
		}
		else
		{
			if (ole->isEmbedded || ole->isPackage)
				relID = m_context->_docx->RegisterPackage(_caller, ole->ClipboardFormat);
			else
				relID = m_context->_docx->RegisterOLEObject(_caller, ole->ClipboardFormat);

			m_pXmlWriter->WriteAttribute(L"Type", L"Embed");

			copyEmbeddedObject(ole);
		}

		m_pXmlWriter->WriteAttribute(L"ProgID", ole->Program);
		m_pXmlWriter->WriteAttribute(L"ShapeID", _shapeId);
		m_pXmlWriter->WriteAttribute(L"DrawAspect", L"Content");
		m_pXmlWriter->WriteAttribute(L"ObjectID", ole->ObjectId);
		m_pXmlWriter->WriteAttribute(L"r:id", L"rId" + FormatUtils::IntToWideString(relID));
		m_pXmlWriter->WriteNodeEnd(L"", TRUE, FALSE);

		m_pXmlWriter->WriteNodeEnd(L"o:OLEObject");
	}

	std::wstring OleObjectMapping::GetTargetExt(const std::wstring& objectType)
	{
		std::wstring objectExt = L".bin";

		if ( objectType == L"Biff8" )
		{
			objectExt = L".xls";
		}
		else if ( objectType == L"MSWordDoc" )
		{
			objectExt = L".doc";
		}
		else if ( objectType == L"MSPresentation" )
		{
			objectExt = L".ppt";
		}
		else if ( objectType == L"MSWordDocx" )
		{
			objectExt = L".docx";
		}
		else if ( objectType == L"Equation" )
		{
			objectExt = L".xml";
		}
		return objectExt;
	}

	std::wstring OleObjectMapping::GetContentType(const std::wstring& objectType)
	{
		std::wstring objectContentType = OpenXmlContentTypes::OleObject;

		if ( objectType == L"Biff8" )
		{
			objectContentType = OpenXmlContentTypes::MSExcel;
		}
		else if ( objectType == L"MSWordDoc" )
		{
			objectContentType = OpenXmlContentTypes::MSWord;
		}
		else if ( objectType == L"MSPresentation" )
		{
			objectContentType = OpenXmlContentTypes::MSPowerpoint;
		}
		else if ( objectType == L"MSWordDocx" )
		{
			objectContentType = OpenXmlContentTypes::MSWordDocx;
		}
		else if ( objectType == L"Equation" )
		{
			objectContentType = OpenXmlContentTypes::Xml;
		}
		return objectContentType;
	}

	void OleObjectMapping::copyEmbeddedObject( const OleObject* ole )
	{
		if ( ole == NULL ) return;

		std::wstring clsid;
		std::wstring exelChart = L"Excel.Chart";

		if ( std::search( ole->Program.begin(), ole->Program.end(), exelChart.begin(), exelChart.end() ) == ole->Program.end() )
		{
			clsid = ole->ClassId;
		}
		OleObjectFileStructure object_descr(OleObjectMapping::GetTargetExt( ole->ClipboardFormat ), ole->ObjectId, clsid);

		if (ole->nWordVersion == 2)
		{
			object_descr.clsid = ole->ClipboardFormat;
			object_descr.bNativeOnly = true;
		}
		if (ole->isEquation || ole->isEmbedded || ole->nWordVersion == 2 || ole->isPackage)
		{
			object_descr.data = ole->embeddedData;
		}

		m_context->_docx->OleObjectsList.push_back(object_descr);
	}
}