office-gobmx/package/source/xstor/xfactory.cxx
Noel Grandin 20bae560c0 throw more useful uno::Exception's
if we're going to throw the base class of the exception hierarchy,
we can at least put a useful message in there to make the source a little
bit easier to locate.

Change-Id: I2f3106c99ba25125eacef8fa77e2f3a2c89f2566
Reviewed-on: https://gerrit.libreoffice.org/42968
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2017-10-01 18:17:11 +02:00

298 lines
11 KiB
C++

/* -*- 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 <sal/config.h>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ucb/SimpleFileAccess.hpp>
#include <com/sun/star/embed/ElementModes.hpp>
#include <com/sun/star/embed/StorageFormats.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/io/IOException.hpp>
#include <com/sun/star/io/TempFile.hpp>
#include <com/sun/star/io/XSeekable.hpp>
#include <comphelper/processfactory.hxx>
#include <comphelper/storagehelper.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <osl/diagnose.h>
#include "xfactory.hxx"
#include "xstorage.hxx"
using namespace ::com::sun::star;
#if OSL_DEBUG_LEVEL > 0
#define THROW_WHERE SAL_WHERE
#else
#define THROW_WHERE ""
#endif
bool CheckPackageSignature_Impl( const uno::Reference< io::XInputStream >& xInputStream,
const uno::Reference< io::XSeekable >& xSeekable )
{
if ( !xInputStream.is() || !xSeekable.is() )
throw uno::RuntimeException();
if ( xSeekable->getLength() )
{
uno::Sequence< sal_Int8 > aData( 4 );
xSeekable->seek( 0 );
sal_Int32 nRead = xInputStream->readBytes( aData, 4 );
xSeekable->seek( 0 );
// TODO/LATER: should the disk spanned files be supported?
// 0x50, 0x4b, 0x07, 0x08
return ( nRead == 4 && aData[0] == 0x50 && aData[1] == 0x4b && aData[2] == 0x03 && aData[3] == 0x04 );
}
else
return true; // allow to create a storage based on empty stream
}
uno::Sequence< OUString > SAL_CALL OStorageFactory::impl_staticGetSupportedServiceNames()
{
uno::Sequence< OUString > aRet(2);
aRet[0] = "com.sun.star.embed.StorageFactory";
aRet[1] = "com.sun.star.comp.embed.StorageFactory";
return aRet;
}
OUString SAL_CALL OStorageFactory::impl_staticGetImplementationName()
{
return OUString("com.sun.star.comp.embed.StorageFactory");
}
uno::Reference< uno::XInterface > SAL_CALL OStorageFactory::impl_staticCreateSelfInstance(
const uno::Reference< lang::XMultiServiceFactory >& xServiceManager )
{
return uno::Reference< uno::XInterface >( *new OStorageFactory( comphelper::getComponentContext(xServiceManager) ) );
}
uno::Reference< uno::XInterface > SAL_CALL OStorageFactory::createInstance()
{
// TODO: reimplement TempStream service to support XStream interface
uno::Reference < io::XStream > xTempStream(
io::TempFile::create(m_xContext),
uno::UNO_QUERY_THROW );
return uno::Reference< uno::XInterface >(
static_cast< OWeakObject* >( new OStorage( xTempStream,
embed::ElementModes::READWRITE,
uno::Sequence< beans::PropertyValue >(),
m_xContext,
embed::StorageFormats::PACKAGE ) ),
uno::UNO_QUERY );
}
uno::Reference< uno::XInterface > SAL_CALL OStorageFactory::createInstanceWithArguments(
const uno::Sequence< uno::Any >& aArguments )
{
// The request for storage can be done with up to three arguments
// The first argument specifies a source for the storage
// it can be URL, XStream, XInputStream.
// The second value is a mode the storage should be open in.
// And the third value is a media descriptor.
sal_Int32 nArgNum = aArguments.getLength();
OSL_ENSURE( nArgNum < 4, "Wrong parameter number" );
if ( !nArgNum )
return createInstance();
// first try to retrieve storage open mode if any
// by default the storage will be open in readonly mode
sal_Int32 nStorageMode = embed::ElementModes::READ;
if ( nArgNum >= 2 )
{
if( !( aArguments[1] >>= nStorageMode ) )
{
OSL_FAIL( "Wrong second argument!" );
throw lang::IllegalArgumentException(); // TODO:
}
// it's always possible to read written storage in this implementation
nStorageMode |= embed::ElementModes::READ;
}
if ( ( nStorageMode & embed::ElementModes::TRUNCATE ) == embed::ElementModes::TRUNCATE
&& ( nStorageMode & embed::ElementModes::WRITE ) != embed::ElementModes::WRITE )
throw lang::IllegalArgumentException(); // TODO:
// retrieve storage source stream
OUString aURL;
uno::Reference< io::XStream > xStream;
uno::Reference< io::XInputStream > xInputStream;
if ( aArguments[0] >>= aURL )
{
if ( aURL.isEmpty() )
{
OSL_FAIL( "Empty URL is provided!" );
throw lang::IllegalArgumentException(); // TODO:
}
if ( aURL.startsWithIgnoreAsciiCase("vnd.sun.star.pkg:") )
{
OSL_FAIL( "Packages URL's are not valid for storages!" ); // ???
throw lang::IllegalArgumentException(); // TODO:
}
uno::Reference < ucb::XSimpleFileAccess3 > xTempAccess(
ucb::SimpleFileAccess::create(
m_xContext ) );
if ( nStorageMode & embed::ElementModes::WRITE )
xStream = xTempAccess->openFileReadWrite( aURL );
else
xInputStream = xTempAccess->openFileRead( aURL );
}
else if ( !( aArguments[0] >>= xStream ) && !( aArguments[0] >>= xInputStream ) )
{
OSL_FAIL( "Wrong first argument!" );
throw uno::Exception("wrong first arg", nullptr); // TODO: Illegal argument
}
// retrieve mediadescriptor and set storage properties
uno::Sequence< beans::PropertyValue > aDescr;
uno::Sequence< beans::PropertyValue > aPropsToSet;
sal_Int32 nStorageType = embed::StorageFormats::PACKAGE;
if ( nArgNum >= 3 )
{
if( aArguments[2] >>= aDescr )
{
if ( !aURL.isEmpty() )
{
aPropsToSet.realloc(1);
aPropsToSet[0].Name = "URL";
aPropsToSet[0].Value <<= aURL;
}
for ( sal_Int32 nInd = 0, nNumArgs = 1; nInd < aDescr.getLength(); nInd++ )
{
if ( aDescr[nInd].Name == "InteractionHandler"
|| aDescr[nInd].Name == "Password"
|| aDescr[nInd].Name == "RepairPackage"
|| aDescr[nInd].Name == "StatusIndicator" )
{
aPropsToSet.realloc( ++nNumArgs );
aPropsToSet[nNumArgs-1].Name = aDescr[nInd].Name;
aPropsToSet[nNumArgs-1].Value = aDescr[nInd].Value;
}
else if ( aDescr[nInd].Name == "StorageFormat" )
{
OUString aFormatName;
sal_Int32 nFormatID = 0;
if ( aDescr[nInd].Value >>= aFormatName )
{
if ( aFormatName == PACKAGE_STORAGE_FORMAT_STRING )
nStorageType = embed::StorageFormats::PACKAGE;
else if ( aFormatName == ZIP_STORAGE_FORMAT_STRING )
nStorageType = embed::StorageFormats::ZIP;
else if ( aFormatName == OFOPXML_STORAGE_FORMAT_STRING )
nStorageType = embed::StorageFormats::OFOPXML;
else
throw lang::IllegalArgumentException( THROW_WHERE, uno::Reference< uno::XInterface >(), 1 );
}
else if ( aDescr[nInd].Value >>= nFormatID )
{
if ( nFormatID != embed::StorageFormats::PACKAGE
&& nFormatID != embed::StorageFormats::ZIP
&& nFormatID != embed::StorageFormats::OFOPXML )
throw lang::IllegalArgumentException( THROW_WHERE, uno::Reference< uno::XInterface >(), 1 );
nStorageType = nFormatID;
}
else
throw lang::IllegalArgumentException( THROW_WHERE, uno::Reference< uno::XInterface >(), 1 );
}
else
OSL_FAIL( "Unacceptable property, will be ignored!" );
}
}
else
{
OSL_FAIL( "Wrong third argument!" );
throw uno::Exception("wrong 3rd arg", nullptr); // TODO: Illegal argument
}
}
// create storage based on source
if ( xInputStream.is() )
{
// if xInputStream is set the storage should be open from it
if ( nStorageMode & embed::ElementModes::WRITE )
throw uno::Exception("storagemode==write", nullptr); // TODO: access denied
uno::Reference< io::XSeekable > xSeekable( xInputStream, uno::UNO_QUERY );
if ( !xSeekable.is() )
{
// TODO: wrap stream to let it be seekable
OSL_FAIL( "Nonseekable streams are not supported for now!" );
}
if ( !CheckPackageSignature_Impl( xInputStream, xSeekable ) )
throw io::IOException(); // TODO: this is not a package file
return uno::Reference< uno::XInterface >(
static_cast< OWeakObject* >( new OStorage( xInputStream, nStorageMode, aPropsToSet, m_xContext, nStorageType ) ),
uno::UNO_QUERY );
}
else if ( xStream.is() )
{
if ( ( ( nStorageMode & embed::ElementModes::WRITE ) && !xStream->getOutputStream().is() )
|| !xStream->getInputStream().is() )
throw uno::Exception("access denied", nullptr); // TODO: access denied
uno::Reference< io::XSeekable > xSeekable( xStream, uno::UNO_QUERY );
if ( !xSeekable.is() )
{
// TODO: wrap stream to let it be seekable
OSL_FAIL( "Nonseekable streams are not supported for now!" );
}
if ( !CheckPackageSignature_Impl( xStream->getInputStream(), xSeekable ) )
throw io::IOException(); // TODO: this is not a package file
return uno::Reference< uno::XInterface >(
static_cast< OWeakObject* >( new OStorage( xStream, nStorageMode, aPropsToSet, m_xContext, nStorageType ) ),
uno::UNO_QUERY );
}
throw uno::Exception("no input stream or regular stream", nullptr); // general error during creation
}
OUString SAL_CALL OStorageFactory::getImplementationName()
{
return impl_staticGetImplementationName();
}
sal_Bool SAL_CALL OStorageFactory::supportsService( const OUString& ServiceName )
{
return cppu::supportsService(this, ServiceName);
}
uno::Sequence< OUString > SAL_CALL OStorageFactory::getSupportedServiceNames()
{
return impl_staticGetSupportedServiceNames();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */