diff options
Diffstat (limited to 'framework/qa/complex/dispatches')
-rw-r--r-- | framework/qa/complex/dispatches/Interceptor.java | 345 | ||||
-rw-r--r-- | framework/qa/complex/dispatches/checkdispatchapi.java | 498 |
2 files changed, 843 insertions, 0 deletions
diff --git a/framework/qa/complex/dispatches/Interceptor.java b/framework/qa/complex/dispatches/Interceptor.java new file mode 100644 index 000000000000..fc5b57b1215e --- /dev/null +++ b/framework/qa/complex/dispatches/Interceptor.java @@ -0,0 +1,345 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +package complex.dispatches; + +// __________ Imports __________ + +// structs, const, ... +import com.sun.star.beans.PropertyValue; + +// exceptions +import com.sun.star.frame.DispatchDescriptor; +import com.sun.star.frame.XDispatch; +import com.sun.star.frame.XDispatchProvider; +import com.sun.star.frame.XDispatchProviderInterceptor; +import com.sun.star.frame.XInterceptorInfo; +import com.sun.star.frame.XStatusListener; + +// interfaces + + +// helper +import com.sun.star.util.URL; + +// others +//import java.lang.*; + +// __________ Implementation __________ + +/** + * implements a configurable interceptor for dispatch events. + */ +public class Interceptor implements XDispatchProvider, + XDispatch, + XDispatchProviderInterceptor, + XInterceptorInfo +{ + // ____________________ + + /** contains the list of interception URL schema's (wildcards are allowed there!) + supported by this interceptor. It can be set from outside. + If no external URLs are set, the default "*" is used instead. + That would have the same effect as if this implementation would not support the + interface XInterceptorInfo ! + */ + private String[] m_lURLs4InterceptionInfo = null; + + // ____________________ + + /** These URL's will be blocked by this interceptor. + Can be set from outside. Every queryDispatch() for these + set of URL's will be answered with an empty dispatch object! + If no external URLs are set the default "*" is used instead. + So every incoming URL will be blocked .-) + */ + private String[] m_lURLs4Blocking = null; + + // ____________________ + + /** Every dispatch interceptor knows it's master and slave interceptor + of the dispatch chain. These values must be stupid handled .-) + They have to be set and reset in case the right interface methods are called. + Nothing more. It's not allowed to dispose() it. + The slave can be used inside queryDispatch() to forward requests, + which are not handled by this interceptor instance. + */ + private XDispatchProvider m_xSlave = null; + private XDispatchProvider m_xMaster = null; + + // ____________________ + + /** counts calls of setSlave...(). + So the outside API test can use this value to know if this interceptor + was realy added to the interceptor chain of OOo. + */ + private int m_nRegistrationCount = 0; + + // ____________________ + + /** indicates if this interceptor object is currently part of the interceptor + chain of OOo. Only true if a valid slave or master dispatch is set on this + instance. + */ + private boolean m_bIsRegistered = false; + + + // ____________________ + + /** ctor + * It's initialize an object of this class with default values. + */ + public Interceptor() + { + } + + // ____________________ + + /** XInterceptorInfo */ + public synchronized String[] getInterceptedURLs() + { + return impl_getURLs4InterceptionInfo(); + } + + // ____________________ + + /** XDispatchProviderInterceptor */ + public synchronized XDispatchProvider getSlaveDispatchProvider() + { + System.out.println("Interceptor.getSlaveDispatchProvider() called"); + return m_xSlave; + } + + // ____________________ + + /** XDispatchProviderInterceptor */ + public synchronized XDispatchProvider getMasterDispatchProvider() + { + System.out.println("Interceptor.getMasterDispatchProvider() called"); + return m_xMaster; + } + + // ____________________ + + /** XDispatchProviderInterceptor */ + public synchronized void setSlaveDispatchProvider(XDispatchProvider xSlave) + { + System.out.println("Interceptor.setSlaveDispatchProvider("+xSlave+") called"); + + if (xSlave != null) + { + ++m_nRegistrationCount; + m_bIsRegistered = true; + } + else + { + m_bIsRegistered = false; + } + + m_xSlave = xSlave; + } + + // ____________________ + + /** XDispatchProviderInterceptor */ + public synchronized void setMasterDispatchProvider(XDispatchProvider xMaster) + { + System.out.println("Interceptor.setMasterDispatchProvider("+xMaster+") called"); + m_xMaster = xMaster; + } + + // ____________________ + + /** XDispatchProvider + */ + public synchronized XDispatch queryDispatch(URL aURL , + String sTargetFrameName, + int nSearchFlags ) + { + System.out.println("Interceptor.queryDispatch('"+aURL.Complete+"', '"+sTargetFrameName+"', "+nSearchFlags+") called"); + + if (impl_isBlockedURL(aURL.Complete)) + { + System.out.println("Interceptor.queryDispatch(): URL blocked => returns NULL"); + return null; + } + + if (m_xSlave != null) + { + System.out.println("Interceptor.queryDispatch(): ask slave ..."); + return m_xSlave.queryDispatch(aURL, sTargetFrameName, nSearchFlags); + } + + System.out.println("Interceptor.queryDispatch(): no idea => returns this"); + return this; + } + + // ____________________ + + /** XDispatchProvider + */ + public XDispatch[] queryDispatches(DispatchDescriptor[] lRequests) + { + int i = 0; + int c = lRequests.length; + + XDispatch[] lResults = new XDispatch[c]; + for (i=0; i<c; ++i) + { + lResults[i] = queryDispatch(lRequests[i].FeatureURL , + lRequests[i].FrameName , + lRequests[i].SearchFlags); + } + + return lResults; + } + + // ____________________ + + /** XDispatch + */ + public synchronized void dispatch(URL aURL , + PropertyValue[] lArguments) + { + System.out.println("Interceptor.dispatch('"+aURL.Complete+"') called"); + } + + // ____________________ + + /** XDispatch + */ + public synchronized void addStatusListener(XStatusListener xListener, + com.sun.star.util.URL aURL ) + { + System.out.println("Interceptor.addStatusListener(..., '"+aURL.Complete+"') called"); + } + + // ____________________ + + /** XDispatch + */ + public synchronized void removeStatusListener(XStatusListener xListener, + com.sun.star.util.URL aURL ) + { + System.out.println("Interceptor.removeStatusListener(..., '"+aURL.Complete+"') called"); + } + + // ____________________ + + public synchronized int getRegistrationCount() + { + return m_nRegistrationCount; + } + + // ____________________ + + public synchronized boolean isRegistered() + { + return m_bIsRegistered; + } + + // ____________________ + + /** set a new list of URL's, which should be used on registration time + (that's why it's neccessary to call this impl-method before the interceptor + is used at the OOo API!) to optimize the interception chain. + */ + public synchronized void setURLs4InterceptionInfo(String[] lURLs) + { + m_lURLs4InterceptionInfo = lURLs; + } + + // ____________________ + + /** set a new list of URL's, which should be blocked by this interceptor. + (that's why it's neccessary to call this impl-method before the interceptor + is used at the OOo API!) + */ + public synchronized void setURLs4URLs4Blocking(String[] lURLs) + { + m_lURLs4Blocking = lURLs; + } + + // ____________________ + + /** must be used internal to access the member m_lURLs4InterceptionInfo + - threadsafe + - and to make sure it's initialized on demand + */ + private synchronized String[] impl_getURLs4InterceptionInfo() + { + if (m_lURLs4InterceptionInfo == null) + { + m_lURLs4InterceptionInfo = new String[1]; + m_lURLs4InterceptionInfo[0] = "*"; + } + + return m_lURLs4InterceptionInfo; + } + + // ____________________ + + /** must be used internal to access the member m_lURLs4Blocking + - threadsafe + - and to make sure it's initialized on demand + */ + private synchronized String[] impl_getURLs4Blocking() + { + if (m_lURLs4Blocking == null) + { + m_lURLs4Blocking = new String[1]; + m_lURLs4Blocking[0] = "*"; + } + + return m_lURLs4Blocking; + } + + // ____________________ + private boolean impl_isBlockedURL(String sURL) + { + String[] lBlockedURLs = impl_getURLs4Blocking(); + int i = 0; + int c = lBlockedURLs.length; + + for (i=0; i<c; ++i) + { + if (impl_match(sURL, lBlockedURLs[i])) + { + return true; + } + } + + return false; + } + + // ____________________ + + private boolean impl_match(String sVal1, String sVal2) + { + // TODO implement wildcard match + return (sVal1.equals(sVal2)); + } +} diff --git a/framework/qa/complex/dispatches/checkdispatchapi.java b/framework/qa/complex/dispatches/checkdispatchapi.java new file mode 100644 index 000000000000..b0ba4b55da75 --- /dev/null +++ b/framework/qa/complex/dispatches/checkdispatchapi.java @@ -0,0 +1,498 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +package complex.dispatches; + +import com.sun.star.beans.PropertyValue; +import com.sun.star.frame.DispatchInformation; +import com.sun.star.frame.XComponentLoader; +import com.sun.star.frame.XDispatchInformationProvider; +import com.sun.star.frame.XDispatchProviderInterception; +import com.sun.star.frame.XDispatchProviderInterceptor; +import com.sun.star.frame.XFrame; +import com.sun.star.lang.XComponent; +import com.sun.star.lang.XMultiServiceFactory; +import com.sun.star.uno.UnoRuntime; +import com.sun.star.util.XCloseable; +import complex.dispatches.Interceptor; +import java.util.HashMap; + + + + + +// ---------- junit imports ----------------- +import org.junit.After; +import org.junit.AfterClass; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.openoffice.test.OfficeConnection; +import static org.junit.Assert.*; +// ------------------------------------------ + +//----------------------------------------------- +/** @short Check the interface XDispatchInformationProvider + +@descr Because there exists more then one implementation of a dispatch +object, we have to test all these implementations ... + */ +public class checkdispatchapi +{ + //------------------------------------------- + // some const + + //------------------------------------------- + // member + /** points to the global uno service manager. */ + private XMultiServiceFactory m_xMSF = null; + private connectivity.tools.HsqlDatabase db; + /** can be used to create new test frames. */ + private XFrame m_xDesktop = null; + /** provides XDispatchInformationProvider interface. */ + private XFrame m_xFrame = null; + + //------------------------------------------- + // test environment + //------------------------------------------- + /** @short A function to tell the framework, + which test functions are available. + + @return All test methods. + @todo Think about selection of tests from outside ... + */ +// public String[] getTestMethodNames() +// { +// return new String[] +// { +// "checkDispatchInfoOfWriter", +// "checkDispatchInfoOfCalc", +// "checkDispatchInfoOfDraw", +// "checkDispatchInfoOfImpress", +// "checkDispatchInfoOfMath", +// "checkDispatchInfoOfChart", +// "checkDispatchInfoOfBibliography", +// "checkDispatchInfoOfQueryDesign", +// "checkDispatchInfoOfTableDesign", +// "checkDispatchInfoOfFormGridView", +// "checkDispatchInfoOfDataSourceBrowser", +// "checkDispatchInfoOfRelationDesign", +// "checkDispatchInfoOfBasic", +// "checkDispatchInfoOfStartModule", +// "checkInterceptorLifeTime", +// "checkInterception" +// }; +// } + + //------------------------------------------- + /** @short Create the environment for following tests. + + @descr create an empty test frame, where we can load + different components inside. + */ + @Before public void before() + { + try + { + // get uno service manager from global test environment + m_xMSF = getMSF(); + + db = new connectivity.tools.HsqlDatabase(m_xMSF); + + // create desktop + m_xDesktop = UnoRuntime.queryInterface(XFrame.class, m_xMSF.createInstance("com.sun.star.frame.Desktop")); + + m_xFrame = impl_createNewFrame(); + } + catch (java.lang.Throwable ex) + { + fail("Cant initialize test environment."); + } + } + + //------------------------------------------- + /** @short close the environment. + */ + @After public void after() + { + db.close(); + impl_closeFrame(m_xFrame); + m_xFrame = null; + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfWriter() + { + impl_checkDispatchInfoOfXXX("private:factory/swriter"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfCalc() + { + impl_checkDispatchInfoOfXXX("private:factory/scalc"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfDraw() + { + impl_checkDispatchInfoOfXXX("private:factory/sdraw"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfImpress() + { + impl_checkDispatchInfoOfXXX("private:factory/simpress"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfChart() + { + impl_checkDispatchInfoOfXXX("private:factory/schart"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfMath() + { + impl_checkDispatchInfoOfXXX("private:factory/smath"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfDataBase() + { + impl_checkDispatchInfoOfXXX("private:factory/sdatabase"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfBibliography() + { + impl_checkDispatchInfoOfXXX(".component:Bibliography/View1"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfQueryDesign() + { + callDatabaseDispatch(".component:DB/QueryDesign"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfTableDesign() + { + callDatabaseDispatch(".component:DB/TableDesign"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfFormGridView() + { + impl_checkDispatchInfoOfXXX(".component:DB/FormGridView"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfDataSourceBrowser() + { + impl_checkDispatchInfoOfXXX(".component:DB/DataSourceBrowser"); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfRelationDesign() + { + callDatabaseDispatch(".component:DB/RelationDesign"); + } + //------------------------------------------- + + private void callDatabaseDispatch(String url) + { + try + { + final PropertyValue args = new PropertyValue(); + args.Name = "ActiveConnection"; + args.Value = (Object) db.defaultConnection(); + + XFrame xFrame = impl_createNewFrame(); + + impl_loadIntoFrame(xFrame, url, new PropertyValue[] + { + args + }); + impl_checkDispatchInfo(xFrame); + impl_closeFrame(xFrame); + } + catch (java.lang.Exception e) + { + } + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfBasic() + { + Object aComponent = impl_createUNOComponent("com.sun.star.script.BasicIDE"); + impl_checkDispatchInfo(aComponent); + } + + //------------------------------------------- + @Test public void checkDispatchInfoOfStartModule() + { + Object aComponent = impl_createUNOComponent("com.sun.star.frame.StartModule"); + impl_checkDispatchInfo(aComponent); + } + + //------------------------------------------- + public void checkInterceptorLifeTime() + { + // Note: It's important for the following test, that aInterceptor will be hold alive by the uno reference + // xInterceptor. Otherwhise we cant check some internal states of aInterceptor at the end of this method, because + // it was already killed .-) + + Interceptor aInterceptor = new Interceptor(); + XDispatchProviderInterceptor xInterceptor = UnoRuntime.queryInterface(XDispatchProviderInterceptor.class, aInterceptor); + + XFrame xFrame = impl_createNewFrame(); + XDispatchProviderInterception xInterception = UnoRuntime.queryInterface(XDispatchProviderInterception.class, xFrame); + + xInterception.registerDispatchProviderInterceptor(xInterceptor); + impl_closeFrame(xFrame); + + int nRegCount = aInterceptor.getRegistrationCount(); + boolean bIsRegistered = aInterceptor.isRegistered(); + + System.out.println("registration count = " + nRegCount); + System.out.println("is registered ? = " + bIsRegistered); + + if (nRegCount < 1) + { + fail("Interceptor was never registered."); + } + + if (bIsRegistered) + { + fail("Interceptor was not deregistered automaticly on closing the corresponding frame."); + } + + System.out.println("Destruction of interception chain works as designed .-)"); + } + + //------------------------------------------- + public void checkInterception() + { + String[] lDisabledURLs = new String[1]; + lDisabledURLs[0] = ".uno:Open"; + + System.out.println("create and initialize interceptor ..."); + Interceptor aInterceptor = new Interceptor(); + aInterceptor.setURLs4URLs4Blocking(lDisabledURLs); + + XDispatchProviderInterceptor xInterceptor = UnoRuntime.queryInterface(XDispatchProviderInterceptor.class, aInterceptor); + + System.out.println("create and initialize frame ..."); + XFrame xFrame = impl_createNewFrame(); + impl_loadIntoFrame(xFrame, "private:factory/swriter", null); + + XDispatchProviderInterception xInterception = UnoRuntime.queryInterface(XDispatchProviderInterception.class, xFrame); + + System.out.println("register interceptor ..."); + xInterception.registerDispatchProviderInterceptor(xInterceptor); + + System.out.println("deregister interceptor ..."); + xInterception.releaseDispatchProviderInterceptor(xInterceptor); + } + + //------------------------------------------- + private void impl_checkDispatchInfoOfXXX(String sXXX) + { + XFrame xFrame = impl_createNewFrame(); + impl_loadIntoFrame(xFrame, sXXX, null); + impl_checkDispatchInfo(xFrame); + impl_closeFrame(xFrame); + } + + //------------------------------------------- + /** @short load an URL into the current test frame. + */ + private void impl_loadIntoFrame(XFrame xFrame, String sURL, PropertyValue args[]) + { + XComponentLoader xLoader = UnoRuntime.queryInterface(XComponentLoader.class, xFrame); + if (xLoader == null) + { + fail("Frame does not provide required interface XComponentLoader."); + } + + XComponent xDoc = null; + try + { + xDoc = xLoader.loadComponentFromURL(sURL, "_self", 0, args); + } + catch (java.lang.Throwable ex) + { + xDoc = null; + } + + if (xDoc == null) + { + fail("Could not load \"" + sURL + "\"."); + } + } + + //------------------------------------------- + /** @short create an uno implementation directly. + */ + private Object impl_createUNOComponent(String sName) + { + Object aComponent = null; + try + { + aComponent = m_xMSF.createInstance(sName); + } + catch (java.lang.Throwable ex) + { + aComponent = null; + } + + if (aComponent == null) + { + fail("Could not create UNO component \"" + sName + "\"."); + } + return aComponent; + } + + //------------------------------------------- + /** @short check the interface XDispatchInformationProvider + at the specified component. + */ + private void impl_checkDispatchInfo(Object aComponent) + { + XDispatchInformationProvider xInfoProvider = UnoRuntime.queryInterface(XDispatchInformationProvider.class, aComponent); + if (xInfoProvider == null) + { + // Warning + System.out.println("Warning:\tComponent does not provide the [optional!] interface XDispatchInformationProvider."); + return; + } + + try + { + short[] lGroups = xInfoProvider.getSupportedCommandGroups(); + int c1 = lGroups.length; + int i1 = 0; + for (i1 = 0; i1 < c1; ++i1) + { + short nGroup = lGroups[i1]; + DispatchInformation[] lInfos = xInfoProvider.getConfigurableDispatchInformation(nGroup); + int c2 = lInfos.length; + int i2 = 0; + + // check for empty lists + // Warning + if (lInfos.length < 1) + { + System.out.println("Warning:\tCould not get any DispatchInformation for group [" + nGroup + "]."); + } + + // check for duplicates (and by the way, if the info item match the requested group) + HashMap aCheckMap = new HashMap(c2); + for (i2 = 0; i2 < c2; ++i2) + { + DispatchInformation aInfo = lInfos[i2]; + if (aInfo.GroupId != nGroup) + { + // Error + fail("At least one DispatchInformation item does not match the requested group.\n\trequested group=[" + nGroup + + "] returned groupd=[" + aInfo.GroupId + "] command=\"" + aInfo.Command + "\""); // true => dont break this test + continue; + } + + if (aCheckMap.containsKey(aInfo.Command)) + { + // Error + fail("Found a duplicate item: group=[" + aInfo.GroupId + "] command=\"" + aInfo.Command + "\""); // true => dont break this test + continue; + } + + aCheckMap.put(aInfo.Command, aInfo.Command); + System.out.println("\t[" + aInfo.GroupId + "] \"" + aInfo.Command + "\""); + } + } + } + catch (java.lang.Throwable ex) + { + fail("Exception caught during using XDispatchInformationProvider."); + // ex.printStackTrace(); + } + } + + //------------------------------------------- + private synchronized XFrame impl_createNewFrame() + { + XFrame xFrame = null; + + try + { + xFrame = m_xDesktop.findFrame("_blank", 0); + xFrame.getContainerWindow().setVisible(true); + } + catch (java.lang.Throwable ex) + { + fail("Could not create the frame instance."); + } + + return xFrame; + } + + //------------------------------------------- + private synchronized void impl_closeFrame(XFrame xFrame) + { + XCloseable xClose = UnoRuntime.queryInterface(XCloseable.class, xFrame); + try + { + xClose.close(false); + } + catch (com.sun.star.util.CloseVetoException exVeto) + { + fail("Test frame couldn't be closed successfully."); + } + } + + private XMultiServiceFactory getMSF() + { + final XMultiServiceFactory xMSF1 = UnoRuntime.queryInterface(XMultiServiceFactory.class, connection.getComponentContext().getServiceManager()); + return xMSF1; + } + + // setup and close connections + @BeforeClass + public static void setUpConnection() throws Exception + { + System.out.println("setUpConnection()"); + connection.setUp(); + } + + @AfterClass + public static void tearDownConnection() + throws InterruptedException, com.sun.star.uno.Exception + { + System.out.println("tearDownConnection()"); + connection.tearDown(); + } + private static final OfficeConnection connection = new OfficeConnection(); +} |