1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef __FRAMEWORK_HELPER_INTERCEPTIONHELPER_HXX_ 25*b1cdbd2cSJim Jagielski #define __FRAMEWORK_HELPER_INTERCEPTIONHELPER_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 28*b1cdbd2cSJim Jagielski // my own includes 29*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski #include <services/frame.hxx> 32*b1cdbd2cSJim Jagielski #include <threadhelp/threadhelpbase.hxx> 33*b1cdbd2cSJim Jagielski #include <macros/xinterface.hxx> 34*b1cdbd2cSJim Jagielski #include <macros/generic.hxx> 35*b1cdbd2cSJim Jagielski #include <macros/debug.hxx> 36*b1cdbd2cSJim Jagielski #include <general.h> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 39*b1cdbd2cSJim Jagielski // interface includes 40*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 41*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp> 42*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatchProviderInterception.hpp> 43*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatchProviderInterceptor.hpp> 44*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatchProvider.hpp> 45*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatch.hpp> 46*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XFrame.hpp> 47*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/DispatchDescriptor.hpp> 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 50*b1cdbd2cSJim Jagielski // other includes 51*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 52*b1cdbd2cSJim Jagielski #include <tools/wldcrd.hxx> 53*b1cdbd2cSJim Jagielski #include <cppuhelper/weak.hxx> 54*b1cdbd2cSJim Jagielski #include <cppuhelper/weakref.hxx> 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski #ifndef __SGI_STL_DEQUE 57*b1cdbd2cSJim Jagielski #include <deque> 58*b1cdbd2cSJim Jagielski #endif 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 61*b1cdbd2cSJim Jagielski // namespace 62*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski namespace framework{ 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 67*b1cdbd2cSJim Jagielski // exported const 68*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski //_________________________________________________________ 71*b1cdbd2cSJim Jagielski // definitions 72*b1cdbd2cSJim Jagielski //_________________________________________________________ 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** @short implements a helper to support interception with additional functionality. 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @descr This helper implements the complete XDispatchProviderInterception interface with 77*b1cdbd2cSJim Jagielski master/slave functionality AND using of optional features like registration of URL pattern! 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @attention Don't use this class as direct member - use it dynamicly. Do not derive from this class. 80*b1cdbd2cSJim Jagielski We hold a weakreference to ouer owner not to ouer superclass. 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski class InterceptionHelper : public css::frame::XDispatchProvider 83*b1cdbd2cSJim Jagielski , public css::frame::XDispatchProviderInterception 84*b1cdbd2cSJim Jagielski , public css::lang::XEventListener 85*b1cdbd2cSJim Jagielski // order of base classes is important for right initialization of mutex member! 86*b1cdbd2cSJim Jagielski , private ThreadHelpBase 87*b1cdbd2cSJim Jagielski , public ::cppu::OWeakObject 88*b1cdbd2cSJim Jagielski { 89*b1cdbd2cSJim Jagielski //_____________________________________________________ 90*b1cdbd2cSJim Jagielski // structs, helper 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski /** @short bind an interceptor component to it's URL pattern registration. */ 93*b1cdbd2cSJim Jagielski struct InterceptorInfo 94*b1cdbd2cSJim Jagielski { 95*b1cdbd2cSJim Jagielski /** @short reference to the interceptor component. */ 96*b1cdbd2cSJim Jagielski css::uno::Reference< css::frame::XDispatchProvider > xInterceptor; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski /** @short it's registration for URL patterns. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @descr If the interceptor component does not support the optional interface 101*b1cdbd2cSJim Jagielski XInterceptorInfo, it will be registered for one pattern "*" by default. 102*b1cdbd2cSJim Jagielski That would make it possible to handle it in the same manner then real 103*b1cdbd2cSJim Jagielski registered interceptor objects and we must not implement any special code. */ 104*b1cdbd2cSJim Jagielski css::uno::Sequence< ::rtl::OUString > lURLPattern; 105*b1cdbd2cSJim Jagielski }; 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski //_____________________________________________________ 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski /** @short implements a list of items of type InterceptorInfo, and provides some special 110*b1cdbd2cSJim Jagielski functions on it. 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski @descr Because interceptor objects can be registered for URL patterns, 113*b1cdbd2cSJim Jagielski it supports a wildcard search on all list items. 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski class InterceptorList : public ::std::deque< InterceptorInfo > 116*b1cdbd2cSJim Jagielski { 117*b1cdbd2cSJim Jagielski public: 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski //_____________________________________________ 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** @short search for an interceptor inside this list using it's reference. 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski @param xInterceptor 124*b1cdbd2cSJim Jagielski points to the interceptor object, which should be located inside this list. 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski @return An iterator object, which points directly to the located item inside this list. 127*b1cdbd2cSJim Jagielski In case no interceptor could be found, it points to the end of this list! 128*b1cdbd2cSJim Jagielski */ findByReference(const css::uno::Reference<css::frame::XDispatchProviderInterceptor> & xInterceptor)129*b1cdbd2cSJim Jagielski iterator findByReference(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) 130*b1cdbd2cSJim Jagielski { 131*b1cdbd2cSJim Jagielski css::uno::Reference< css::frame::XDispatchProviderInterceptor > xProviderInterface(xInterceptor, css::uno::UNO_QUERY); 132*b1cdbd2cSJim Jagielski iterator pIt; 133*b1cdbd2cSJim Jagielski for (pIt=begin(); pIt!=end(); ++pIt) 134*b1cdbd2cSJim Jagielski { 135*b1cdbd2cSJim Jagielski if (pIt->xInterceptor == xProviderInterface) 136*b1cdbd2cSJim Jagielski return pIt; 137*b1cdbd2cSJim Jagielski } 138*b1cdbd2cSJim Jagielski return end(); 139*b1cdbd2cSJim Jagielski } 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski //_____________________________________________ 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski /** @short search for an interceptor inside this list using it's reference. 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski @param xInterceptor 146*b1cdbd2cSJim Jagielski points to the interceptor object, which should be located inside this list. 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski @return An iterator object, which points directly to the located item inside this list. 149*b1cdbd2cSJim Jagielski In case no interceptor could be found, it points to the end of this list! 150*b1cdbd2cSJim Jagielski */ findByPattern(const::rtl::OUString & sURL)151*b1cdbd2cSJim Jagielski iterator findByPattern(const ::rtl::OUString& sURL) 152*b1cdbd2cSJim Jagielski { 153*b1cdbd2cSJim Jagielski iterator pIt; 154*b1cdbd2cSJim Jagielski for (pIt=begin(); pIt!=end(); ++pIt) 155*b1cdbd2cSJim Jagielski { 156*b1cdbd2cSJim Jagielski sal_Int32 c = pIt->lURLPattern.getLength(); 157*b1cdbd2cSJim Jagielski const ::rtl::OUString* pPattern = pIt->lURLPattern.getConstArray(); 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski for (sal_Int32 i=0; i<c; ++i) 160*b1cdbd2cSJim Jagielski { 161*b1cdbd2cSJim Jagielski WildCard aPattern(pPattern[i]); 162*b1cdbd2cSJim Jagielski if (aPattern.Matches(sURL)) 163*b1cdbd2cSJim Jagielski return pIt; 164*b1cdbd2cSJim Jagielski } 165*b1cdbd2cSJim Jagielski } 166*b1cdbd2cSJim Jagielski return end(); 167*b1cdbd2cSJim Jagielski } 168*b1cdbd2cSJim Jagielski }; 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski //_____________________________________________________ 171*b1cdbd2cSJim Jagielski // member 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski private: 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski /** @short reference to the frame, which uses this instance to implement it's own interception. 176*b1cdbd2cSJim Jagielski 177*b1cdbd2cSJim Jagielski @descr We hold a weak reference only, to make disposing operations easy. */ 178*b1cdbd2cSJim Jagielski css::uno::WeakReference< css::frame::XFrame > m_xOwnerWeak; 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /** @short this interception helper implements the top level master of an interceptor list ... 181*b1cdbd2cSJim Jagielski but this member is the lowest possible slave! */ 182*b1cdbd2cSJim Jagielski css::uno::Reference< css::frame::XDispatchProvider > m_xSlave; 183*b1cdbd2cSJim Jagielski 184*b1cdbd2cSJim Jagielski /** @short contains all registered interceptor objects. */ 185*b1cdbd2cSJim Jagielski InterceptorList m_lInterceptionRegs; 186*b1cdbd2cSJim Jagielski 187*b1cdbd2cSJim Jagielski /** @short it regulates, which interceptor is used first. 188*b1cdbd2cSJim Jagielski The last or the first registered one. */ 189*b1cdbd2cSJim Jagielski static sal_Bool m_bPreferrFirstInterceptor; 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski //_____________________________________________________ 192*b1cdbd2cSJim Jagielski // native interface 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski public: 195*b1cdbd2cSJim Jagielski 196*b1cdbd2cSJim Jagielski //_________________________________________________ 197*b1cdbd2cSJim Jagielski 198*b1cdbd2cSJim Jagielski /** @short creates a new interception helper instance. 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski @param xOwner 201*b1cdbd2cSJim Jagielski points to the frame, which use this instances to support it's own interception interfaces. 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski @param xSlave 204*b1cdbd2cSJim Jagielski an outside creates dispatch provider, which has to be used here as lowest slave "interceptor". 205*b1cdbd2cSJim Jagielski */ 206*b1cdbd2cSJim Jagielski InterceptionHelper(const css::uno::Reference< css::frame::XFrame >& xOwner, 207*b1cdbd2cSJim Jagielski const css::uno::Reference< css::frame::XDispatchProvider >& xSlave); 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski protected: 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski //_________________________________________________ 212*b1cdbd2cSJim Jagielski 213*b1cdbd2cSJim Jagielski /** @short standard destructor. 214*b1cdbd2cSJim Jagielski 215*b1cdbd2cSJim Jagielski @descr This method destruct an instance of this class and clear some member. 216*b1cdbd2cSJim Jagielski This method is protected, because its not allowed to use this class as a direct member! 217*b1cdbd2cSJim Jagielski You MUST use a dynamical instance (pointer). That's the reason for a protected dtor. 218*b1cdbd2cSJim Jagielski */ 219*b1cdbd2cSJim Jagielski virtual ~InterceptionHelper(); 220*b1cdbd2cSJim Jagielski 221*b1cdbd2cSJim Jagielski //_____________________________________________________ 222*b1cdbd2cSJim Jagielski // uno interface 223*b1cdbd2cSJim Jagielski 224*b1cdbd2cSJim Jagielski public: 225*b1cdbd2cSJim Jagielski 226*b1cdbd2cSJim Jagielski FWK_DECLARE_XINTERFACE 227*b1cdbd2cSJim Jagielski 228*b1cdbd2cSJim Jagielski //_________________________________________________ 229*b1cdbd2cSJim Jagielski // XDispatchProvider 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski /** @short query for a dispatch, which implements the requested feature. 232*b1cdbd2cSJim Jagielski 233*b1cdbd2cSJim Jagielski @descr We search inside our list of interception registrations, to locate 234*b1cdbd2cSJim Jagielski any interested interceptor. In case no interceptor exists or nobody is 235*b1cdbd2cSJim Jagielski interested on this URL our lowest slave will be used. 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski @param aURL 238*b1cdbd2cSJim Jagielski describes the requested dispatch functionality. 239*b1cdbd2cSJim Jagielski 240*b1cdbd2cSJim Jagielski @param sTargetFrameName 241*b1cdbd2cSJim Jagielski the name of the target frame or a special name like "_blank", "_top" ... 242*b1cdbd2cSJim Jagielski Won't be used here ... but may by one of our registered interceptor objects 243*b1cdbd2cSJim Jagielski or our slave. 244*b1cdbd2cSJim Jagielski 245*b1cdbd2cSJim Jagielski @param nSearchFlags 246*b1cdbd2cSJim Jagielski optional search parameter for targeting, if sTargetFrameName isn't a special one. 247*b1cdbd2cSJim Jagielski 248*b1cdbd2cSJim Jagielski @return A valid dispatch object, if any interceptor or at least our slave is interested on the given URL; 249*b1cdbd2cSJim Jagielski or NULL otherwhise. 250*b1cdbd2cSJim Jagielski */ 251*b1cdbd2cSJim Jagielski virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch(const css::util::URL& aURL , 252*b1cdbd2cSJim Jagielski const ::rtl::OUString& sTargetFrameName, 253*b1cdbd2cSJim Jagielski sal_Int32 nSearchFlags ) 254*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 255*b1cdbd2cSJim Jagielski 256*b1cdbd2cSJim Jagielski //_________________________________________________ 257*b1cdbd2cSJim Jagielski // XDispatchProvider 258*b1cdbd2cSJim Jagielski 259*b1cdbd2cSJim Jagielski /** @short implements an optimized queryDispatch() for remote. 260*b1cdbd2cSJim Jagielski 261*b1cdbd2cSJim Jagielski @descr It capsulate more then one queryDispatch() requests and return a lits of dispatch objects 262*b1cdbd2cSJim Jagielski as result. Because both lists (in and out) coreespond together, it's not allowed to 263*b1cdbd2cSJim Jagielski pack it - means supress NULL references! 264*b1cdbd2cSJim Jagielski 265*b1cdbd2cSJim Jagielski @param lDescriptor 266*b1cdbd2cSJim Jagielski a list of queryDispatch() arguments. 267*b1cdbd2cSJim Jagielski 268*b1cdbd2cSJim Jagielski @return A list of dispatch objects. 269*b1cdbd2cSJim Jagielski */ 270*b1cdbd2cSJim Jagielski virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches(const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor) 271*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 272*b1cdbd2cSJim Jagielski 273*b1cdbd2cSJim Jagielski //_________________________________________________ 274*b1cdbd2cSJim Jagielski // XDispatchProviderInterception 275*b1cdbd2cSJim Jagielski 276*b1cdbd2cSJim Jagielski /** @short register an interceptor. 277*b1cdbd2cSJim Jagielski 278*b1cdbd2cSJim Jagielski @descr Somebody can register himself to intercept all or some special dispatches. 279*b1cdbd2cSJim Jagielski It's depend from his supported interfaces. If he implement XInterceptorInfo 280*b1cdbd2cSJim Jagielski he his called for some special URLs only - otherwise we call it for every request! 281*b1cdbd2cSJim Jagielski 282*b1cdbd2cSJim Jagielski @attention We don't check for double registrations here! 283*b1cdbd2cSJim Jagielski 284*b1cdbd2cSJim Jagielski @param xInterceptor 285*b1cdbd2cSJim Jagielski reference to interceptor, which wish to be registered here. 286*b1cdbd2cSJim Jagielski 287*b1cdbd2cSJim Jagielski @throw A RuntimeException if the given reference is NULL! 288*b1cdbd2cSJim Jagielski */ 289*b1cdbd2cSJim Jagielski virtual void SAL_CALL registerDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) 290*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 291*b1cdbd2cSJim Jagielski 292*b1cdbd2cSJim Jagielski //_________________________________________________ 293*b1cdbd2cSJim Jagielski // XDispatchProviderInterception 294*b1cdbd2cSJim Jagielski 295*b1cdbd2cSJim Jagielski /** @short release an interceptor. 296*b1cdbd2cSJim Jagielski 297*b1cdbd2cSJim Jagielski @descr Remove the registered interceptor from our internal list 298*b1cdbd2cSJim Jagielski and delete all special informations about it. 299*b1cdbd2cSJim Jagielski 300*b1cdbd2cSJim Jagielski @param xInterceptor 301*b1cdbd2cSJim Jagielski reference to the interceptor, which wish to be deregistered. 302*b1cdbd2cSJim Jagielski 303*b1cdbd2cSJim Jagielski @throw A RuntimeException if the given reference is NULL! 304*b1cdbd2cSJim Jagielski */ 305*b1cdbd2cSJim Jagielski virtual void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor ) throw( css::uno::RuntimeException ); 306*b1cdbd2cSJim Jagielski 307*b1cdbd2cSJim Jagielski //_________________________________________________ 308*b1cdbd2cSJim Jagielski // XEventListener 309*b1cdbd2cSJim Jagielski 310*b1cdbd2cSJim Jagielski /** @short Is called from our owner frame, in case he will be disposed. 311*b1cdbd2cSJim Jagielski 312*b1cdbd2cSJim Jagielski @descr We have to relaease all references to him then. 313*b1cdbd2cSJim Jagielski Normaly we will die by ref count too ... 314*b1cdbd2cSJim Jagielski */ 315*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) 316*b1cdbd2cSJim Jagielski throw(css::uno::RuntimeException); 317*b1cdbd2cSJim Jagielski 318*b1cdbd2cSJim Jagielski }; // class InterceptionHelper 319*b1cdbd2cSJim Jagielski 320*b1cdbd2cSJim Jagielski } // namespace framework 321*b1cdbd2cSJim Jagielski 322*b1cdbd2cSJim Jagielski #endif // #ifndef __FRAMEWORK_HELPER_INTERCEPTIONHELPER_HXX_ 323