Files
Mike Kaganski 8985041da5 Throw from OText{Input,Output}Stream::setEncoding on unknown encoding
Before this, it was possible to pass an arbitrary string to the method,
and have no way of knowing about the problem. IllegalArgumentException
is derived from RuntimeException, which is explicitly documented to be
allowed at every interface method, signalling errors not covered by the
interface method specification, so this is not an API change.

Change-Id: I038f7765ec3f332f0e787351fa032feeef2cefb0
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/190048
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Tested-by: Jenkins
2025-08-22 18:40:40 +02:00

231 lines
7.0 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 <cppuhelper/implbase.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <rtl/textenc.h>
#include <rtl/tencinfo.h>
#include <com/sun/star/io/IOException.hpp>
#include <com/sun/star/io/XTextOutputStream2.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <optional>
namespace com::sun::star::uno { class XComponentContext; }
using namespace ::cppu;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::io;
// Implementation XTextOutputStream
namespace {
class OTextOutputStream : public WeakImplHelper< XTextOutputStream2, XServiceInfo >
{
Reference< XOutputStream > mxStream;
struct Encoding_t
{
rtl_UnicodeToTextConverter mConvUnicode2Text;
rtl_UnicodeToTextContext mContextUnicode2Text;
Encoding_t(rtl_TextEncoding encoding)
{
mConvUnicode2Text = rtl_createUnicodeToTextConverter(encoding);
mContextUnicode2Text = rtl_createUnicodeToTextContext(mConvUnicode2Text);
}
~Encoding_t()
{
rtl_destroyUnicodeToTextContext(mConvUnicode2Text, mContextUnicode2Text);
rtl_destroyUnicodeToTextConverter(mConvUnicode2Text);
}
};
std::optional<Encoding_t> moEncoding;
Sequence<sal_Int8> implConvert( const OUString& rSource );
/// @throws IOException
void checkOutputStream() const;
public:
// Methods XTextOutputStream
virtual void SAL_CALL writeString( const OUString& aString ) override;
virtual void SAL_CALL setEncoding( const OUString& Encoding ) override;
// Methods XOutputStream
virtual void SAL_CALL writeBytes( const Sequence< sal_Int8 >& aData ) override;
virtual void SAL_CALL flush( ) override;
virtual void SAL_CALL closeOutput( ) override;
// Methods XActiveDataSource
virtual void SAL_CALL setOutputStream( const Reference< XOutputStream >& aStream ) override;
virtual Reference< XOutputStream > SAL_CALL getOutputStream( ) override;
// Methods XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
};
}
Sequence<sal_Int8> OTextOutputStream::implConvert( const OUString& rSource )
{
const sal_Unicode *puSource = rSource.getStr();
sal_Int32 nSourceSize = rSource.getLength();
sal_Size nTargetCount = 0;
sal_Size nSourceCount = 0;
sal_uInt32 uiInfo;
sal_Size nSrcCvtChars;
// take nSourceSize * 3 as preference
// this is an upper boundary for converting to utf8,
// which most often used as the target.
sal_Int32 nSeqSize = nSourceSize * 3;
Sequence<sal_Int8> seqText( nSeqSize );
char *pTarget = reinterpret_cast<char *>(seqText.getArray());
while( true )
{
nTargetCount += rtl_convertUnicodeToText(
moEncoding->mConvUnicode2Text,
moEncoding->mContextUnicode2Text,
&( puSource[nSourceCount] ),
nSourceSize - nSourceCount ,
&( pTarget[nTargetCount] ),
nSeqSize - nTargetCount,
RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT |
RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT ,
&uiInfo,
&nSrcCvtChars);
nSourceCount += nSrcCvtChars;
if( uiInfo & RTL_UNICODETOTEXT_INFO_DESTBUFFERTOSMALL )
{
nSeqSize *= 2;
seqText.realloc( nSeqSize ); // double array size
pTarget = reinterpret_cast<char*>(seqText.getArray());
continue;
}
break;
}
// reduce the size of the buffer (fast, no copy necessary)
seqText.realloc( nTargetCount );
return seqText;
}
// XTextOutputStream
void OTextOutputStream::writeString( const OUString& aString )
{
checkOutputStream();
if (!moEncoding)
{
setEncoding( u"utf8"_ustr );
}
Sequence<sal_Int8> aByteSeq = implConvert( aString );
mxStream->writeBytes( aByteSeq );
}
void OTextOutputStream::setEncoding( const OUString& Encoding )
{
OString aOEncodingStr = OUStringToOString( Encoding, RTL_TEXTENCODING_ASCII_US );
rtl_TextEncoding encoding = rtl_getTextEncodingFromMimeCharset( aOEncodingStr.getStr() );
if( RTL_TEXTENCODING_DONTKNOW == encoding )
throw IllegalArgumentException("Unknown encoding '" + Encoding + "'", getXWeak(), 0);
moEncoding.emplace(encoding);
}
// XOutputStream
void OTextOutputStream::writeBytes( const Sequence< sal_Int8 >& aData )
{
checkOutputStream();
mxStream->writeBytes( aData );
}
void OTextOutputStream::flush( )
{
checkOutputStream();
mxStream->flush();
}
void OTextOutputStream::closeOutput( )
{
checkOutputStream();
mxStream->closeOutput();
}
void OTextOutputStream::checkOutputStream() const
{
if (! mxStream.is() )
throw IOException(u"output stream is not initialized, you have to use setOutputStream first"_ustr);
}
// XActiveDataSource
void OTextOutputStream::setOutputStream( const Reference< XOutputStream >& aStream )
{
mxStream = aStream;
}
Reference< XOutputStream > OTextOutputStream::getOutputStream()
{
return mxStream;
}
OUString OTextOutputStream::getImplementationName()
{
return u"com.sun.star.comp.io.TextOutputStream"_ustr;
}
sal_Bool OTextOutputStream::supportsService(const OUString& ServiceName)
{
return cppu::supportsService(this, ServiceName);
}
Sequence< OUString > OTextOutputStream::getSupportedServiceNames()
{
return { u"com.sun.star.io.TextOutputStream"_ustr };
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
io_OTextOutputStream_get_implementation(
css::uno::XComponentContext* , css::uno::Sequence<css::uno::Any> const&)
{
return cppu::acquire(new OTextOutputStream);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */