sc/source/ui/unoobj/scdetect.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 "scdetect.hxx"
  21
  22 #include <sal/macros.h>
  23
  24 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  25 #include <com/sun/star/beans/PropertyValue.hpp>
  26 #include <cppuhelper/supportsservice.hxx>
  27 #include <com/sun/star/container/XNameAccess.hpp>
  28 #include <com/sun/star/io/XInputStream.hpp>
  29 #include <unotools/mediadescriptor.hxx>
  30 #include <sfx2/docfile.hxx>
  31 #include <sfx2/fcontnr.hxx>
  32
  33 using namespace ::com::sun::star;
  34 using utl::MediaDescriptor;
  35
  36 namespace {
  37
  38 const sal_Char pFilterLotus[]        = "Lotus";
  39 const sal_Char pFilterQPro6[]        = "Quattro Pro 6.0";
  40 const sal_Char pFilterDBase[]        = "dBase";
  41 const sal_Char pFilterDif[]      = "DIF";
  42 const sal_Char pFilterSylk[]     = "SYLK";
  43
  44 // Tabelle mit Suchmustern
  45 // Bedeutung der Sequenzen
  46 // 0x00??: genau Byte 0x?? muss an dieser Stelle stehen
  47 // 0x0100: ein Byte ueberlesen (don't care)
  48 // 0x02nn: ein Byte aus 0xnn Alternativen folgt
  49 // 0x8000: Erkennung abgeschlossen
  50
  51
  52 #define M_DC        0x0100
  53 #define M_ALT(ANZ)  (0x0200+(ANZ))
  54 #define M_ENDE      0x8000
  55
  56 const sal_uInt16 pLotus[] =      // Lotus 1/1A/2
  57     { 0x0000, 0x0000, 0x0002, 0x0000,
  58     M_ALT(2), 0x0004, 0x0006,
  59     0x0004, M_ENDE };
  60
  61 const sal_uInt16 pLotusNew[] =   // Lotus >= 9.7
  62     { 0x0000, 0x0000, M_DC, 0x0000,     // Rec# + Len (0x1a)
  63       M_ALT(3), 0x0003, 0x0004, 0x0005, // File Revision Code 97->ME
  64       0x0010, 0x0004, 0x0000, 0x0000,
  65       M_ENDE };
  66
  67 const sal_uInt16 pLotus2[] =     // Lotus >3
  68     { 0x0000, 0x0000, 0x001A, 0x0000,   // Rec# + Len (26)
  69     M_ALT(2), 0x0000, 0x0002,         // File Revision Code
  70     0x0010,
  71     0x0004, 0x0000,                   // File Revision Subcode
  72     M_ENDE };
  73
  74 const sal_uInt16 pQPro[] =
  75        { 0x0000, 0x0000, 0x0002, 0x0000,
  76          M_ALT(4), 0x0001, 0x0002, // WB1, WB2
  77          0x0006, 0x0007,           // QPro 6/7 (?)
  78          0x0010,
  79          M_ENDE };
  80
  81 const sal_uInt16 pDIF1[] =       // DIF mit CR-LF
  82     {
  83     'T', 'A', 'B', 'L', 'E',
  84     M_DC, M_DC,
  85     '0', ',', '1',
  86     M_DC, M_DC,
  87     '\"',
  88     M_ENDE };
  89
  90 const sal_uInt16 pDIF2[] =       // DIF mit CR oder LF
  91     {
  92     'T', 'A', 'B', 'L', 'E',
  93     M_DC,
  94     '0', ',', '1',
  95     M_DC,
  96     '\"',
  97     M_ENDE };
  98
  99 const sal_uInt16 pSylk[] =       // Sylk
 100     {
 101     'I', 'D', ';',
 102     M_ALT(3), 'P', 'N', 'E',        // 'P' plus undocumented Excel extensions 'N' and 'E'
 103     M_ENDE };
 104
 105 bool detectThisFormat(SvStream& rStr, const sal_uInt16* pSearch)
 106 {
 107     sal_uInt8 nByte;
 108     rStr.Seek( 0 ); // am Anfang war alles Uebel...
 109     rStr.ReadUChar( nByte );
 110     bool bSync = true;
 111     while( !rStr.IsEof() && bSync )
 112     {
 113         sal_uInt16 nMuster = *pSearch;
 114
 115         if( nMuster < 0x0100 )
 116         { //                                direkter Byte-Vergleich
 117             if( ( sal_uInt8 ) nMuster != nByte )
 118                 bSync = false;
 119         }
 120         else if( nMuster & M_DC )
 121         { //                                             don't care
 122         }
 123         else if( nMuster & M_ALT(0) )
 124         { //                                      alternative Bytes
 125             sal_uInt8 nAnzAlt = ( sal_uInt8 ) nMuster;
 126             bSync = false;          // zunaechst unsynchron
 127             while( nAnzAlt > 0 )
 128             {
 129                 pSearch++;
 130                 if( ( sal_uInt8 ) *pSearch == nByte )
 131                     bSync = true;   // jetzt erst Synchronisierung
 132                 nAnzAlt--;
 133             }
 134         }
 135         else if( nMuster & M_ENDE )
 136         { //                                        Format detected
 137             return true;
 138         }
 139
 140         pSearch++;
 141         rStr.ReadUChar( nByte );
 142     }
 143
 144     return false;
 145 }
 146
 147 }
 148
 149 ScFilterDetect::ScFilterDetect( const uno::Reference<uno::XComponentContext>& /*xContext*/ )
 150 {
 151 }
 152
 153 ScFilterDetect::~ScFilterDetect()
 154 {
 155 }
 156
 157 #if 0
 158 // This method is no longer used, but I do want to keep this for now to see
 159 // if we could transfer this check to the now centralized ascii detection
 160 // code in the filter module.
 161 static sal_Bool lcl_MayBeAscii( SvStream& rStream )
 162 {
 163     // ASCII/CSV is considered possible if there are no null bytes, or a Byte
 164     // Order Mark is present, or if, for Unicode UCS2/UTF-16, all null bytes
 165     // are on either even or uneven byte positions.
 166
 167     rStream.Seek(STREAM_SEEK_TO_BEGIN);
 168
 169     const size_t nBufSize = 2048;
 170     sal_uInt16 aBuffer[ nBufSize ];
 171     sal_uInt8* pByte = reinterpret_cast<sal_uInt8*>(aBuffer);
 172     sal_uLong nBytesRead = rStream.Read( pByte, nBufSize*2);
 173
 174     if ( nBytesRead >= 2 && (aBuffer[0] == 0xfffe || aBuffer[0] == 0xfeff) )
 175     {
 176         // Unicode BOM file may contain null bytes.
 177         return sal_True;
 178     }
 179
 180     const sal_uInt16* p = aBuffer;
 181     sal_uInt16 nMask = 0xffff;
 182     nBytesRead /= 2;
 183     while( nBytesRead-- && nMask )
 184     {
 185         sal_uInt16 nVal = *p++ & nMask;
 186         if (!(nVal & 0x00ff))
 187             nMask &= 0xff00;
 188         if (!(nVal & 0xff00))
 189             nMask &= 0x00ff;
 190     }
 191
 192     return nMask != 0;
 193 }
 194 #endif
 195
 196 static bool lcl_MayBeDBase( SvStream& rStream )
 197 {
 198     // Look for dbf marker, see connectivity/source/inc/dbase/DTable.hxx
 199     // DBFType for values.
 200     const sal_uInt8 nValidMarks[] = {
 201         0x03, 0x04, 0x05, 0x30, 0x43, 0xB3, 0x83, 0x8b, 0x8e, 0xf5 };
 202     sal_uInt8 nMark;
 203     rStream.Seek(STREAM_SEEK_TO_BEGIN);
 204     rStream.ReadUChar( nMark );
 205     bool bValidMark = false;
 206     for (size_t i=0; i < sizeof(nValidMarks)/sizeof(nValidMarks[0]) && !bValidMark; ++i)
 207     {
 208         if (nValidMarks[i] == nMark)
 209             bValidMark = true;
 210     }
 211     if ( !bValidMark )
 212         return false;
 213
 214     const size_t nHeaderBlockSize = 32;
 215     // Empty dbf is >= 32*2+1 bytes in size.
 216     const size_t nEmptyDbf = nHeaderBlockSize * 2 + 1;
 217
 218     rStream.Seek(STREAM_SEEK_TO_END);
 219     sal_uLong nSize = rStream.Tell();
 220     if ( nSize < nEmptyDbf )
 221         return false;
 222
 223     // length of header starts at 8
 224     rStream.Seek(8);
 225     sal_uInt16 nHeaderLen;
 226     rStream.ReadUInt16( nHeaderLen );
 227
 228     if ( nHeaderLen < nEmptyDbf || nSize < nHeaderLen )
 229         return false;
 230
 231     // Last byte of header must be 0x0d, this is how it's specified.
 232     // #i9581#,#i26407# but some applications don't follow the specification
 233     // and pad the header with one byte 0x00 to reach an
 234     // even boundary. Some (#i88577# ) even pad more or pad using a 0x1a ^Z
 235     // control character (#i8857#). This results in:
 236     // Last byte of header must be 0x0d on 32 bytes boundary.
 237     sal_uInt16 nBlocks = (nHeaderLen - 1) / nHeaderBlockSize;
 238     sal_uInt8 nEndFlag = 0;
 239     while ( nBlocks > 1 && nEndFlag != 0x0d ) {
 240         rStream.Seek( nBlocks-- * nHeaderBlockSize );
 241         rStream.ReadUChar( nEndFlag );
 242     }
 243
 244     return ( 0x0d == nEndFlag );
 245 }
 246
 247 OUString SAL_CALL ScFilterDetect::detect( uno::Sequence<beans::PropertyValue>& lDescriptor )
 248     throw( uno::RuntimeException, std::exception )
 249 {
 250     MediaDescriptor aMediaDesc( lDescriptor );
 251     OUString aTypeName = aMediaDesc.getUnpackedValueOrDefault( MediaDescriptor::PROP_TYPENAME(), OUString() );
 252     uno::Reference< io::XInputStream > xStream ( aMediaDesc[MediaDescriptor::PROP_INPUTSTREAM()], uno::UNO_QUERY );
 253     if ( !xStream.is() )
 254         return OUString();
 255
 256     SfxMedium aMedium;
 257     aMedium.UseInteractionHandler( false );
 258     aMedium.setStreamToLoadFrom( xStream, true );
 259
 260     SvStream* pStream = aMedium.GetInStream();
 261     if ( !pStream || pStream->GetError() )
 262         // No stream, no detection.
 263         return OUString();
 264
 265     const char* pSearchFilterName = NULL;
 266     if (aTypeName == "calc_Lotus")
 267     {
 268         if (!detectThisFormat(*pStream, pLotus) && !detectThisFormat(*pStream, pLotusNew) && !detectThisFormat(*pStream, pLotus2))
 269             return OUString();
 270
 271         pSearchFilterName = pFilterLotus;
 272     }
 273     else if (aTypeName == "calc_QPro")
 274     {
 275         if (!detectThisFormat(*pStream, pQPro))
 276             return OUString();
 277
 278         pSearchFilterName = pFilterQPro6;
 279     }
 280     else if (aTypeName == "calc_SYLK")
 281     {
 282         if (!detectThisFormat(*pStream, pSylk))
 283             return OUString();
 284
 285         pSearchFilterName = pFilterSylk;
 286     }
 287     else if (aTypeName == "calc_DIF")
 288     {
 289         if (!detectThisFormat(*pStream, pDIF1) && !detectThisFormat(*pStream, pDIF2))
 290             return OUString();
 291
 292         pSearchFilterName = pFilterDif;
 293     }
 294     else if (aTypeName == "calc_dBase")
 295     {
 296         if (!lcl_MayBeDBase(*pStream))
 297             return OUString();
 298
 299         pSearchFilterName = pFilterDBase;
 300     }
 301     else
 302         return OUString();
 303
 304     SfxFilterMatcher aMatcher("scalc");
 305     const SfxFilter* pFilter = aMatcher.GetFilter4FilterName(OUString::createFromAscii(pSearchFilterName));
 306
 307     if (!pFilter)
 308         return OUString();
 309
 310     aMediaDesc[MediaDescriptor::PROP_FILTERNAME()] <<= pFilter->GetName();
 311     aMediaDesc >> lDescriptor;
 312     return aTypeName;
 313 }
 314
 315 OUString SAL_CALL ScFilterDetect::getImplementationName() throw (uno::RuntimeException, std::exception)
 316 {
 317     return impl_getStaticImplementationName();
 318 }
 319
 320 sal_Bool ScFilterDetect::supportsService( const OUString& sServiceName )
 321     throw (uno::RuntimeException, std::exception)
 322 {
 323     return cppu::supportsService(this, sServiceName);
 324 }
 325
 326 com::sun::star::uno::Sequence<OUString> ScFilterDetect::getSupportedServiceNames()
 327     throw (uno::RuntimeException, std::exception)
 328 {
 329     return impl_getStaticSupportedServiceNames();
 330 }
 331
 332 uno::Sequence<OUString> ScFilterDetect::impl_getStaticSupportedServiceNames()
 333 {
 334     uno::Sequence<OUString> seqServiceNames(1);
 335     seqServiceNames.getArray()[0] = "com.sun.star.frame.ExtendedTypeDetection";
 336     return seqServiceNames;
 337 }
 338
 339 OUString ScFilterDetect::impl_getStaticImplementationName()
 340 {
 341     return OUString("com.sun.star.comp.calc.FormatDetector");
 342 }
 343
 344 uno::Reference<uno::XInterface> ScFilterDetect::impl_createInstance(
 345     const uno::Reference<uno::XComponentContext>& xContext ) throw (uno::Exception)
 346 {
 347     return static_cast<cppu::OWeakObject*>(new ScFilterDetect(xContext));
 348 }
 349
 350 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */