dtrans/source/win32/dtobj/DataFmtTransl.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DataFmtTransl.cxx,v $
  10  * $Revision: 1.23 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_dtrans.hxx"
  33
  34 //------------------------------------------------------------------------
  35 // includes
  36 //------------------------------------------------------------------------
  37 #include "DataFmtTransl.hxx"
  38 #include <rtl/string.hxx>
  39 #include <osl/diagnose.h>
  40 #include <rtl/tencinfo.h>
  41 #include "..\misc\ImplHelper.hxx"
  42 #include "..\misc\WinClip.hxx"
  43 #include "MimeAttrib.hxx"
  44 #include "DTransHelper.hxx"
  45 #include <rtl/string.h>
  46 #include "Fetc.hxx"
  47
  48 #if defined _MSC_VER
  49 #pragma warning(push,1)
  50 #pragma warning(disable:4917)
  51 #endif
  52 #include <windows.h>
  53 #if (_MSC_VER < 1300) && !defined(__MINGW32__)
  54 #include <olestd.h>
  55 #endif
  56 #include <shlobj.h>
  57 #if defined _MSC_VER
  58 #pragma warning(pop)
  59 #endif
  60
  61
  62 //------------------------------------------------------------------------
  63 // namespace directives
  64 //------------------------------------------------------------------------
  65
  66 using namespace rtl;
  67 using namespace std;
  68 using namespace com::sun::star::uno;
  69 using namespace com::sun::star::datatransfer;
  70 using namespace com::sun::star::lang;
  71
  72 //------------------------------------------------------------------------
  73 // const
  74 //------------------------------------------------------------------------
  75
  76 const Type       CPPUTYPE_SALINT32   = getCppuType((sal_Int32*)0);
  77 const Type       CPPUTYPE_SALINT8    = getCppuType((sal_Int8*)0);
  78 const Type       CPPUTYPE_OUSTRING   = getCppuType((OUString*)0);
  79 const Type       CPPUTYPE_SEQSALINT8 = getCppuType((Sequence< sal_Int8>*)0);
  80 const sal_Int32  MAX_CLIPFORMAT_NAME = 256;
  81
  82 const OUString TEXT_PLAIN_CHARSET   = OUString::createFromAscii( "text/plain;charset=" );
  83 const OUString HPNAME_OEM_ANSI_TEXT = OUString::createFromAscii( "OEM/ANSI Text" );
  84
  85 const OUString HTML_FORMAT_NAME_WINDOWS = OUString::createFromAscii( "HTML Format" );
  86 const OUString HTML_FORMAT_NAME_SOFFICE = OUString::createFromAscii( "HTML (HyperText Markup Language)" );
  87
  88 //------------------------------------------------------------------------
  89 //
  90 //------------------------------------------------------------------------
  91
  92 CDataFormatTranslator::CDataFormatTranslator( const Reference< XMultiServiceFactory >& aServiceManager ) :
  93     m_SrvMgr( aServiceManager )
  94 {
  95     m_XDataFormatTranslator = Reference< XDataFormatTranslator >(
  96         m_SrvMgr->createInstance( OUString::createFromAscii( "com.sun.star.datatransfer.DataFormatTranslator" ) ), UNO_QUERY );
  97 }
  98
  99 //------------------------------------------------------------------------
 100 //
 101 //------------------------------------------------------------------------
 102
 103 CFormatEtc CDataFormatTranslator::getFormatEtcFromDataFlavor( const DataFlavor& aDataFlavor ) const
 104 {
 105     sal_Int32 cf = CF_INVALID;
 106
 107     try
 108     {
 109         if( m_XDataFormatTranslator.is( ) )
 110         {
 111             Any aFormat = m_XDataFormatTranslator->getSystemDataTypeFromDataFlavor( aDataFlavor );
 112
 113             if ( aFormat.hasValue( ) )
 114             {
 115                 if ( aFormat.getValueType( ) == CPPUTYPE_SALINT32 )
 116                 {
 117                     aFormat >>= cf;
 118                     OSL_ENSURE( CF_INVALID != cf, "Invalid Clipboard format delivered" );
 119                 }
 120                 else if ( aFormat.getValueType( ) == CPPUTYPE_OUSTRING )
 121                 {
 122                     OUString aClipFmtName;
 123                     aFormat >>= aClipFmtName;
 124
 125                     OSL_ASSERT( aClipFmtName.getLength( ) );
 126                     cf = RegisterClipboardFormatW( reinterpret_cast<LPCWSTR>(aClipFmtName.getStr( )) );
 127
 128                     OSL_ENSURE( CF_INVALID != cf, "RegisterClipboardFormat failed" );
 129                 }
 130                 else
 131                     OSL_ENSURE( sal_False, "Wrong Any-Type detected" );
 132             }
 133         }
 134     }
 135     catch( ... )
 136     {
 137         OSL_ENSURE( sal_False, "Unexpected error" );
 138     }
 139
 140     return sal::static_int_cast<CFormatEtc>(getFormatEtcForClipformat( sal::static_int_cast<CLIPFORMAT>(cf) ));
 141 }
 142
 143 //------------------------------------------------------------------------
 144 //
 145 //------------------------------------------------------------------------
 146
 147 DataFlavor CDataFormatTranslator::getDataFlavorFromFormatEtc( const FORMATETC& aFormatEtc, LCID lcid ) const
 148 {
 149     DataFlavor aFlavor;
 150
 151     try
 152     {
 153         CLIPFORMAT aClipformat = aFormatEtc.cfFormat;
 154
 155         Any aAny;
 156         aAny <<= static_cast< sal_Int32 >( aClipformat );
 157
 158         if ( isOemOrAnsiTextFormat( aClipformat ) )
 159         {
 160             aFlavor.MimeType             = TEXT_PLAIN_CHARSET;
 161             aFlavor.MimeType            += getTextCharsetFromLCID( lcid, aClipformat );
 162
 163             aFlavor.HumanPresentableName = HPNAME_OEM_ANSI_TEXT;
 164             aFlavor.DataType             = CPPUTYPE_SEQSALINT8;
 165         }
 166         else if ( CF_INVALID != aClipformat )
 167         {
 168             if ( m_XDataFormatTranslator.is( ) )
 169             {
 170                 aFlavor = m_XDataFormatTranslator->getDataFlavorFromSystemDataType( aAny );
 171
 172                 if ( !aFlavor.MimeType.getLength( ) )
 173                 {
 174                     // lookup of DataFlavor from clipboard format id
 175                     // failed, so we try to resolve via clipboard
 176                     // format name
 177                     OUString clipFormatName = getClipboardFormatName( aClipformat );
 178
 179                     // if we could not get a clipboard format name an
 180                     // error must have occured or it is a standard
 181                     // clipboard format that we don't translate, e.g.
 182                     // CF_BITMAP (the office only uses CF_DIB)
 183                     if ( clipFormatName.getLength( ) )
 184                     {
 185                         aAny <<= clipFormatName;
 186                         aFlavor = m_XDataFormatTranslator->getDataFlavorFromSystemDataType( aAny );
 187                     }
 188                 }
 189             }
 190         }
 191     }
 192     catch( ... )
 193     {
 194         OSL_ENSURE( sal_False, "Unexpected error" );
 195     }
 196
 197     return aFlavor;
 198 }
 199
 200 //------------------------------------------------------------------------
 201 //
 202 //------------------------------------------------------------------------
 203
 204 CFormatEtc SAL_CALL CDataFormatTranslator::getFormatEtcForClipformatName( const OUString& aClipFmtName ) const
 205 {
 206     // check parameter
 207     if ( !aClipFmtName.getLength( ) )
 208         return CFormatEtc( CF_INVALID );
 209
 210     CLIPFORMAT cf = sal::static_int_cast<CLIPFORMAT>(RegisterClipboardFormatW( reinterpret_cast<LPCWSTR>(aClipFmtName.getStr( )) ));
 211     return getFormatEtcForClipformat( cf );
 212 }
 213
 214 //------------------------------------------------------------------------
 215 //
 216 //------------------------------------------------------------------------
 217
 218 OUString CDataFormatTranslator::getClipboardFormatName( CLIPFORMAT aClipformat ) const
 219 {
 220     OSL_PRECOND( CF_INVALID != aClipformat, "Invalid clipboard format" );
 221
 222     sal_Unicode wBuff[ MAX_CLIPFORMAT_NAME ];
 223     sal_Int32   nLen = GetClipboardFormatNameW( aClipformat, reinterpret_cast<LPWSTR>(wBuff), MAX_CLIPFORMAT_NAME );
 224
 225     return OUString( wBuff, nLen );
 226 }
 227
 228 //------------------------------------------------------------------------
 229 //
 230 //------------------------------------------------------------------------
 231
 232 CFormatEtc SAL_CALL CDataFormatTranslator::getFormatEtcForClipformat( CLIPFORMAT cf ) const
 233 {
 234     CFormatEtc fetc( cf, TYMED_NULL, NULL, DVASPECT_CONTENT );
 235
 236     switch( cf )
 237     {
 238     case CF_METAFILEPICT:
 239         fetc.setTymed( TYMED_MFPICT );
 240         break;
 241
 242     case CF_ENHMETAFILE:
 243         fetc.setTymed( TYMED_ENHMF );
 244         break;
 245
 246     default:
 247         fetc.setTymed( TYMED_HGLOBAL /*| TYMED_ISTREAM*/ );
 248     }
 249
 250     /*
 251         hack: in order to paste urls copied by Internet Explorer
 252         with "copy link" we set the lindex member to 0
 253         but if we really want to support CFSTR_FILECONTENT and
 254         the accompany format CFSTR_FILEDESCRIPTOR (FileGroupDescriptor)
 255         the client of the clipboard service has to provide a id
 256         of which FileContents it wants to paste
 257         see MSDN: "Handling Shell Data Transfer Scenarios"
 258     */
 259     if ( cf == RegisterClipboardFormatA( CFSTR_FILECONTENTS ) )
 260          fetc.setLindex( 0 );
 261
 262     return fetc;
 263 }
 264
 265 //------------------------------------------------------------------------
 266 //
 267 //------------------------------------------------------------------------
 268
 269 sal_Bool SAL_CALL CDataFormatTranslator::isOemOrAnsiTextFormat( CLIPFORMAT cf ) const
 270 {
 271     return ( (cf == CF_TEXT) || (cf == CF_OEMTEXT) );
 272 }
 273
 274 //------------------------------------------------------------------------
 275 //
 276 //------------------------------------------------------------------------
 277
 278 sal_Bool SAL_CALL CDataFormatTranslator::isUnicodeTextFormat( CLIPFORMAT cf ) const
 279 {
 280     return ( cf == CF_UNICODETEXT );
 281 }
 282
 283 //------------------------------------------------------------------------
 284 //
 285 //------------------------------------------------------------------------
 286
 287 sal_Bool SAL_CALL CDataFormatTranslator::isTextFormat( CLIPFORMAT cf ) const
 288 {
 289     return ( isOemOrAnsiTextFormat( cf ) || isUnicodeTextFormat( cf ) );
 290 }
 291
 292 //------------------------------------------------------------------------
 293 //
 294 //------------------------------------------------------------------------
 295
 296 sal_Bool SAL_CALL CDataFormatTranslator::isHTMLFormat( CLIPFORMAT cf ) const
 297 {
 298     OUString clipFormatName = getClipboardFormatName( cf );
 299     return ( clipFormatName == HTML_FORMAT_NAME_WINDOWS );
 300 }
 301
 302 //------------------------------------------------------------------------
 303 //
 304 //------------------------------------------------------------------------
 305
 306 sal_Bool SAL_CALL CDataFormatTranslator::isTextHtmlFormat( CLIPFORMAT cf ) const
 307 {
 308     OUString clipFormatName = getClipboardFormatName( cf );
 309     return ( clipFormatName.equalsIgnoreAsciiCase( HTML_FORMAT_NAME_SOFFICE ) );
 310 }
 311
 312 //------------------------------------------------------------------------
 313 //
 314 //------------------------------------------------------------------------
 315
 316 OUString SAL_CALL CDataFormatTranslator::getTextCharsetFromLCID( LCID lcid, CLIPFORMAT aClipformat ) const
 317 {
 318     OSL_ASSERT( isOemOrAnsiTextFormat( aClipformat ) );
 319
 320     OUString charset;
 321     if ( CF_TEXT == aClipformat )
 322     {
 323         charset = getMimeCharsetFromLocaleId(
 324                     lcid,
 325                     LOCALE_IDEFAULTANSICODEPAGE,
 326                     PRE_WINDOWS_CODEPAGE );
 327     }
 328     else if ( CF_OEMTEXT == aClipformat )
 329     {
 330         charset = getMimeCharsetFromLocaleId(
 331                     lcid,
 332                     LOCALE_IDEFAULTCODEPAGE,
 333                     PRE_OEM_CODEPAGE );
 334     }
 335     else // CF_UNICODE
 336         OSL_ASSERT( sal_False );
 337
 338     return charset;
 339 }