Add helper for creating zip files

Change-Id: I8b49b74622bf4d671d640e4cd06dc2da348ee222
Reviewed-on: https://gerrit.libreoffice.org/30478Reviewed-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>
Tested-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>

include/unotools/ZipPackageHelper.hxx

+/* -*- 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_UNOTOOLS_ZIPPACKAGEHELPER_HXX
+#define INCLUDED_UNOTOOLS_ZIPPACKAGEHELPER_HXX
+
+#include <unotools/unotoolsdllapi.h>
+
+#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
+#include <com/sun/star/lang/XSingleServiceFactory.hpp>
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#include <com/sun/star/uno/XComponentContext.hpp>
+#include <com/sun/star/uno/XInterface.hpp>
+#include <com/sun/star/io/XInputStream.hpp>
+
+namespace utl {
+
+class UNOTOOLS_DLLPUBLIC ZipPackageHelper
+{
+public:
+    ZipPackageHelper( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+        const OUString& sPackageURL);
+
+    void savePackage();
+
+    void addFile( css::uno::Reference< css::uno::XInterface >& xRootFolder,
+                  const OUString& rSourceFile )
+        throw( css::uno::Exception, std::exception );
+
+    css::uno::Reference< css::uno::XInterface > addFolder( css::uno::Reference< css::uno::XInterface >& xRootFolder,
+                                                           const OUString& rName )
+        throw( css::uno::Exception, std::exception );
+
+    void addFolderWithContent( css::uno::Reference< css::uno::XInterface >& xRootFolder,
+                               const OUString& rDirURL );
+
+    css::uno::Reference< css::uno::XInterface >& getRootFolder();
+
+private:
+    css::uno::Reference< css::uno::XComponentContext > mxContext;
+    css::uno::Reference< css::container::XHierarchicalNameAccess > mxHNameAccess;
+    css::uno::Reference< css::lang::XSingleServiceFactory > mxFactory;
+    css::uno::Reference< css::uno::XInterface > mxRootFolder;
+};
+
+}
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

unotools/Library_utl.mk

@@ -104,6 +104,7 @@ $(eval $(call gb_Library_add_exception_objects,utl,\
     unotools/source/misc/unotoolsservices \
     unotools/source/misc/wincodepage \
     unotools/source/misc/ServiceDocumenter \
+    unotools/source/misc/ZipPackageHelper \
     unotools/source/streaming/streamhelper \
     unotools/source/streaming/streamwrap \
     unotools/source/ucbhelper/localfilehelper \

unotools/source/misc/ZipPackageHelper.cxx

+/* -*- 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 <com/sun/star/io/XActiveDataControl.hpp>
+#include <com/sun/star/io/XActiveDataSource.hpp>
+#include <com/sun/star/frame/XConfigManager.hpp>
+#include <com/sun/star/io/XInputStream.hpp>
+#include <com/sun/star/io/XActiveDataSink.hpp>
+#include <com/sun/star/beans/PropertyValue.hpp>
+#include <com/sun/star/beans/NamedValue.hpp>
+#include <com/sun/star/container/XNamed.hpp>
+#include <com/sun/star/container/XChild.hpp>
+#include <com/sun/star/container/XNameContainer.hpp>
+#include <com/sun/star/util/XChangesBatch.hpp>
+#include <com/sun/star/lang/XUnoTunnel.hpp>
+
+#include <unotools/ZipPackageHelper.hxx>
+#include <comphelper/processfactory.hxx>
+#include <comphelper/oslfile2streamwrap.hxx>
+#include <comphelper/storagehelper.hxx>
+#include <osl/file.hxx>
+#include <unotools/pathoptions.hxx>
+#include <unotools/streamwrap.hxx>
+#include <unotools/tempfile.hxx>
+#include <svl/urihelper.hxx>
+#include <tools/stream.hxx>
+#include <tools/urlobj.hxx>
+
+#include <rtl/uri.hxx>
+
+using namespace utl;
+using namespace osl;
+using namespace comphelper;
+using namespace com::sun::star;
+using namespace com::sun::star::lang;
+using namespace com::sun::star::frame;
+using namespace com::sun::star::uno;
+using namespace com::sun::star::util;
+using namespace com::sun::star::container;
+using namespace com::sun::star::beans;
+using namespace com::sun::star::io;
+
+using ::rtl::Uri;
+
+ZipPackageHelper::ZipPackageHelper(
+    const Reference< XComponentContext >& rxContext,
+    const OUString& sPackageURL)
+: mxContext( rxContext ),
+  mxHNameAccess(),
+  mxFactory(),
+  mxRootFolder()
+{
+    // create the package zip file
+    Sequence< Any > aArguments( 2 );
+    aArguments[ 0 ] <<= sPackageURL;
+
+    // let ZipPackage be used
+    beans::NamedValue aArg;
+    aArg.Name = "StorageFormat";
+    aArg.Value <<= OUString(ZIP_STORAGE_FORMAT_STRING);
+    aArguments[ 1 ] <<= aArg;
+
+    Reference< XHierarchicalNameAccess > xHNameAccess(
+        mxContext->getServiceManager()->createInstanceWithArgumentsAndContext(
+            "com.sun.star.packages.comp.ZipPackage",
+            aArguments, mxContext ), UNO_QUERY);
+    mxHNameAccess = xHNameAccess;
+
+    if( !mxHNameAccess.is() )
+        return;
+
+    Reference<XSingleServiceFactory> xFactory(mxHNameAccess, UNO_QUERY);
+    mxFactory = xFactory;
+
+    // get root zip folder
+    OUString szRootFolder("/");
+    mxHNameAccess->getByHierarchicalName( szRootFolder ) >>= mxRootFolder;
+}
+
+static OUString encodeZipUri( const OUString& rURI )
+{
+    return Uri::encode( rURI, rtl_UriCharClassUric, rtl_UriEncodeCheckEscapes, RTL_TEXTENCODING_UTF8 );
+}
+
+Reference< XInterface >& ZipPackageHelper::getRootFolder()
+{
+    return mxRootFolder;
+}
+
+Reference< XInterface > ZipPackageHelper::addFolder( Reference< XInterface >& xRootFolder,
+                                                     const OUString& rName )
+    throw( css::uno::Exception, std::exception )
+{
+    if ( rName == ".." || rName == "." )
+        throw lang::IllegalArgumentException();
+
+    Sequence< Any > aArgs(1);
+    aArgs[0] <<= true;
+
+    Reference< XInterface > xFolder( mxFactory->createInstanceWithArguments(aArgs) );
+    Reference< XNamed > xNamed( xFolder, UNO_QUERY );
+    Reference< XChild > xChild( xFolder, UNO_QUERY );
+
+    if( xNamed.is() && xChild.is() )
+    {
+        OUString aName( encodeZipUri( rName ) );
+        xNamed->setName( aName );
+        xChild->setParent( xRootFolder );
+    }
+
+    return xFolder;
+}
+
+void ZipPackageHelper::addFolderWithContent( Reference< XInterface >& xRootFolder, const OUString& rDirURL )
+{
+    if (rDirURL.isEmpty())
+        return;
+
+    osl::Directory aDirectory(rDirURL);
+
+    if (aDirectory.open() != osl::FileBase::E_None)
+        return;
+
+    osl::DirectoryItem aDirectoryItem;
+
+    while (osl::FileBase::E_None == aDirectory.getNextItem(aDirectoryItem))
+    {
+        osl::FileStatus aFileStatus(osl_FileStatus_Mask_Type | osl_FileStatus_Mask_FileURL | osl_FileStatus_Mask_FileName);
+
+        if (osl::FileBase::E_None == aDirectoryItem.getFileStatus(aFileStatus))
+        {
+            if (aFileStatus.isDirectory())
+            {
+                const OUString aFileName(aFileStatus.getFileName());
+
+                if (!aFileName.isEmpty())
+                {
+                    Reference<XInterface> folder(addFolder(xRootFolder, aFileName));
+                    addFolderWithContent(folder, aFileStatus.getFileURL());
+                }
+            }
+            else if (aFileStatus.isRegular())
+            {
+                addFile(xRootFolder, aFileStatus.getFileURL());
+            }
+        }
+    }
+}
+
+void ZipPackageHelper::addFile( css::uno::Reference< css::uno::XInterface >& xRootFolder,
+                                const OUString& rSourceFile )
+    throw( Exception, std::exception )
+{
+    OUString aFileURL( rSourceFile );
+
+    /*if( !aFileURL.matchIgnoreAsciiCase("file://") )
+    {
+        aFileURL = URIHelper::SmartRel2Abs( aFileURL, Link<OUString *, bool>(), false );
+    }*/
+
+    INetURLObject aURL( aFileURL );
+    OUString aName( aURL.getName() );
+
+    SvFileStream* pStream = new SvFileStream(aFileURL, StreamMode::READ );
+    Reference< XInputStream > xInput(  new utl::OSeekableInputStreamWrapper( pStream, true ) );
+    Reference< XActiveDataSink > xSink( mxFactory->createInstance(), UNO_QUERY );
+    Reference< XUnoTunnel > xTunnel( xSink, UNO_QUERY );
+    if( !xSink.is() || !xTunnel.is())
+        return;
+
+    Reference< XNameContainer > xNameContainer(xRootFolder, UNO_QUERY );
+    xNameContainer->insertByName(encodeZipUri( aName ), makeAny(xTunnel));
+    xSink->setInputStream( xInput );
+}
+
+void ZipPackageHelper::savePackage()
+{
+    Reference< XChangesBatch > xBatch( mxHNameAccess, UNO_QUERY );
+    if( xBatch.is() )
+        xBatch->commitChanges();
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */