Introduce centralized detection for storage-based files

This will allow us to get rid of the duplicated code,
and simplify the type detectors.

Also this commit fixes fdo#46310 and fdo#74978.

Change-Id: I08e958ab10d05e1036cdc2bed5ce14bf73b6245c
Reviewed-on: https://gerrit.libreoffice.org/9221
Reviewed-by: Maxim Monastirsky <momonasmon@gmail.com>
Tested-by: Maxim Monastirsky <momonasmon@gmail.com>

4 files changed, 331 insertions, 0 deletions

diff --git a/filter/source/storagefilterdetect/fdcomp.cxx b/filter/source/storagefilterdetect/fdcomp.cxx
new file mode 100644
index 000000000000..ec2d9052e04d
--- /dev/null
+++ b/filter/source/storagefilterdetect/fdcomp.cxx
@@ -0,0 +1,36 @@
+/* -*- 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/.
+ */
+
+#include <sal/config.h>
+
+#include <cppuhelper/factory.hxx>
+#include <cppuhelper/implementationentry.hxx>
+#include <sal/types.h>
+
+#include "filterdetect.hxx"
+
+namespace {
+
+static cppu::ImplementationEntry const services[] = {
+    { &StorageFilterDetect_createInstance, &StorageFilterDetect_getImplementationName,
+      &StorageFilterDetect_getSupportedServiceNames,
+      &cppu::createSingleComponentFactory, 0, 0 },
+    { 0, 0, 0, 0, 0, 0 }
+};
+
+}
+
+extern "C" SAL_DLLPUBLIC_EXPORT void * SAL_CALL storagefd_component_getFactory(
+    char const * pImplName, void * pServiceManager, void * pRegistryKey)
+{
+    return cppu::component_getFactoryHelper(
+        pImplName, pServiceManager, pRegistryKey, services);
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/filter/source/storagefilterdetect/filterdetect.cxx b/filter/source/storagefilterdetect/filterdetect.cxx
new file mode 100644
index 000000000000..591726119bb0
--- /dev/null
+++ b/filter/source/storagefilterdetect/filterdetect.cxx
@@ -0,0 +1,208 @@
+/* -*- 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 "filterdetect.hxx"
+
+#include <comphelper/documentconstants.hxx>
+#include <comphelper/storagehelper.hxx>
+#include <comphelper/types.hxx>
+#include <cppuhelper/supportsservice.hxx>
+#include <unotools/mediadescriptor.hxx>
+#include <tools/urlobj.hxx>
+#include <sfx2/brokenpackageint.hxx>
+
+#include <com/sun/star/beans/XPropertySet.hpp>
+#include <com/sun/star/embed/XStorage.hpp>
+#include <com/sun/star/io/XInputStream.hpp>
+#include <com/sun/star/packages/zip/ZipIOException.hpp>
+#include <com/sun/star/task/XInteractionHandler.hpp>
+
+using namespace ::com::sun::star;
+using utl::MediaDescriptor;
+
+namespace {
+
+OUString getInternalFromMediaType(const OUString& aMediaType)
+{
+    // OpenDocument types
+    if (      aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_TEXT_ASCII )                  return OUString("writer8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_TEXT_TEMPLATE_ASCII )         return OUString("writer8_template");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_TEXT_WEB_ASCII )              return OUString("writerweb8_writer_template");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_TEXT_GLOBAL_ASCII )           return OUString("writerglobal8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_DRAWING_ASCII )               return OUString("draw8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_DRAWING_TEMPLATE_ASCII )      return OUString("draw8_template");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_PRESENTATION_ASCII )          return OUString("impress8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_PRESENTATION_TEMPLATE_ASCII ) return OUString("impress8_template");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_SPREADSHEET_ASCII )           return OUString("calc8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_SPREADSHEET_TEMPLATE_ASCII )  return OUString("calc8_template");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_CHART_ASCII )                 return OUString("chart8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_FORMULA_ASCII )               return OUString("math8");
+    else if ( aMediaType == MIMETYPE_OASIS_OPENDOCUMENT_REPORT_CHART_ASCII )          return OUString("StarBaseReportChart");
+
+    // OOo legacy types
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_WRITER_ASCII )           return OUString("writer_StarOffice_XML_Writer");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_WRITER_TEMPLATE_ASCII )  return OUString("writer_StarOffice_XML_Writer_Template");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_WRITER_WEB_ASCII )       return OUString("writer_web_StarOffice_XML_Writer_Web_Template");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_WRITER_GLOBAL_ASCII )    return OUString("writer_globaldocument_StarOffice_XML_Writer_GlobalDocument");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_DRAW_ASCII )             return OUString("draw_StarOffice_XML_Draw");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_DRAW_TEMPLATE_ASCII )    return OUString("draw_StarOffice_XML_Draw_Template");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_IMPRESS_ASCII )          return OUString("impress_StarOffice_XML_Impress");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_IMPRESS_TEMPLATE_ASCII ) return OUString("impress_StarOffice_XML_Impress_Template");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_CALC_ASCII )             return OUString("calc_StarOffice_XML_Calc");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_CALC_TEMPLATE_ASCII )    return OUString("calc_StarOffice_XML_Calc_Template");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_CHART_ASCII )            return OUString("chart_StarOffice_XML_Chart");
+    else if ( aMediaType == MIMETYPE_VND_SUN_XML_MATH_ASCII )             return OUString("math_StarOffice_XML_Math");
+
+    // Unknown type
+    return OUString();
+}
+
+}
+
+StorageFilterDetect::StorageFilterDetect(const uno::Reference<uno::XComponentContext>& xCxt) :
+    mxCxt(xCxt) {}
+
+StorageFilterDetect::~StorageFilterDetect() {}
+
+OUString SAL_CALL StorageFilterDetect::detect(uno::Sequence<beans::PropertyValue>& rDescriptor)
+    throw (uno::RuntimeException, std::exception)
+{
+    MediaDescriptor aMediaDesc( rDescriptor );
+    OUString aTypeName;
+
+    try
+    {
+        uno::Reference< io::XInputStream > xInStream( aMediaDesc[MediaDescriptor::PROP_INPUTSTREAM()], uno::UNO_QUERY );
+        if ( !xInStream.is() )
+            return OUString();
+
+        uno::Reference< embed::XStorage > xStorage( ::comphelper::OStorageHelper::GetStorageFromInputStream( xInStream, mxCxt ), uno::UNO_QUERY );
+        if ( !xStorage.is() )
+            return OUString();
+
+        uno::Reference< beans::XPropertySet > xStorageProperties( xStorage, uno::UNO_QUERY );
+        if ( !xStorageProperties.is() )
+            return OUString();
+
+        OUString aMediaType;
+        xStorageProperties->getPropertyValue( "MediaType" ) >>= aMediaType;
+        aTypeName = getInternalFromMediaType( aMediaType );
+    }
+
+    catch( const lang::WrappedTargetException& aWrap )
+    {
+        packages::zip::ZipIOException aZipException;
+        // We don't do any type detection on broken packages (f.e. because it might be impossible),
+        // so for repairing we'll use the requested type, which was detected by the flat detection.
+        OUString aRequestedTypeName = aMediaDesc.getUnpackedValueOrDefault( MediaDescriptor::PROP_TYPENAME(), OUString() );
+        if ( ( aWrap.TargetException >>= aZipException ) && !aRequestedTypeName.isEmpty() )
+        {
+            // The package is a broken one.
+            uno::Reference< task::XInteractionHandler > xInteraction =
+                aMediaDesc.getUnpackedValueOrDefault( MediaDescriptor::PROP_INTERACTIONHANDLER(), uno::Reference< task::XInteractionHandler >() );
+
+            if ( xInteraction.is() )
+            {
+                INetURLObject aParser( aMediaDesc.getUnpackedValueOrDefault( MediaDescriptor::PROP_URL(), OUString() ) );
+                OUString aDocumentTitle = aParser.getName( INetURLObject::LAST_SEGMENT, true, INetURLObject::DECODE_WITH_CHARSET );
+                bool bRepairPackage = aMediaDesc.getUnpackedValueOrDefault( "RepairPackage", false );
+                // fdo#46310 Don't try to repair if the user rejected it once.
+                bool bRepairAllowed = aMediaDesc.getUnpackedValueOrDefault( "RepairAllowed", true );
+
+                if ( !bRepairPackage && bRepairAllowed )
+                {
+                    // Ask the user whether he wants to try to repair.
+                    RequestPackageReparation aRequest( aDocumentTitle );
+                    xInteraction->handle( aRequest.GetRequest() );
+
+                    if ( aRequest.isApproved() )
+                    {
+                        aTypeName = aRequestedTypeName;
+                        aMediaDesc[MediaDescriptor::PROP_DOCUMENTTITLE()] <<= aDocumentTitle;
+                        aMediaDesc[MediaDescriptor::PROP_ASTEMPLATE()] <<= true;
+                        aMediaDesc["RepairPackage"] <<= true;
+                    }
+                    else
+                    {
+                        // Repair either not allowed or not successful.
+                        NotifyBrokenPackage aNotifyRequest( aDocumentTitle );
+                        xInteraction->handle( aNotifyRequest.GetRequest() );
+                        aMediaDesc["RepairAllowed"] <<= false;
+                    }
+
+                    // Write the changes back.
+                    aMediaDesc >> rDescriptor;
+                }
+            }
+        }
+    }
+    catch( uno::RuntimeException& )
+    {
+        throw;
+    }
+    catch( uno::Exception& )
+    {}
+
+    return aTypeName;
+}
+
+// XInitialization
+void SAL_CALL StorageFilterDetect::initialize(const uno::Sequence<uno::Any>& /*aArguments*/)
+    throw (uno::Exception, uno::RuntimeException, std::exception) {}
+
+OUString StorageFilterDetect_getImplementationName()
+{
+    return OUString("com.sun.star.comp.filters.StorageFilterDetect");
+}
+
+uno::Sequence<OUString> StorageFilterDetect_getSupportedServiceNames()
+{
+    uno::Sequence<OUString> aRet(2);
+    OUString* pArray = aRet.getArray();
+    pArray[0] = "com.sun.star.document.ExtendedTypeDetection";
+    pArray[1] = "com.sun.star.comp.filters.StorageFilterDetect";
+    return aRet;
+}
+
+uno::Reference<uno::XInterface> StorageFilterDetect_createInstance(
+    const uno::Reference<uno::XComponentContext> & rCxt)
+{
+    return static_cast<cppu::OWeakObject*>(new StorageFilterDetect(rCxt));
+}
+
+// XServiceInfo
+OUString SAL_CALL StorageFilterDetect::getImplementationName()
+    throw (uno::RuntimeException, std::exception)
+{
+    return StorageFilterDetect_getImplementationName();
+}
+
+sal_Bool SAL_CALL StorageFilterDetect::supportsService(const OUString& rServiceName)
+    throw (uno::RuntimeException, std::exception)
+{
+    return cppu::supportsService(this, rServiceName);
+}
+
+uno::Sequence<OUString> SAL_CALL StorageFilterDetect::getSupportedServiceNames()
+    throw (uno::RuntimeException, std::exception)
+{
+    return StorageFilterDetect_getSupportedServiceNames();
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/filter/source/storagefilterdetect/filterdetect.hxx b/filter/source/storagefilterdetect/filterdetect.hxx
new file mode 100644
index 000000000000..385d3c011478
--- /dev/null
+++ b/filter/source/storagefilterdetect/filterdetect.hxx
@@ -0,0 +1,72 @@
+/* -*- 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 .
+ */
+
+#ifndef INCLUDED_FILTER_SOURCE_STORAGEFILTERDETECT_FILTERDETECT_HXX
+#define INCLUDED_FILTER_SOURCE_STORAGEFILTERDETECT_FILTERDETECT_HXX
+
+#include <com/sun/star/document/XExtendedFilterDetection.hpp>
+#include <com/sun/star/lang/XInitialization.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+
+#include <cppuhelper/implbase3.hxx>
+
+class StorageFilterDetect : public cppu::WeakImplHelper3<
+    com::sun::star::document::XExtendedFilterDetection,
+    com::sun::star::lang::XInitialization,
+    com::sun::star::lang::XServiceInfo>
+{
+    com::sun::star::uno::Reference<com::sun::star::uno::XComponentContext> mxCxt;
+
+public:
+
+    StorageFilterDetect (const com::sun::star::uno::Reference<com::sun::star::uno::XComponentContext>& xCxt);
+    virtual ~StorageFilterDetect();
+
+    // XExtendedFilterDetection
+    virtual OUString SAL_CALL detect(com::sun::star::uno::Sequence<com::sun::star::beans::PropertyValue>& rDescriptor)
+            throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
+
+    // XInitialization
+    virtual void SAL_CALL initialize(const ::com::sun::star::uno::Sequence<com::sun::star::uno::Any>& aArguments)
+        throw (com::sun::star::uno::Exception, com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
+
+    // XServiceInfo
+    virtual OUString SAL_CALL getImplementationName()
+        throw (com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
+
+    virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName)
+        throw (com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
+
+    virtual com::sun::star::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames()
+        throw (com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
+};
+
+OUString StorageFilterDetect_getImplementationName();
+
+sal_Bool StorageFilterDetect_supportsService(const OUString& ServiceName);
+
+com::sun::star::uno::Sequence<OUString> StorageFilterDetect_getSupportedServiceNames();
+
+com::sun::star::uno::Reference<com::sun::star::uno::XInterface>
+StorageFilterDetect_createInstance(const com::sun::star::uno::Reference<com::sun::star::uno::XComponentContext>& rCxt);
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/filter/source/storagefilterdetect/storagefd.component b/filter/source/storagefilterdetect/storagefd.component
new file mode 100644
index 000000000000..9f85bfa1efa2
--- /dev/null
+++ b/filter/source/storagefilterdetect/storagefd.component
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * 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/.
+ -->
+
+<component loader="com.sun.star.loader.SharedLibrary" environment="@CPPU_ENV@"
+    prefix="storagefd" xmlns="http://openoffice.org/2010/uno-components">
+  <implementation name="com.sun.star.comp.filters.StorageFilterDetect">
+    <service name="com.sun.star.document.ExtendedTypeDetection"/>
+  </implementation>
+</component>