framework/qa/complex/dispatches/Interceptor.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package complex.dispatches;
  19
  20 // __________ Imports __________
  21
  22 // structs, const, ...
  23 import com.sun.star.beans.PropertyValue;
  24
  25 // exceptions
  26 import com.sun.star.frame.DispatchDescriptor;
  27 import com.sun.star.frame.XDispatch;
  28 import com.sun.star.frame.XDispatchProvider;
  29 import com.sun.star.frame.XDispatchProviderInterceptor;
  30 import com.sun.star.frame.XInterceptorInfo;
  31 import com.sun.star.frame.XStatusListener;
  32
  33 // interfaces
  34
  35
  36 // helper
  37 import com.sun.star.util.URL;
  38
  39 // __________ Implementation __________
  40
  41 /**
  42  * implements a configurable interceptor for dispatch events.
  43  */
  44 public class Interceptor implements XDispatchProvider,
  45                                     XDispatch,
  46                                     XDispatchProviderInterceptor,
  47                                     XInterceptorInfo
  48 {
  49     // ____________________
  50
  51     /** contains the list of interception URL schema's (wildcards are allowed there!)
  52         supported by this interceptor. It can be set from outside.
  53         If no external URLs are set, the default "*" is used instead.
  54         That would have the same effect as if this implementation would not support the
  55         interface XInterceptorInfo !
  56      */
  57     private String[] m_lURLs4InterceptionInfo = null;
  58
  59     // ____________________
  60
  61     /** These URL's will be blocked by this interceptor.
  62         Can be set from outside. Every queryDispatch() for these
  63         set of URL's will be answered with an empty dispatch object!
  64         If no external URLs are set the default "*" is used instead.
  65         So every incoming URL will be blocked .-)
  66      */
  67     private String[] m_lURLs4Blocking = null;
  68
  69     // ____________________
  70
  71     /** Every dispatch interceptor knows it's master and slave interceptor
  72         of the dispatch chain. These values must be stupid handled .-)
  73         They have to be set and reset in case the right interface methods are called.
  74         Nothing more. It's not allowed to dispose() it.
  75         The slave can be used inside queryDispatch() to forward requests,
  76         which are not handled by this interceptor instance.
  77      */
  78     private XDispatchProvider m_xSlave  = null;
  79     private XDispatchProvider m_xMaster = null;
  80
  81     // ____________________
  82
  83     /** counts calls of setSlave...().
  84         So the outside API test can use this value to know if this interceptor
  85         was realy added to the interceptor chain of OOo.
  86      */
  87     private int m_nRegistrationCount = 0;
  88
  89     // ____________________
  90
  91     /** indicates if this interceptor object is currently part of the interceptor
  92         chain of OOo. Only true if a valid slave or master dispatch is set on this
  93         instance.
  94      */
  95     private boolean m_bIsRegistered = false;
  96
  97
  98     // ____________________
  99
 100     /** ctor
 101      *  It's initialize an object of this class with default values.
 102      */
 103     public Interceptor()
 104     {
 105     }
 106
 107     // ____________________
 108
 109     /** XInterceptorInfo */
 110     public synchronized String[] getInterceptedURLs()
 111     {
 112         return impl_getURLs4InterceptionInfo();
 113     }
 114
 115     // ____________________
 116
 117     /** XDispatchProviderInterceptor */
 118     public synchronized XDispatchProvider getSlaveDispatchProvider()
 119     {
 120         System.out.println("Interceptor.getSlaveDispatchProvider() called");
 121         return m_xSlave;
 122     }
 123
 124     // ____________________
 125
 126     /** XDispatchProviderInterceptor */
 127     public synchronized XDispatchProvider getMasterDispatchProvider()
 128     {
 129         System.out.println("Interceptor.getMasterDispatchProvider() called");
 130         return m_xMaster;
 131     }
 132
 133     // ____________________
 134
 135     /** XDispatchProviderInterceptor */
 136     public synchronized void setSlaveDispatchProvider(XDispatchProvider xSlave)
 137     {
 138         System.out.println("Interceptor.setSlaveDispatchProvider("+xSlave+") called");
 139
 140         if (xSlave != null)
 141         {
 142             ++m_nRegistrationCount;
 143             m_bIsRegistered = true;
 144         }
 145         else
 146         {
 147             m_bIsRegistered = false;
 148         }
 149
 150         m_xSlave = xSlave;
 151     }
 152
 153     // ____________________
 154
 155     /** XDispatchProviderInterceptor */
 156     public synchronized void setMasterDispatchProvider(XDispatchProvider xMaster)
 157     {
 158         System.out.println("Interceptor.setMasterDispatchProvider("+xMaster+") called");
 159         m_xMaster = xMaster;
 160     }
 161
 162     // ____________________
 163
 164     /** XDispatchProvider
 165      */
 166     public synchronized XDispatch queryDispatch(URL aURL            ,
 167                                                                    String                sTargetFrameName,
 168                                                                    int                   nSearchFlags    )
 169     {
 170         System.out.println("Interceptor.queryDispatch('"+aURL.Complete+"', '"+sTargetFrameName+"', "+nSearchFlags+") called");
 171
 172         if (impl_isBlockedURL(aURL.Complete))
 173         {
 174             System.out.println("Interceptor.queryDispatch(): URL blocked => returns NULL");
 175             return null;
 176         }
 177
 178         if (m_xSlave != null)
 179         {
 180             System.out.println("Interceptor.queryDispatch(): ask slave ...");
 181             return m_xSlave.queryDispatch(aURL, sTargetFrameName, nSearchFlags);
 182         }
 183
 184         System.out.println("Interceptor.queryDispatch(): no idea => returns this");
 185         return this;
 186     }
 187
 188     // ____________________
 189
 190     /** XDispatchProvider
 191      */
 192     public XDispatch[] queryDispatches(DispatchDescriptor[] lRequests)
 193     {
 194         int i = 0;
 195         int c = lRequests.length;
 196
 197         XDispatch[] lResults = new XDispatch[c];
 198         for (i=0; i<c; ++i)
 199         {
 200             lResults[i] = queryDispatch(lRequests[i].FeatureURL ,
 201                                         lRequests[i].FrameName  ,
 202                                         lRequests[i].SearchFlags);
 203         }
 204
 205         return lResults;
 206     }
 207
 208     // ____________________
 209
 210     /** XDispatch
 211      */
 212     public synchronized void dispatch(URL              aURL      ,
 213                                       PropertyValue[] lArguments)
 214     {
 215         System.out.println("Interceptor.dispatch('"+aURL.Complete+"') called");
 216     }
 217
 218     // ____________________
 219
 220     /** XDispatch
 221      */
 222     public synchronized void addStatusListener(XStatusListener xListener,
 223                                                com.sun.star.util.URL              aURL     )
 224     {
 225         System.out.println("Interceptor.addStatusListener(..., '"+aURL.Complete+"') called");
 226     }
 227
 228     // ____________________
 229
 230     /** XDispatch
 231      */
 232     public synchronized void removeStatusListener(XStatusListener xListener,
 233                                                   com.sun.star.util.URL              aURL     )
 234     {
 235         System.out.println("Interceptor.removeStatusListener(..., '"+aURL.Complete+"') called");
 236     }
 237
 238     // ____________________
 239
 240     public synchronized int getRegistrationCount()
 241     {
 242         return m_nRegistrationCount;
 243     }
 244
 245     // ____________________
 246
 247     public synchronized boolean isRegistered()
 248     {
 249         return m_bIsRegistered;
 250     }
 251
 252     // ____________________
 253
 254     /** set a new list of URL's, which should be used on registration time
 255         (that's why it's neccessary to call this impl-method before the interceptor
 256         is used at the OOo API!) to optimize the interception chain.
 257      */
 258     public synchronized void setURLs4InterceptionInfo(String[] lURLs)
 259     {
 260         m_lURLs4InterceptionInfo = lURLs;
 261     }
 262
 263     // ____________________
 264
 265     /** set a new list of URL's, which should be blocked by this interceptor.
 266         (that's why it's neccessary to call this impl-method before the interceptor
 267         is used at the OOo API!)
 268      */
 269     public synchronized void setURLs4URLs4Blocking(String[] lURLs)
 270     {
 271         m_lURLs4Blocking = lURLs;
 272     }
 273
 274     // ____________________
 275
 276     /** must be used internal to access the member m_lURLs4InterceptionInfo
 277         - threadsafe
 278         - and to make sure it's initialized on demand
 279      */
 280     private synchronized String[] impl_getURLs4InterceptionInfo()
 281     {
 282         if (m_lURLs4InterceptionInfo == null)
 283         {
 284             m_lURLs4InterceptionInfo    = new String[1];
 285             m_lURLs4InterceptionInfo[0] = "*";
 286         }
 287
 288         return m_lURLs4InterceptionInfo;
 289     }
 290
 291     // ____________________
 292
 293     /** must be used internal to access the member m_lURLs4Blocking
 294         - threadsafe
 295         - and to make sure it's initialized on demand
 296      */
 297     private synchronized String[] impl_getURLs4Blocking()
 298     {
 299         if (m_lURLs4Blocking == null)
 300         {
 301             m_lURLs4Blocking    = new String[1];
 302             m_lURLs4Blocking[0] = "*";
 303         }
 304
 305         return m_lURLs4Blocking;
 306     }
 307
 308     // ____________________
 309     private boolean impl_isBlockedURL(String sURL)
 310     {
 311         String[] lBlockedURLs = impl_getURLs4Blocking();
 312         int      i            = 0;
 313         int      c            = lBlockedURLs.length;
 314
 315         for (i=0; i<c; ++i)
 316         {
 317             if (impl_match(sURL, lBlockedURLs[i]))
 318             {
 319                 return true;
 320             }
 321         }
 322
 323         return false;
 324     }
 325
 326     // ____________________
 327
 328     private boolean impl_match(String sVal1, String sVal2)
 329     {
 330         // TODO implement wildcard match
 331         return (sVal1.equals(sVal2));
 332     }
 333 }