INTEGRATION: CWS oxtsysint01 (1.1.2); FILE ADDED

2008/04/11 07:21:57 dv 1.1.2.2: #i85856# Now with 'done' notification
2008/04/10 06:41:56 dv 1.1.2.1: #i85856# Office should handle '.oxt' files

1 files changed, 306 insertions, 0 deletions

diff --git a/framework/source/dispatch/oxt_handler.cxx b/framework/source/dispatch/oxt_handler.cxx
new file mode 100644
index 000000000000..ce92f9bf1eaf
--- /dev/null
+++ b/framework/source/dispatch/oxt_handler.cxx
@@ -0,0 +1,306 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: oxt_handler.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2008-05-15 09:05:38 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+// MARKER(update_precomp.py): autogen include statement, do not remove
+#include "precompiled_framework.hxx"
+//_________________________________________________________________________________________________________________
+//  my own includes
+//_________________________________________________________________________________________________________________
+
+#ifndef __FRAMEWORK_DISPATCH_OXT_HANDLER_HXX_
+#include <dispatch/oxt_handler.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_TRANSACTIONGUARD_HXX_
+#include <threadhelp/transactionguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
+#include <threadhelp/writeguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
+#include <threadhelp/readguard.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
+#include <macros/debug.hxx>
+#endif
+
+#ifndef __FRAMEWORK_SERVICES_H_
+#include <services.h>
+#endif
+
+#ifndef __COMPHELPER_MEDIADESCRIPTOR_HXX_
+#include <comphelper/mediadescriptor.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+//  interface includes
+//_________________________________________________________________________________________________________________
+
+#include <com/sun/star/io/XInputStream.hpp>
+#include <com/sun/star/frame/DispatchResultState.hpp>
+#include <com/sun/star/task/XJobExecutor.hpp>
+
+//_________________________________________________________________________________________________________________
+//  includes of other projects
+//_________________________________________________________________________________________________________________
+
+#ifndef _COMPHELPER_SEQUENCEASHASHMAP_HXX_
+#include <comphelper/sequenceashashmap.hxx>
+#endif
+
+#ifndef _RTL_USTRBUF_HXX_
+#include <rtl/ustrbuf.hxx>
+#endif
+
+//_________________________________________________________________________________________________________________
+//  namespace
+//_________________________________________________________________________________________________________________
+
+namespace framework{
+
+//_________________________________________________________________________________________________________________
+//  non exported const
+//_________________________________________________________________________________________________________________
+
+//_________________________________________________________________________________________________________________
+//  non exported definitions
+//_________________________________________________________________________________________________________________
+
+#define UNISTRING(s) rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(s))
+
+//_________________________________________________________________________________________________________________
+//  declarations
+//_________________________________________________________________________________________________________________
+
+//*****************************************************************************************************************
+//  XInterface, XTypeProvider, XServiceInfo
+//*****************************************************************************************************************
+DEFINE_XINTERFACE_5                 (   Oxt_Handler                                                ,
+                                        OWeakObject                                                ,
+                                        DIRECT_INTERFACE( css::lang::XTypeProvider                ),
+                                        DIRECT_INTERFACE( css::lang::XServiceInfo                 ),
+                                        DIRECT_INTERFACE( css::frame::XNotifyingDispatch          ),
+                                        DIRECT_INTERFACE( css::frame::XDispatch                   ),
+                                        DIRECT_INTERFACE( css::document::XExtendedFilterDetection )
+                                    )
+
+DEFINE_XTYPEPROVIDER_5              (   Oxt_Handler                                                ,
+                                        css::lang::XTypeProvider                                   ,
+                                        css::lang::XServiceInfo                                    ,
+                                        css::frame::XNotifyingDispatch                             ,
+                                        css::frame::XDispatch                                      ,
+                                        css::document::XExtendedFilterDetection
+                                    )
+
+DEFINE_XSERVICEINFO_MULTISERVICE    (   Oxt_Handler                                                ,
+                                        ::cppu::OWeakObject                                        ,
+                                        SERVICENAME_CONTENTHANDLER                                 ,
+                                        IMPLEMENTATIONNAME_OXT_HANDLER
+                                    )
+
+DEFINE_INIT_SERVICE                 (   Oxt_Handler,
+                                        {
+                                        }
+                                    )
+
+/*-************************************************************************************************************//**
+    @short      standard ctor
+    @descr      These initialize a new instance of this class with needed informations for work.
+
+    @seealso    using at owner
+
+    @param      "xFactory", reference to service manager for creation of new services
+    @return     -
+
+    @onerror    Show an assertion and do nothing else.
+    @threadsafe yes
+*//*-*************************************************************************************************************/
+Oxt_Handler::Oxt_Handler( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory )
+        //  Init baseclasses first
+        :   ThreadHelpBase      (          )
+        ,   ::cppu::OWeakObject (          )
+        // Init member
+        ,   m_xFactory          ( xFactory )
+{
+}
+
+/*-************************************************************************************************************//**
+    @short      standard dtor
+    @descr      -
+
+    @seealso    -
+
+    @param      -
+    @return     -
+
+    @onerror    -
+    @threadsafe -
+*//*-*************************************************************************************************************/
+Oxt_Handler::~Oxt_Handler()
+{
+    if ( m_xListener.is() )
+    {
+        css::frame::DispatchResultEvent aEvent;
+        aEvent.State = css::frame::DispatchResultState::FAILURE;
+        m_xListener->dispatchFinished( aEvent );
+        m_xListener = css::uno::Reference< css::frame::XDispatchResultListener >();
+    }
+}
+
+/*-************************************************************************************************************//**
+    @interface  ::com::sun::star::frame::XDispatch
+
+    @short      try to load audio file
+    @descr      This method try to load given audio file by URL and play it. We use vcl/Sound class to do that.
+                Playing of sound is asynchron everytime.
+
+    @attention  We must hold us alive by ourself ... because we use async. vcl sound player ... but playing is started
+                in async interface call "dispatch()" too. And caller forget us imediatly. But then our uno ref count
+                will decreased to 0 and will die. The only solution is to use own reference to our implementation.
+                But we do it for realy started jobs only and release it during call back of vcl.
+
+    @seealso    class vcl/Sound
+    @seealso    method implts_PlayerNotify()
+
+    @param      "aURL"      , URL to dispatch.
+    @param      "lArguments", list of optional arguments.
+    @return     -
+
+    @onerror    We do nothing.
+    @threadsafe yes
+*//*-*************************************************************************************************************/
+void SAL_CALL Oxt_Handler::dispatchWithNotification( const css::util::URL& aURL,
+                                                     const css::uno::Sequence< css::beans::PropertyValue >&            /*lArguments*/,
+                                                     const css::uno::Reference< css::frame::XDispatchResultListener >& xListener )
+    throw( css::uno::RuntimeException )
+{
+    // SAFE {
+    ResetableGuard aLock( m_aLock );
+
+    rtl::OUString sServiceName = UNISTRING( "com.sun.star.deployment.ui.PackageManagerDialog" );
+    css::uno::Sequence< css::uno::Any > lParams(1);
+    lParams[0] <<= aURL.Main;
+
+    css::uno::Reference< css::uno::XInterface > xService;
+
+    xService = m_xFactory->createInstanceWithArguments( sServiceName, lParams );
+    css::uno::Reference< css::task::XJobExecutor > xExecuteable( xService, css::uno::UNO_QUERY );
+    if ( xExecuteable.is() )
+        xExecuteable->trigger( rtl::OUString() );
+
+    if ( xListener.is() )
+    {
+        css::frame::DispatchResultEvent aEvent;
+        aEvent.State = css::frame::DispatchResultState::SUCCESS;
+        xListener->dispatchFinished( aEvent );
+    }
+
+/*
+    // Try to initialize player.
+    m_xListener = xListener;
+    if (m_aPlayer.SetSoundName(aURL.Complete))
+    {
+        // OK- we can start async playing ...
+        // Count this request and initialize self-holder against dieing by uno ref count ...
+        m_xSelfHold = css::uno::Reference< css::uno::XInterface >(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
+        m_aPlayer.Play();
+    }
+*/
+    // } SAFE
+    aLock.unlock();
+}
+
+void SAL_CALL Oxt_Handler::dispatch( const css::util::URL&                                  aURL       ,
+                                     const css::uno::Sequence< css::beans::PropertyValue >& lArguments )
+    throw( css::uno::RuntimeException )
+{
+    dispatchWithNotification( aURL, lArguments, css::uno::Reference< css::frame::XDispatchResultListener >() );
+}
+
+/*-************************************************************************************************************//**
+    @interface  ::com::sun::star::document::XExtendedFilterDetection
+
+    @short      try to detect file (given as argument included in "lDescriptor")
+    @descr      We try to detect, if given file could be handled by this class and is a well known one.
+                If it is - we return right internal type name - otherwise we return nothing!
+                So call can search for another detect service and ask him too.
+
+    @attention  a) We don't need any mutex here ... because we don't use any member!
+                b) Dont' use internal player instance "m_pPlayer" to detect given sound file!
+                   It's not neccessary to do that ... and we can use temp. variable to do the same.
+                   This way is easy - we don't must synchronize it with currently played sounds!
+                   Another reason to do so ... We are a listener on our internal ma_Player object.
+                   If you would call "IsSoundFile()" on this instance, he would call us back and
+                   we make some uneccssary things ...
+
+    @seealso    -
+
+    @param      "lDescriptor", description of file to detect
+    @return     Internal type name which match this file ... or nothing if it is unknown.
+
+    @onerror    We return nothing.
+    @threadsafe yes
+*//*-*************************************************************************************************************/
+::rtl::OUString SAL_CALL Oxt_Handler::detect( css::uno::Sequence< css::beans::PropertyValue >& lDescriptor )
+    throw( css::uno::RuntimeException )
+{
+    // Our default is "nothing". So we can return it, if detection failed or fily type is realy unknown.
+    ::rtl::OUString sTypeName;
+
+    // Analyze given descriptor to find filename or input stream or ...
+    ::comphelper::MediaDescriptor aDescriptor( lDescriptor );
+    ::rtl::OUString               sURL       = aDescriptor.getUnpackedValueOrDefault( ::comphelper::MediaDescriptor::PROP_URL(), ::rtl::OUString() );
+
+    long nLength = sURL.getLength();
+    if ( ( nLength > 4 ) && sURL.matchIgnoreAsciiCase( UNISTRING(".oxt"), nLength-4 ) )
+    {
+        // "IsSoundFile" idffer between different "wav" and "au" file versions ...
+        // couldn't return this information ... because: He use the OS to detect it!
+        // I think we can the following ones:
+        //  a) look for given extension of url to map our type decision HARD CODED!!!
+        //  b) return preferred type every time... it's easy :-)
+        sTypeName = ::rtl::OUString::createFromAscii("oxt_OpenOffice_Extension");
+        aDescriptor[::comphelper::MediaDescriptor::PROP_TYPENAME()] <<= sTypeName;
+        aDescriptor >> lDescriptor;
+    }
+
+    // Return our decision.
+    return sTypeName;
+}
+
+} // namespace framework