zipfileaccess.cxx

Go to the documentation of this file.

/* -*- 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/lang/DisposedException.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/io/NotConnectedException.hpp>
#include <com/sun/star/io/XActiveDataSink.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/io/XSeekable.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/exc_hlp.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <zipfileaccess.hxx>
#include "ZipPackageSink.hxx"
#include <EncryptionData.hxx>
 
#include <ucbhelper/content.hxx>
#include <rtl/ref.hxx>
#include <sal/log.hxx>
#include <osl/diagnose.h>
 
using namespace ::com::sun::star;
 
#if OSL_DEBUG_LEVEL > 0
#define THROW_WHERE SAL_WHERE
#else
#define THROW_WHERE ""
#endif
 
OZipFileAccess::OZipFileAccess( const uno::Reference< uno::XComponentContext >& rxContext )
: m_aMutexHolder( new comphelper::RefCountedMutex )
, m_xContext( rxContext )
, m_bDisposed( false )
, m_bOwnContent( false )
{
    if ( !rxContext.is() )
        throw uno::RuntimeException(THROW_WHERE );
}
 
OZipFileAccess::~OZipFileAccess()
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
    if ( !m_bDisposed )
    {
        try {
             // dispose will use refcounting so the further destruction must be avoided
            osl_atomic_increment(&m_refCount);
            dispose();
        } catch( uno::Exception& )
        {}
    }
}
 
uno::Sequence< OUString > OZipFileAccess::GetPatternsFromString_Impl( const OUString& aString )
{
    if ( aString.isEmpty() )
        return uno::Sequence< OUString >();
 
    uno::Sequence< OUString > aPattern( 1 );
    auto pPattern = aPattern.getArray();
    sal_Int32 nInd = 0;
 
    const sal_Unicode* pString = aString.getStr();
    while( *pString )
    {
        if ( *pString == '\\' )
        {
            pString++;
 
            if ( *pString == '\\' )
            {
                pPattern[nInd] += "\\";
                pString++;
            }
            else if ( *pString == '*' )
            {
                pPattern[nInd] += "*";
                pString++;
            }
            else
            {
                OSL_FAIL( "The backslash is not guarded!" );
                pPattern[nInd] += "\\";
            }
        }
        else if ( *pString == '*' )
        {
            aPattern.realloc( ( ++nInd ) + 1 );
            pPattern = aPattern.getArray();
            pString++;
        }
        else
        {
            pPattern[nInd] += OUStringChar( *pString );
            pString++;
        }
    }
 
    return aPattern;
}
 
bool OZipFileAccess::StringGoodForPattern_Impl( std::u16string_view aString,
                                                    const uno::Sequence< OUString >& aPattern )
{
    sal_Int32 nInd = aPattern.getLength() - 1;
    if ( nInd < 0 )
        return false;
 
    if ( nInd == 0 )
    {
        if ( aPattern[0].isEmpty() )
            return true;
 
        return aString == aPattern[0];
    }
 
    sal_Int32 nBeginInd = aPattern[0].getLength();
    sal_Int32 nEndInd = aString.size() - aPattern[nInd].getLength();
    if ( nEndInd < nBeginInd
      || ( nEndInd != sal_Int32(aString.size()) && aString.substr( nEndInd ) != aPattern[nInd] )
      || ( nBeginInd != 0 && aString.substr( 0, nBeginInd ) != aPattern[0] ) )
          return false;
 
    for ( sal_Int32 nCurInd = aPattern.getLength() - 2; nCurInd > 0; nCurInd-- )
    {
        if ( aPattern[nCurInd].isEmpty() )
            continue;
 
        if ( nEndInd == nBeginInd )
            return false;
 
        // check that search does not use nEndInd position
        size_t nLastInd = aString.substr(0, nEndInd - 1).rfind( aPattern[nCurInd] );
 
        if ( nLastInd == std::u16string_view::npos )
            return false;
 
        if ( sal_Int32(nLastInd) < nBeginInd )
            return false;
 
        nEndInd = nLastInd;
    }
 
    return true;
}
 
// XInitialization
void SAL_CALL OZipFileAccess::initialize( const uno::Sequence< uno::Any >& aArguments )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE ); // initialization is allowed only one time
 
    if ( !aArguments.hasElements() )
        throw lang::IllegalArgumentException(THROW_WHERE, uno::Reference< uno::XInterface >(), 1 );
 
    OSL_ENSURE( aArguments.getLength() == 1, "Too many arguments are provided, only the first one will be used!" );
 
    OUString aParamURL;
    uno::Reference< io::XStream > xStream;
    uno::Reference< io::XSeekable > xSeekable;
    uno::Sequence<beans::NamedValue> aArgs;
 
    auto openInputStream = [&]()
    {
        ::ucbhelper::Content aContent(
            aParamURL,
            uno::Reference< css::ucb::XCommandEnvironment >(),
            m_xContext );
        uno::Reference < io::XActiveDataSink > xSink = new ZipPackageSink;
        if ( aContent.openStream ( xSink ) )
        {
            m_xContentStream = xSink->getInputStream();
            m_bOwnContent = true;
            xSeekable.set( m_xContentStream, uno::UNO_QUERY );
        }
    };
 
    if ( aArguments[0] >>= aParamURL )
    {
        openInputStream();
    }
    else if ( aArguments[0] >>= xStream )
    {
        // a writable stream can implement both XStream & XInputStream
        m_xContentStream = xStream->getInputStream();
        xSeekable.set( xStream, uno::UNO_QUERY );
    }
    else if ( aArguments[0] >>= m_xContentStream )
    {
        xSeekable.set( m_xContentStream, uno::UNO_QUERY );
    }
    else if (aArguments[0] >>= aArgs)
    {
        for (const beans::NamedValue& rArg : std::as_const(aArgs))
        {
            if (rArg.Name == "URL")
                rArg.Value >>= aParamURL;
        }
 
        if (aParamURL.isEmpty())
            throw lang::IllegalArgumentException(
                THROW_WHERE"required argument 'URL' is not given or invalid.",
                uno::Reference<uno::XInterface>(), 1);
 
        openInputStream();
    }
    else
        throw lang::IllegalArgumentException(THROW_WHERE, uno::Reference< uno::XInterface >(), 1 );
 
    if ( !m_xContentStream.is() )
        throw io::IOException(THROW_WHERE );
 
    if ( !xSeekable.is() )
    {
        // TODO: after fwkbugfix02 is integrated a helper class can be used to make the stream seekable
        throw io::IOException(THROW_WHERE );
    }
 
    // TODO: in case xSeekable is implemented on separated XStream implementation a wrapper is required
    m_pZipFile.emplace(
                m_aMutexHolder,
                m_xContentStream,
                m_xContext,
                true );
}
 
// XNameAccess
uno::Any SAL_CALL OZipFileAccess::getByName( const OUString& aName )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE);
 
    EntryHash::iterator aIter = m_pZipFile->GetEntryHash().find( aName );
    if ( aIter == m_pZipFile->GetEntryHash().end() )
        throw container::NoSuchElementException(THROW_WHERE );
 
    uno::Reference< io::XInputStream > xEntryStream;
    try
    {
        xEntryStream  = m_pZipFile->getDataStream((*aIter).second,
                                                  ::rtl::Reference< EncryptionData >(),
                                                  false,
                                                  m_aMutexHolder);
    }
    catch (const container::NoSuchElementException&)
    {
        throw;
    }
    catch (const lang::WrappedTargetException&)
    {
        throw;
    }
    catch (const uno::RuntimeException&)
    {
        throw;
    }
    catch (const uno::Exception&)
    {
        css::uno::Any anyEx = cppu::getCaughtException();
        throw lang::WrappedTargetException( "This package is unusable!",
                  getXWeak(), anyEx);
    }
 
    if ( !xEntryStream.is() )
        throw uno::RuntimeException(THROW_WHERE );
 
    return uno::Any ( xEntryStream );
}
 
uno::Sequence< OUString > SAL_CALL OZipFileAccess::getElementNames()
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE);
 
    uno::Sequence< OUString > aNames( m_pZipFile->GetEntryHash().size() );
    auto pNames = aNames.getArray();
    sal_Int32 nLen = 0;
 
    for ( const auto& rEntry : m_pZipFile->GetEntryHash() )
    {
        if ( aNames.getLength() < ++nLen )
        {
            OSL_FAIL( "The size must be the same!" );
            aNames.realloc( nLen );
            pNames = aNames.getArray();
        }
 
        pNames[nLen-1] = rEntry.second.sPath;
    }
 
    if ( aNames.getLength() != nLen )
    {
        OSL_FAIL( "The size must be the same!" );
        aNames.realloc( nLen );
    }
 
    return aNames;
}
 
sal_Bool SAL_CALL OZipFileAccess::hasByName( const OUString& aName )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE);
 
    EntryHash::iterator aIter = m_pZipFile->GetEntryHash().find( aName );
 
    return ( aIter != m_pZipFile->GetEntryHash().end() );
}
 
uno::Type SAL_CALL OZipFileAccess::getElementType()
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE);
 
    return cppu::UnoType<io::XInputStream>::get();
}
 
sal_Bool SAL_CALL OZipFileAccess::hasElements()
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw uno::RuntimeException(THROW_WHERE);
 
    return ( !m_pZipFile->GetEntryHash().empty() );
}
 
// XZipFileAccess
uno::Reference< io::XInputStream > SAL_CALL OZipFileAccess::getStreamByPattern( const OUString& aPatternString )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pZipFile )
        throw io::NotConnectedException(THROW_WHERE );
 
    // Code to compare strings by patterns
    uno::Sequence< OUString > aPattern = GetPatternsFromString_Impl( aPatternString );
 
    auto aIter = std::find_if(m_pZipFile->GetEntryHash().begin(), m_pZipFile->GetEntryHash().end(),
        [&aPattern](const EntryHash::value_type& rEntry) { return StringGoodForPattern_Impl(rEntry.second.sPath, aPattern); });
    if (aIter != m_pZipFile->GetEntryHash().end())
    {
        uno::Reference< io::XInputStream > xEntryStream( m_pZipFile->getDataStream( (*aIter).second,
                                                                                    ::rtl::Reference< EncryptionData >(),
                                                                                    false,
                                                                                    m_aMutexHolder ) );
 
        if ( !xEntryStream.is() )
            throw uno::RuntimeException(THROW_WHERE );
        return xEntryStream;
    }
 
    throw container::NoSuchElementException(THROW_WHERE );
}
 
// XComponent
void SAL_CALL OZipFileAccess::dispose()
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( m_pListenersContainer )
    {
        lang::EventObject aSource( getXWeak() );
        m_pListenersContainer->disposeAndClear( aSource );
        m_pListenersContainer.reset();
    }
 
    m_pZipFile.reset();
 
    if ( m_xContentStream.is() && m_bOwnContent )
        try {
            m_xContentStream->closeInput();
        } catch( uno::Exception& )
        {}
 
    m_bDisposed = true;
}
 
void SAL_CALL OZipFileAccess::addEventListener( const uno::Reference< lang::XEventListener >& xListener )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( !m_pListenersContainer )
        m_pListenersContainer.reset( new ::comphelper::OInterfaceContainerHelper3<css::lang::XEventListener>( m_aMutexHolder->GetMutex() ) );
    m_pListenersContainer->addInterface( xListener );
}
 
void SAL_CALL OZipFileAccess::removeEventListener( const uno::Reference< lang::XEventListener >& xListener )
{
    ::osl::MutexGuard aGuard( m_aMutexHolder->GetMutex() );
 
    if ( m_bDisposed )
        throw lang::DisposedException(THROW_WHERE );
 
    if ( m_pListenersContainer )
        m_pListenersContainer->removeInterface( xListener );
}
 
OUString SAL_CALL OZipFileAccess::getImplementationName()
{
    return "com.sun.star.comp.package.zip.ZipFileAccess";
}
 
sal_Bool SAL_CALL OZipFileAccess::supportsService( const OUString& ServiceName )
{
    return cppu::supportsService(this, ServiceName);
}
 
uno::Sequence< OUString > SAL_CALL OZipFileAccess::getSupportedServiceNames()
{
    return { "com.sun.star.packages.zip.ZipFileAccess",
    "com.sun.star.comp.packages.zip.ZipFileAccess" };
}
 
 
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
package_OZipFileAccess_get_implementation(
    css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
{
    return cppu::acquire(new OZipFileAccess(context));
}
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */