vcl/win/dtrans/DataFmtTransl.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "DataFmtTransl.hxx"
  21 #include <rtl/string.hxx>
  22 #include <osl/diagnose.h>
  23 #include <rtl/tencinfo.h>
  24 #include "ImplHelper.hxx"
  25 #include "WinClip.hxx"
  26 #include "MimeAttrib.hxx"
  27 #include "DTransHelper.hxx"
  28 #include <rtl/string.h>
  29 #include <o3tl/char16_t2wchar_t.hxx>
  30 #include "Fetc.hxx"
  31 #include <com/sun/star/datatransfer/DataFormatTranslator.hpp>
  32
  33 #if !defined WIN32_LEAN_AND_MEAN
  34 # define WIN32_LEAN_AND_MEAN
  35 #endif
  36 #include <windows.h>
  37 #include <shlobj.h>
  38
  39 using namespace com::sun::star::uno;
  40 using namespace com::sun::star::datatransfer;
  41 using namespace com::sun::star::lang;
  42
  43 const Type       CPPUTYPE_SALINT32   = cppu::UnoType<sal_Int32>::get();
  44 const Type       CPPUTYPE_SALINT8    = cppu::UnoType<sal_Int8>::get();
  45 const Type       CPPUTYPE_OUSTRING   = cppu::UnoType<OUString>::get();
  46 const Type       CPPUTYPE_SEQSALINT8 = cppu::UnoType<Sequence< sal_Int8>>::get();
  47 const sal_Int32  MAX_CLIPFORMAT_NAME = 256;
  48
  49 CDataFormatTranslator::CDataFormatTranslator( const Reference< XComponentContext >& rxContext )
  50 {
  51     m_XDataFormatTranslator = DataFormatTranslator::create( rxContext );
  52 }
  53
  54 CFormatEtc CDataFormatTranslator::getFormatEtcFromDataFlavor( const DataFlavor& aDataFlavor ) const
  55 {
  56     sal_Int32 cf = CF_INVALID;
  57
  58     try
  59     {
  60         if( m_XDataFormatTranslator.is( ) )
  61         {
  62             Any aFormat = m_XDataFormatTranslator->getSystemDataTypeFromDataFlavor( aDataFlavor );
  63
  64             if ( aFormat.hasValue( ) )
  65             {
  66                 if ( aFormat.getValueType( ) == CPPUTYPE_SALINT32 )
  67                 {
  68                     aFormat >>= cf;
  69                     OSL_ENSURE( CF_INVALID != cf, "Invalid Clipboard format delivered" );
  70                 }
  71                 else if ( aFormat.getValueType( ) == CPPUTYPE_OUSTRING )
  72                 {
  73                     OUString aClipFmtName;
  74                     aFormat >>= aClipFmtName;
  75
  76                     OSL_ASSERT( aClipFmtName.getLength( ) );
  77                     cf = RegisterClipboardFormatW( o3tl::toW(aClipFmtName.getStr( )) );
  78
  79                     OSL_ENSURE( CF_INVALID != cf, "RegisterClipboardFormat failed" );
  80                 }
  81                 else
  82                     OSL_FAIL( "Wrong Any-Type detected" );
  83             }
  84         }
  85     }
  86     catch( ... )
  87     {
  88         OSL_FAIL( "Unexpected error" );
  89     }
  90
  91     return sal::static_int_cast<CFormatEtc>(getFormatEtcForClipformat( sal::static_int_cast<CLIPFORMAT>(cf) ));
  92 }
  93
  94 DataFlavor CDataFormatTranslator::getDataFlavorFromFormatEtc(sal_uInt32 cfFormat, LCID lcid) const
  95 {
  96     DataFlavor aFlavor;
  97
  98     try
  99     {
 100         CLIPFORMAT aClipformat = cfFormat;
 101
 102         Any aAny;
 103         aAny <<= static_cast< sal_Int32 >( aClipformat );
 104
 105         if ( isOemOrAnsiTextFormat( aClipformat ) )
 106         {
 107             aFlavor.MimeType             = "text/plain;charset=";
 108             aFlavor.MimeType            += getTextCharsetFromLCID( lcid, aClipformat );
 109
 110             aFlavor.HumanPresentableName = "OEM/ANSI Text";
 111             aFlavor.DataType             = CPPUTYPE_SEQSALINT8;
 112         }
 113         else if ( CF_INVALID != aClipformat )
 114         {
 115             if ( m_XDataFormatTranslator.is( ) )
 116             {
 117                 aFlavor = m_XDataFormatTranslator->getDataFlavorFromSystemDataType( aAny );
 118
 119                 if ( !aFlavor.MimeType.getLength( ) )
 120                 {
 121                     // lookup of DataFlavor from clipboard format id
 122                     // failed, so we try to resolve via clipboard
 123                     // format name
 124                     OUString clipFormatName = getClipboardFormatName( aClipformat );
 125
 126                     // if we could not get a clipboard format name an
 127                     // error must have occurred or it is a standard
 128                     // clipboard format that we don't translate, e.g.
 129                     // CF_BITMAP (the office only uses CF_DIB)
 130                     if ( clipFormatName.getLength( ) )
 131                     {
 132                         aAny <<= clipFormatName;
 133                         aFlavor = m_XDataFormatTranslator->getDataFlavorFromSystemDataType( aAny );
 134                     }
 135                 }
 136             }
 137         }
 138     }
 139     catch( ... )
 140     {
 141         OSL_FAIL( "Unexpected error" );
 142     }
 143
 144     return aFlavor;
 145 }
 146
 147 CFormatEtc CDataFormatTranslator::getFormatEtcForClipformatName( const OUString& aClipFmtName )
 148 {
 149     // check parameter
 150     if ( !aClipFmtName.getLength( ) )
 151         return CFormatEtc( CF_INVALID );
 152
 153     CLIPFORMAT cf = sal::static_int_cast<CLIPFORMAT>(RegisterClipboardFormatW( o3tl::toW(aClipFmtName.getStr( )) ));
 154     return getFormatEtcForClipformat( cf );
 155 }
 156
 157 OUString CDataFormatTranslator::getClipboardFormatName( CLIPFORMAT aClipformat )
 158 {
 159     OSL_PRECOND( CF_INVALID != aClipformat, "Invalid clipboard format" );
 160
 161     sal_Unicode wBuff[ MAX_CLIPFORMAT_NAME + 1 ]; // Null terminator isn't counted, apparently.
 162     sal_Int32   nLen = GetClipboardFormatNameW( aClipformat, o3tl::toW(wBuff), MAX_CLIPFORMAT_NAME );
 163
 164     return OUString( wBuff, nLen );
 165 }
 166
 167 CFormatEtc CDataFormatTranslator::getFormatEtcForClipformat( CLIPFORMAT cf )
 168 {
 169     CFormatEtc fetc( cf, TYMED_NULL, nullptr, DVASPECT_CONTENT );
 170
 171     switch( cf )
 172     {
 173     case CF_METAFILEPICT:
 174         fetc.setTymed( TYMED_MFPICT );
 175         break;
 176
 177     case CF_ENHMETAFILE:
 178         fetc.setTymed( TYMED_ENHMF );
 179         break;
 180
 181     default:
 182         fetc.setTymed( TYMED_HGLOBAL /*| TYMED_ISTREAM*/ );
 183     }
 184
 185     /*
 186         hack: in order to paste urls copied by Internet Explorer
 187         with "copy link" we set the lindex member to 0
 188         but if we really want to support CFSTR_FILECONTENT and
 189         the accompany format CFSTR_FILEDESCRIPTOR (FileGroupDescriptor)
 190         the client of the clipboard service has to provide a id
 191         of which FileContents it wants to paste
 192         see MSDN: "Handling Shell Data Transfer Scenarios"
 193     */
 194     if ( cf == RegisterClipboardFormat( CFSTR_FILECONTENTS ) )
 195          fetc.setLindex( 0 );
 196
 197     return fetc;
 198 }
 199
 200 bool CDataFormatTranslator::isOemOrAnsiTextFormat( CLIPFORMAT cf )
 201 {
 202     return ( (cf == CF_TEXT) || (cf == CF_OEMTEXT) );
 203 }
 204
 205 bool CDataFormatTranslator::isUnicodeTextFormat( CLIPFORMAT cf )
 206 {
 207     return ( cf == CF_UNICODETEXT );
 208 }
 209
 210 bool CDataFormatTranslator::isTextFormat( CLIPFORMAT cf )
 211 {
 212     return ( isOemOrAnsiTextFormat( cf ) || isUnicodeTextFormat( cf ) );
 213 }
 214
 215 bool CDataFormatTranslator::isHTMLFormat( CLIPFORMAT cf )
 216 {
 217     OUString clipFormatName = getClipboardFormatName( cf );
 218     return ( clipFormatName == "HTML Format" );
 219 }
 220
 221 bool CDataFormatTranslator::isTextHtmlFormat( CLIPFORMAT cf )
 222 {
 223     OUString clipFormatName = getClipboardFormatName( cf );
 224     return clipFormatName.equalsIgnoreAsciiCase( "HTML (HyperText Markup Language)" );
 225 }
 226
 227 OUString CDataFormatTranslator::getTextCharsetFromLCID( LCID lcid, CLIPFORMAT aClipformat )
 228 {
 229     OSL_ASSERT( isOemOrAnsiTextFormat( aClipformat ) );
 230
 231     OUString charset;
 232     if ( CF_TEXT == aClipformat )
 233     {
 234         charset = getMimeCharsetFromLocaleId(
 235                     lcid,
 236                     LOCALE_IDEFAULTANSICODEPAGE,
 237                     PRE_WINDOWS_CODEPAGE );
 238     }
 239     else if ( CF_OEMTEXT == aClipformat )
 240     {
 241         charset = getMimeCharsetFromLocaleId(
 242                     lcid,
 243                     LOCALE_IDEFAULTCODEPAGE,
 244                     PRE_OEM_CODEPAGE );
 245     }
 246     else // CF_UNICODE
 247         OSL_ASSERT( false );
 248
 249     return charset;
 250 }
 251
 252 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */