starmath/source/smdetect.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: smdetect.cxx,v $
  10  * $Revision: 1.11 $
  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_starmath.hxx"
  33
  34 #include "smdetect.hxx"
  35
  36 #include <framework/interaction.hxx>
  37 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  38 #include <com/sun/star/beans/PropertyValue.hpp>
  39 #include <com/sun/star/frame/XFrame.hpp>
  40 #include <com/sun/star/frame/XModel.hpp>
  41 #include <com/sun/star/awt/XWindow.hpp>
  42 #include <com/sun/star/lang/XUnoTunnel.hpp>
  43 #ifndef _UNOTOOLS_PROCESSFACTORY_HXX
  44 #include <comphelper/processfactory.hxx>
  45 #endif
  46 #include <com/sun/star/beans/PropertyValue.hpp>
  47 #include <com/sun/star/io/XInputStream.hpp>
  48 #include <com/sun/star/task/XInteractionHandler.hpp>
  49 #include <com/sun/star/lang/WrappedTargetRuntimeException.hpp>
  50 #include <com/sun/star/ucb/CommandAbortedException.hpp>
  51 #include <com/sun/star/ucb/InteractiveAppException.hpp>
  52 #include <com/sun/star/ucb/XContent.hpp>
  53 #include <com/sun/star/packages/zip/ZipIOException.hpp>
  54 #include <framework/interaction.hxx>
  55
  56 #ifndef _TOOLKIT_UNOHLP_HXX
  57 #include <toolkit/helper/vclunohelper.hxx>
  58 #endif
  59 #include <ucbhelper/simpleinteractionrequest.hxx>
  60
  61 #include <rtl/ustring.h>
  62 #include <rtl/logfile.hxx>
  63 #include <svtools/itemset.hxx>
  64 #include <vcl/window.hxx>
  65 #include <svtools/eitem.hxx>
  66 #include <svtools/stritem.hxx>
  67 #include <tools/urlobj.hxx>
  68 #include <vos/mutex.hxx>
  69 #include <svtools/sfxecode.hxx>
  70 #include <svtools/ehdl.hxx>
  71 #include <sot/storinfo.hxx>
  72 #include <vcl/svapp.hxx>
  73 #include <sfx2/app.hxx>
  74 #include <sfx2/sfxsids.hrc>
  75 #include <sfx2/request.hxx>
  76 #include <sfx2/docfile.hxx>
  77 #include <sfx2/docfilt.hxx>
  78 #include <sfx2/fcontnr.hxx>
  79 #include <sfx2/brokenpackageint.hxx>
  80
  81 #include "document.hxx"
  82 #include "eqnolefilehdr.hxx"
  83
  84
  85 using namespace ::com::sun::star;
  86 using namespace ::com::sun::star::uno;
  87 using namespace ::com::sun::star::io;
  88 using namespace ::com::sun::star::frame;
  89 using namespace ::com::sun::star::task;
  90 using namespace ::com::sun::star::beans;
  91 using namespace ::com::sun::star::lang;
  92 using namespace ::com::sun::star::ucb;
  93 using namespace ::rtl;
  94
  95 SmFilterDetect::SmFilterDetect( const REFERENCE < ::com::sun::star::lang::XMultiServiceFactory >& /*xFactory*/ )
  96 {
  97 }
  98
  99 SmFilterDetect::~SmFilterDetect()
 100 {
 101 }
 102
 103 ::rtl::OUString SAL_CALL SmFilterDetect::detect( ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lDescriptor ) throw( ::com::sun::star::uno::RuntimeException )
 104 {
 105     REFERENCE< XInputStream > xStream;
 106     REFERENCE< XContent > xContent;
 107     REFERENCE< XInteractionHandler > xInteraction;
 108     String aURL;
 109     ::rtl::OUString sTemp;
 110     String aTypeName;            // a name describing the type (from MediaDescriptor, usually from flat detection)
 111     String aPreselectedFilterName;      // a name describing the filter to use (from MediaDescriptor, usually from UI action)
 112
 113     ::rtl::OUString aDocumentTitle; // interesting only if set in this method
 114
 115     // opening as template is done when a parameter tells to do so and a template filter can be detected
 116     // (otherwise no valid filter would be found) or if the detected filter is a template filter and
 117     // there is no parameter that forbids to open as template
 118     sal_Bool bOpenAsTemplate = sal_False;
 119     sal_Bool bWasReadOnly = sal_False, bReadOnly = sal_False;
 120
 121     sal_Bool bRepairPackage = sal_False;
 122     sal_Bool bRepairAllowed = sal_False;
 123
 124     // now some parameters that can already be in the array, but may be overwritten or new inserted here
 125     // remember their indices in the case new values must be added to the array
 126     sal_Int32 nPropertyCount = lDescriptor.getLength();
 127     sal_Int32 nIndexOfFilterName = -1;
 128     sal_Int32 nIndexOfInputStream = -1;
 129     sal_Int32 nIndexOfContent = -1;
 130     sal_Int32 nIndexOfReadOnlyFlag = -1;
 131     sal_Int32 nIndexOfTemplateFlag = -1;
 132     sal_Int32 nIndexOfDocumentTitle = -1;
 133
 134     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 135     {
 136         // extract properties
 137         if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("URL")) )
 138         {
 139             lDescriptor[nProperty].Value >>= sTemp;
 140             aURL = sTemp;
 141         }
 142         else if( !aURL.Len() && lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("FileName")) )
 143         {
 144             lDescriptor[nProperty].Value >>= sTemp;
 145             aURL = sTemp;
 146         }
 147         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("TypeName")) )
 148         {
 149             lDescriptor[nProperty].Value >>= sTemp;
 150             aTypeName = sTemp;
 151         }
 152         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("FilterName")) )
 153         {
 154             lDescriptor[nProperty].Value >>= sTemp;
 155             aPreselectedFilterName = sTemp;
 156
 157             // if the preselected filter name is not correct, it must be erased after detection
 158             // remember index of property to get access to it later
 159             nIndexOfFilterName = nProperty;
 160         }
 161         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("InputStream")) )
 162             nIndexOfInputStream = nProperty;
 163         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("ReadOnly")) )
 164             nIndexOfReadOnlyFlag = nProperty;
 165         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("UCBContent")) )
 166             nIndexOfContent = nProperty;
 167         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("AsTemplate")) )
 168         {
 169             lDescriptor[nProperty].Value >>= bOpenAsTemplate;
 170             nIndexOfTemplateFlag = nProperty;
 171         }
 172         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("InteractionHandler")) )
 173             lDescriptor[nProperty].Value >>= xInteraction;
 174         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("RapairPackage")) )
 175             lDescriptor[nProperty].Value >>= bRepairPackage;
 176         else if( lDescriptor[nProperty].Name == OUString(RTL_CONSTASCII_USTRINGPARAM("DocumentTitle")) )
 177             nIndexOfDocumentTitle = nProperty;
 178     }
 179
 180     // can't check the type for external filters, so set the "dont" flag accordingly
 181     ::vos::OGuard aGuard( Application::GetSolarMutex() );
 182     //SfxFilterFlags nMust = SFX_FILTER_IMPORT, nDont = SFX_FILTER_NOTINSTALLED;
 183
 184     SfxApplication* pApp = SFX_APP();
 185     SfxAllItemSet *pSet = new SfxAllItemSet( pApp->GetPool() );
 186     TransformParameters( SID_OPENDOC, lDescriptor, *pSet );
 187     SFX_ITEMSET_ARG( pSet, pItem, SfxBoolItem, SID_DOC_READONLY, FALSE );
 188
 189     bWasReadOnly = pItem && pItem->GetValue();
 190
 191     String aFilterName;
 192     String aPrefix = String::CreateFromAscii( "private:factory/" );
 193     if( aURL.Match( aPrefix ) == aPrefix.Len() )
 194     {
 195         const SfxFilter* pFilter = 0;
 196         String aPattern( aPrefix );
 197         aPattern += String::CreateFromAscii("smath");
 198         if ( aURL.Match( aPattern ) >= aPattern.Len() )
 199         {
 200             pFilter = SfxFilter::GetDefaultFilterFromFactory( aURL );
 201             aTypeName = pFilter->GetTypeName();
 202             aFilterName = pFilter->GetName();
 203         }
 204     }
 205     else
 206     {
 207         // ctor of SfxMedium uses owner transition of ItemSet
 208         SfxMedium aMedium( aURL, bWasReadOnly ? STREAM_STD_READ : STREAM_STD_READWRITE, FALSE, NULL, pSet );
 209         aMedium.UseInteractionHandler( TRUE );
 210
 211         BOOL bIsStorage = aMedium.IsStorage();
 212         if ( aMedium.GetErrorCode() == ERRCODE_NONE )
 213         {
 214             // remember input stream and content and put them into the descriptor later
 215             // should be done here since later the medium can switch to a version
 216             xStream = aMedium.GetInputStream();
 217             xContent = aMedium.GetContent();
 218             bReadOnly = aMedium.IsReadOnly();
 219
 220             if ( bIsStorage )
 221             {
 222                 //TODO/LATER: factor this out!
 223                 uno::Reference < embed::XStorage > xStorage = aMedium.GetStorage( sal_False );
 224                 if ( aMedium.GetLastStorageCreationState() != ERRCODE_NONE )
 225                 {
 226                     // error during storage creation means _here_ that the medium
 227                     // is broken, but we can not handle it in medium since unpossibility
 228                     // to create a storage does not _always_ means that the medium is broken
 229                     aMedium.SetError( aMedium.GetLastStorageCreationState(), ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( OSL_LOG_PREFIX ) ) );
 230                     if ( xInteraction.is() )
 231                     {
 232                         OUString empty;
 233                         try
 234                         {
 235                             InteractiveAppException xException( empty,
 236                                                             REFERENCE< XInterface >(),
 237                                                             InteractionClassification_ERROR,
 238                                                             aMedium.GetError() );
 239
 240                             REFERENCE< XInteractionRequest > xRequest(
 241                                 new ucbhelper::SimpleInteractionRequest( makeAny( xException ),
 242                                                                       ucbhelper::CONTINUATION_APPROVE ) );
 243                             xInteraction->handle( xRequest );
 244                         }
 245                         catch ( Exception & ) {};
 246                     }
 247                 }
 248                 else
 249                 {
 250                     aFilterName.Erase();
 251
 252                     try
 253                     {
 254                         const SfxFilter* pFilter = aPreselectedFilterName.Len() ?
 255                                 SfxFilterMatcher().GetFilter4FilterName( aPreselectedFilterName ) : aTypeName.Len() ?
 256                                 SfxFilterMatcher(String::CreateFromAscii("smath")).GetFilter4EA( aTypeName ) : 0;
 257                         String aTmpFilterName;
 258                         if ( pFilter )
 259                             aTmpFilterName = pFilter->GetName();
 260                         aTypeName = SfxFilter::GetTypeFromStorage( xStorage, pFilter ? pFilter->IsAllowedAsTemplate() : FALSE, &aTmpFilterName );
 261                     }
 262                     catch( lang::WrappedTargetException& aWrap )
 263                     {
 264                         packages::zip::ZipIOException aZipException;
 265
 266                         // repairing is done only if this type is requested from outside
 267                         if ( ( aWrap.TargetException >>= aZipException ) && aTypeName.Len() )
 268                         {
 269                             if ( xInteraction.is() )
 270                             {
 271                                 // the package is broken one
 272                                    aDocumentTitle = aMedium.GetURLObject().getName(
 273                                                             INetURLObject::LAST_SEGMENT,
 274                                                             true,
 275                                                             INetURLObject::DECODE_WITH_CHARSET );
 276
 277                                 if ( !bRepairPackage )
 278                                 {
 279                                     // ask the user whether he wants to try to repair
 280                                     RequestPackageReparation* pRequest = new RequestPackageReparation( aDocumentTitle );
 281                                     uno::Reference< task::XInteractionRequest > xRequest ( pRequest );
 282
 283                                     xInteraction->handle( xRequest );
 284
 285                                     bRepairAllowed = pRequest->isApproved();
 286                                 }
 287
 288                                 if ( !bRepairAllowed )
 289                                 {
 290                                     // repair either not allowed or not successful
 291                                     NotifyBrokenPackage* pNotifyRequest = new NotifyBrokenPackage( aDocumentTitle );
 292                                     uno::Reference< task::XInteractionRequest > xRequest ( pNotifyRequest );
 293                                        xInteraction->handle( xRequest );
 294                                 }
 295                             }
 296
 297                             if ( !bRepairAllowed )
 298                                 aTypeName.Erase();
 299                         }
 300                     }
 301                     catch( uno::RuntimeException& )
 302                     {
 303                         throw;
 304                     }
 305                     catch( uno::Exception& )
 306                     {
 307                         aTypeName.Erase();
 308                     }
 309
 310                        if ( aTypeName.Len() )
 311                     {
 312                            const SfxFilter* pFilter =
 313                                     SfxFilterMatcher( String::CreateFromAscii("smath") ).GetFilter4EA( aTypeName );
 314                         if ( pFilter )
 315                             aFilterName = pFilter->GetName();
 316                     }
 317                 }
 318             }
 319             else
 320             {
 321                 //Test to see if this begins with xml and if so run it through
 322                 //the MathML filter. There are all sorts of things wrong with
 323                 //this approach, to be fixed at a better level than here
 324                 SvStream *pStrm = aMedium.GetInStream();
 325                 aTypeName.Erase();
 326                 if (pStrm && !pStrm->GetError())
 327                 {
 328                     SotStorageRef aStorage = new SotStorage ( pStrm, FALSE );
 329                     if ( !aStorage->GetError() )
 330                     {
 331                         if ( aStorage->IsStream( String::CreateFromAscii( RTL_CONSTASCII_STRINGPARAM( "Equation Native" ) ) ) )
 332                         {
 333                             sal_uInt8 nVersion;
 334                             if (GetMathTypeVersion( aStorage, nVersion ) && nVersion <=3)
 335                                 aTypeName.AssignAscii( "math_MathType_3x" );
 336                         }
 337                     }
 338                     else
 339                     {
 340                         const USHORT nSize = 5;
 341                         sal_Char aBuffer[nSize+1];
 342                         aBuffer[nSize] = 0;
 343                         pStrm->Seek( STREAM_SEEK_TO_BEGIN );
 344                         ULONG nBytesRead = pStrm->Read( aBuffer, nSize );
 345                         if (nBytesRead == nSize)
 346                         {
 347                             if (0 == strncmp( "<?xml",aBuffer,nSize))
 348                             {
 349                                 static const sal_Char sFltrNm_2[] = MATHML_XML;
 350                                 static const sal_Char sTypeNm_2[] = "math_MathML_XML_Math";
 351                                 aFilterName.AssignAscii( sFltrNm_2 );
 352                                 aTypeName.AssignAscii( sTypeNm_2 );
 353                             }
 354                         }
 355                     }
 356
 357                     if ( aTypeName.Len() )
 358                     {
 359                         const SfxFilter* pFilt = SfxFilterMatcher( String::CreateFromAscii("smath") ).GetFilter4EA( aTypeName );
 360                         if ( pFilt )
 361                             aFilterName = pFilt->GetName();
 362                     }
 363                 }
 364             }
 365         }
 366     }
 367
 368     if ( nIndexOfInputStream == -1 && xStream.is() )
 369     {
 370         // if input stream wasn't part of the descriptor, now it should be, otherwise the content would be opend twice
 371         lDescriptor.realloc( nPropertyCount + 1 );
 372         lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("InputStream");
 373         lDescriptor[nPropertyCount].Value <<= xStream;
 374         nPropertyCount++;
 375     }
 376
 377     if ( nIndexOfContent == -1 && xContent.is() )
 378     {
 379         // if input stream wasn't part of the descriptor, now it should be, otherwise the content would be opend twice
 380         lDescriptor.realloc( nPropertyCount + 1 );
 381         lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("UCBContent");
 382         lDescriptor[nPropertyCount].Value <<= xContent;
 383         nPropertyCount++;
 384     }
 385
 386     if ( bReadOnly != bWasReadOnly )
 387     {
 388         if ( nIndexOfReadOnlyFlag == -1 )
 389         {
 390             lDescriptor.realloc( nPropertyCount + 1 );
 391             lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("ReadOnly");
 392             lDescriptor[nPropertyCount].Value <<= bReadOnly;
 393             nPropertyCount++;
 394         }
 395         else
 396             lDescriptor[nIndexOfReadOnlyFlag].Value <<= bReadOnly;
 397     }
 398
 399     if ( !bRepairPackage && bRepairAllowed )
 400     {
 401         lDescriptor.realloc( nPropertyCount + 1 );
 402         lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("RepairPackage");
 403         lDescriptor[nPropertyCount].Value <<= bRepairAllowed;
 404         nPropertyCount++;
 405
 406         bOpenAsTemplate = sal_True;
 407
 408         // TODO/LATER: set progress bar that should be used
 409     }
 410
 411     if ( bOpenAsTemplate )
 412     {
 413         if ( nIndexOfTemplateFlag == -1 )
 414         {
 415             lDescriptor.realloc( nPropertyCount + 1 );
 416             lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("AsTemplate");
 417             lDescriptor[nPropertyCount].Value <<= bOpenAsTemplate;
 418             nPropertyCount++;
 419         }
 420         else
 421             lDescriptor[nIndexOfTemplateFlag].Value <<= bOpenAsTemplate;
 422     }
 423
 424     if ( aDocumentTitle.getLength() )
 425     {
 426         // the title was set here
 427         if ( nIndexOfDocumentTitle == -1 )
 428         {
 429             lDescriptor.realloc( nPropertyCount + 1 );
 430             lDescriptor[nPropertyCount].Name = ::rtl::OUString::createFromAscii("DocumentTitle");
 431             lDescriptor[nPropertyCount].Value <<= aDocumentTitle;
 432             nPropertyCount++;
 433         }
 434         else
 435             lDescriptor[nIndexOfDocumentTitle].Value <<= aDocumentTitle;
 436     }
 437
 438     if ( !aFilterName.Len() )
 439         aTypeName.Erase();
 440
 441     return aTypeName;
 442 }
 443
 444 SFX_IMPL_SINGLEFACTORY( SmFilterDetect )
 445
 446 /* XServiceInfo */
 447 UNOOUSTRING SAL_CALL SmFilterDetect::getImplementationName() throw( UNORUNTIMEEXCEPTION )
 448 {
 449     return impl_getStaticImplementationName();
 450 }
 451                                                                                                                                 \
 452 /* XServiceInfo */
 453 sal_Bool SAL_CALL SmFilterDetect::supportsService( const UNOOUSTRING& sServiceName ) throw( UNORUNTIMEEXCEPTION )
 454 {
 455     UNOSEQUENCE< UNOOUSTRING >  seqServiceNames =   getSupportedServiceNames();
 456     const UNOOUSTRING*          pArray          =   seqServiceNames.getConstArray();
 457     for ( sal_Int32 nCounter=0; nCounter<seqServiceNames.getLength(); nCounter++ )
 458     {
 459         if ( pArray[nCounter] == sServiceName )
 460         {
 461             return sal_True ;
 462         }
 463     }
 464     return sal_False ;
 465 }
 466
 467 /* XServiceInfo */
 468 UNOSEQUENCE< UNOOUSTRING > SAL_CALL SmFilterDetect::getSupportedServiceNames() throw( UNORUNTIMEEXCEPTION )
 469 {
 470     return impl_getStaticSupportedServiceNames();
 471 }
 472
 473 /* Helper for XServiceInfo */
 474 UNOSEQUENCE< UNOOUSTRING > SmFilterDetect::impl_getStaticSupportedServiceNames()
 475 {
 476     UNOMUTEXGUARD aGuard( UNOMUTEX::getGlobalMutex() );
 477     UNOSEQUENCE< UNOOUSTRING > seqServiceNames( 1 );
 478     seqServiceNames.getArray() [0] = UNOOUSTRING::createFromAscii( "com.sun.star.frame.ExtendedTypeDetection"  );
 479     return seqServiceNames ;
 480 }
 481
 482 /* Helper for XServiceInfo */
 483 UNOOUSTRING SmFilterDetect::impl_getStaticImplementationName()
 484 {
 485     return UNOOUSTRING::createFromAscii( "com.sun.star.comp.math.FormatDetector" );
 486 }
 487
 488 /* Helper for registry */
 489 UNOREFERENCE< UNOXINTERFACE > SAL_CALL SmFilterDetect::impl_createInstance( const UNOREFERENCE< UNOXMULTISERVICEFACTORY >& xServiceManager ) throw( UNOEXCEPTION )
 490 {
 491     return UNOREFERENCE< UNOXINTERFACE >( *new SmFilterDetect( xServiceManager ) );
 492 }
 493