sfx2/source/config/evntconf.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: evntconf.cxx,v $
  10  * $Revision: 1.32 $
  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_sfx2.hxx"
  33 #include <vcl/msgbox.hxx>
  34 #ifndef _SV_RESARY_HXX
  35 #include <tools/resary.hxx>
  36 #endif
  37 #include <svtools/lstner.hxx>
  38 #include <basic/basmgr.hxx>
  39 #include <basic/sbmod.hxx>
  40 #include <tools/urlobj.hxx>
  41 #include <basic/sbx.hxx>
  42
  43 #include <sot/storage.hxx>
  44 #include <svtools/securityoptions.hxx>
  45
  46 #ifndef _RTL_USTRING_
  47 #include <rtl/ustring.h>
  48 #endif
  49
  50 #include <com/sun/star/uno/Any.hxx>
  51 #include <framework/eventsconfiguration.hxx>
  52 #include <comphelper/processfactory.hxx>
  53
  54 #include <sfx2/evntconf.hxx>
  55
  56 #include <sfx2/macrconf.hxx>
  57 #include <sfx2/docfile.hxx>
  58 #include <sfx2/app.hxx>
  59 #include <sfx2/objsh.hxx>
  60 #include <sfx2/dispatch.hxx>
  61 #include "config.hrc"
  62 #include "sfxresid.hxx"
  63 #include "eventsupplier.hxx"
  64
  65 #include <com/sun/star/beans/PropertyValue.hpp>
  66 #include <com/sun/star/container/XNameReplace.hpp>
  67 #include <com/sun/star/document/XEventsSupplier.hpp>
  68 #include <com/sun/star/uno/Sequence.hxx>
  69 #include <com/sun/star/uno/Reference.hxx>
  70
  71 // -----------------------------------------------------------------------
  72 TYPEINIT1(SfxEventHint, SfxHint);
  73 TYPEINIT1(SfxEventNamesItem, SfxPoolItem);
  74
  75 using namespace com::sun::star;
  76
  77 SfxEventNamesList& SfxEventNamesList::operator=( const SfxEventNamesList& rTbl )
  78 {
  79     DelDtor();
  80     for (USHORT n=0; n<rTbl.Count(); n++ )
  81     {
  82         SfxEventName* pTmp = ((SfxEventNamesList&)rTbl).GetObject(n);
  83         SfxEventName *pNew = new SfxEventName( *pTmp );
  84         Insert( pNew, n );
  85     }
  86     return *this;
  87 }
  88
  89 void SfxEventNamesList::DelDtor()
  90 {
  91     SfxEventName* pTmp = First();
  92     while( pTmp )
  93     {
  94         delete pTmp;
  95         pTmp = Next();
  96     }
  97     Clear();
  98 }
  99
 100 int SfxEventNamesItem::operator==( const SfxPoolItem& rAttr ) const
 101 {
 102     DBG_ASSERT( SfxPoolItem::operator==(rAttr), "unequal types" );
 103
 104     const SfxEventNamesList& rOwn = aEventsList;
 105     const SfxEventNamesList& rOther = ( (SfxEventNamesItem&) rAttr ).aEventsList;
 106
 107     if ( rOwn.Count() != rOther.Count() )
 108         return FALSE;
 109
 110     for ( USHORT nNo = 0; nNo < rOwn.Count(); ++nNo )
 111     {
 112         const SfxEventName *pOwn = rOwn.GetObject(nNo);
 113         const SfxEventName *pOther = rOther.GetObject(nNo);
 114         if (    pOwn->mnId != pOther->mnId ||
 115                 pOwn->maEventName != pOther->maEventName ||
 116                 pOwn->maUIName != pOther->maUIName )
 117             return FALSE;
 118     }
 119
 120     return TRUE;
 121
 122 }
 123
 124 SfxItemPresentation SfxEventNamesItem::GetPresentation( SfxItemPresentation,
 125                                     SfxMapUnit,
 126                                     SfxMapUnit,
 127                                     XubString &rText,
 128                                     const IntlWrapper* ) const
 129 {
 130     rText.Erase();
 131     return SFX_ITEM_PRESENTATION_NONE;
 132 }
 133
 134 SfxPoolItem* SfxEventNamesItem::Clone( SfxItemPool *) const
 135 {
 136     return new SfxEventNamesItem(*this);
 137 }
 138
 139 SfxPoolItem* SfxEventNamesItem::Create(SvStream &, USHORT) const
 140 {
 141     DBG_ERROR("not streamable!");
 142     return new SfxEventNamesItem(Which());
 143 }
 144
 145 SvStream& SfxEventNamesItem::Store(SvStream &rStream, USHORT ) const
 146 {
 147     DBG_ERROR("not streamable!");
 148     return rStream;
 149 }
 150
 151 USHORT SfxEventNamesItem::GetVersion( USHORT ) const
 152 {
 153     DBG_ERROR("not streamable!");
 154     return 0;
 155 }
 156
 157 void SfxEventNamesItem::AddEvent( const String& rName, const String& rUIName, USHORT nID )
 158 {
 159     aEventsList.Insert( new SfxEventName( nID, rName, rUIName.Len() ? rUIName : rName ) );
 160 }
 161
 162
 163 //==========================================================================
 164
 165 //--------------------------------------------------------------------------
 166 uno::Any CreateEventData_Impl( const SvxMacro *pMacro )
 167 {
 168 /*
 169     This function converts a SvxMacro into an Any containing three
 170     properties. These properties are EventType and Script. Possible
 171     values for EventType ar StarBasic, JavaScript, ...
 172     The Script property should contain the URL to the macro and looks
 173     like "macro://./standard.module1.main()"
 174
 175     If pMacro is NULL, we return an empty property sequence, so PropagateEvent_Impl
 176     can delete an event binding.
 177 */
 178     uno::Any aEventData;
 179
 180     if ( pMacro )
 181     {
 182         if ( pMacro->GetScriptType() == STARBASIC )
 183         {
 184             uno::Sequence < beans::PropertyValue > aProperties(3);
 185             beans::PropertyValue *pValues = aProperties.getArray();
 186
 187             ::rtl::OUString aType = ::rtl::OUString::createFromAscii( STAR_BASIC );;
 188             ::rtl::OUString aLib  = pMacro->GetLibName();
 189             ::rtl::OUString aMacro = pMacro->GetMacName();
 190
 191             pValues[ 0 ].Name = ::rtl::OUString::createFromAscii( PROP_EVENT_TYPE );
 192             pValues[ 0 ].Value <<= aType;
 193
 194             pValues[ 1 ].Name = ::rtl::OUString::createFromAscii( PROP_LIBRARY );
 195             pValues[ 1 ].Value <<= aLib;
 196
 197             pValues[ 2 ].Name = ::rtl::OUString::createFromAscii( PROP_MACRO_NAME );
 198             pValues[ 2 ].Value <<= aMacro;
 199
 200             aEventData <<= aProperties;
 201         }
 202         else if ( pMacro->GetScriptType() == EXTENDED_STYPE )
 203         {
 204             uno::Sequence < beans::PropertyValue > aProperties(2);
 205             beans::PropertyValue *pValues = aProperties.getArray();
 206
 207             ::rtl::OUString aLib   = pMacro->GetLibName();
 208             ::rtl::OUString aMacro = pMacro->GetMacName();
 209
 210             pValues[ 0 ].Name = ::rtl::OUString::createFromAscii( PROP_EVENT_TYPE );
 211             pValues[ 0 ].Value <<= aLib;
 212
 213             pValues[ 1 ].Name = ::rtl::OUString::createFromAscii( PROP_SCRIPT );
 214             pValues[ 1 ].Value <<= aMacro;
 215
 216             aEventData <<= aProperties;
 217         }
 218         else if ( pMacro->GetScriptType() == JAVASCRIPT )
 219         {
 220             uno::Sequence < beans::PropertyValue > aProperties(2);
 221             beans::PropertyValue *pValues = aProperties.getArray();
 222
 223             ::rtl::OUString aMacro  = pMacro->GetMacName();
 224
 225             pValues[ 0 ].Name = ::rtl::OUString::createFromAscii( PROP_EVENT_TYPE );
 226             pValues[ 0 ].Value <<= ::rtl::OUString::createFromAscii(SVX_MACRO_LANGUAGE_JAVASCRIPT);
 227
 228             pValues[ 1 ].Name = ::rtl::OUString::createFromAscii( PROP_MACRO_NAME );
 229             pValues[ 1 ].Value <<= aMacro;
 230
 231             aEventData <<= aProperties;
 232         }
 233         else
 234         {
 235             DBG_ERRORFILE( "CreateEventData_Impl(): ScriptType not supported!");
 236         }
 237     }
 238     else
 239     {
 240         uno::Sequence < beans::PropertyValue > aProperties;
 241         aEventData <<= aProperties;
 242     }
 243
 244     return aEventData;
 245 }
 246
 247 //--------------------------------------------------------------------------
 248 void PropagateEvent_Impl( SfxObjectShell *pDoc, rtl::OUString aEventName, const SvxMacro* pMacro )
 249 {
 250     uno::Reference < document::XEventsSupplier > xSupplier;
 251     if ( pDoc )
 252     {
 253         xSupplier = uno::Reference < document::XEventsSupplier >( pDoc->GetModel(), uno::UNO_QUERY );
 254     }
 255     else
 256     {
 257         xSupplier = uno::Reference < document::XEventsSupplier >
 258                 ( ::comphelper::getProcessServiceFactory()->createInstance(
 259                 rtl::OUString::createFromAscii("com.sun.star.frame.GlobalEventBroadcaster" )), uno::UNO_QUERY );
 260     }
 261
 262     if ( xSupplier.is() )
 263     {
 264         uno::Reference < container::XNameReplace > xEvents = xSupplier->getEvents();
 265         if ( aEventName.getLength() )
 266         {
 267             uno::Any aEventData = CreateEventData_Impl( pMacro );
 268
 269             try
 270             {
 271                 xEvents->replaceByName( aEventName, aEventData );
 272             }
 273             catch( ::com::sun::star::lang::IllegalArgumentException )
 274             { DBG_ERRORFILE( "PropagateEvents_Impl: caught IllegalArgumentException" ); }
 275             catch( ::com::sun::star::container::NoSuchElementException )
 276             { DBG_ERRORFILE( "PropagateEvents_Impl: caught NoSuchElementException" ); }
 277         }
 278         else {
 279             DBG_WARNING( "PropagateEvents_Impl: Got unkown event" );
 280         }
 281     }
 282 }
 283
 284 //--------------------------------------------------------------------------------------------------------
 285 void SfxEventConfiguration::ConfigureEvent( rtl::OUString aName, const SvxMacro& rMacro, SfxObjectShell *pDoc )
 286 {
 287     SvxMacro *pMacro = NULL;
 288     if ( rMacro.GetMacName().Len() )
 289         pMacro = new SvxMacro( rMacro.GetMacName(), rMacro.GetLibName(), rMacro.GetScriptType() );
 290     if ( pDoc )
 291     {
 292         PropagateEvent_Impl( pDoc, aName, pMacro );
 293     }
 294     else
 295     {
 296         PropagateEvent_Impl( NULL, aName, pMacro );
 297     }
 298 }
 299
 300 // -------------------------------------------------------------------------------------------------------
 301 SvxMacro* SfxEventConfiguration::ConvertToMacro( const com::sun::star::uno::Any& rElement, SfxObjectShell* pDoc, BOOL bBlowUp )
 302 {
 303     return SfxEvents_Impl::ConvertToMacro( rElement, pDoc, bBlowUp );
 304 }