Related tdf#168623 Fix renaming empty Java/BeanShell libraries

The base script provider in Java for several languages was throwing an exception when trying to rename an empty library. The browsenodes member variable was being lazily created when getChildNodes was called but in the case where there were no children it was being left as null which was causing a Java runtime exception. Change-Id: I0d9eac2006bc26d47c22f2e1a7a4424fd67a512f Reviewed-on: https://gerrit.libreoffice.org/c/core/+/207152 Tested-by: Jenkins Reviewed-by: Neil Roberts <nroberts@libreoffice.org>
2026-06-23 08:16:16 +02:00
parent 766a4bfb86
commit 58efdfd898
4 changed files with 219 additions and 4 deletions
@@ -0,0 +1,50 @@
+# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t; fill-column: 100 -*-
+#
+# This file is part of the LibreOffice project.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+
+$(eval $(call gb_CppunitTest_CppunitTest,scripting_beanshell))
+
+$(eval $(call gb_CppunitTest_add_exception_objects,scripting_beanshell, \
+    scripting/qa/cppunit/beanshell/beanshelltest \
+))
+
+$(eval $(call gb_CppunitTest_use_libraries,scripting_beanshell, \
+    cppu \
+    cppuhelper \
+    jvmfwk \
+    sal \
+    subsequenttest \
+    test \
+    unotest \
+    utl \
+    tl \
+))
+
+$(eval $(call gb_CppunitTest_use_externals,scripting_beanshell,\
+    boost_headers \
+    libxml2 \
+))
+
+$(eval $(call gb_CppunitTest_use_api,scripting_beanshell,\
+    udkapi \
+    offapi \
+))
+
+$(eval $(call gb_CppunitTest_use_jars,scripting_beanshell, \
+    ScriptProviderForBeanShell \
+))
+
+$(eval $(call gb_CppunitTest_use_ure,scripting_beanshell))
+$(eval $(call gb_CppunitTest_use_vcl,scripting_beanshell))
+$(eval $(call gb_CppunitTest_use_rdbs,scripting_beanshell, \
+    services \
+    scriptproviderforbeanshell \
+))
+$(eval $(call gb_CppunitTest_use_configuration,scripting_beanshell))
+
+# vim: set noet sw=4 ts=4:
@@ -49,6 +49,7 @@ $(eval $(call gb_Module_add_targets,scripting,\

 $(eval $(call gb_Module_add_check_targets,scripting,\
    $(if $(ENABLE_QUICKJS),CppunitTest_scripting_jsprov) \
+    $(if $(ENABLE_SCRIPTING_BEANSHELL),CppunitTest_scripting_beanshell) \
 ))

 endif
@@ -267,11 +267,13 @@ public class ParcelBrowseNode extends PropertySet implements
                    getChildNodes();
                }

-                ScriptBrowseNode[] childNodes =
-                    browsenodes.toArray(new ScriptBrowseNode[browsenodes.size()]);
+                if (browsenodes != null) {
+                    ScriptBrowseNode[] childNodes =
+                        browsenodes.toArray(new ScriptBrowseNode[browsenodes.size()]);

-                for (int index = 0; index < childNodes.length; index++) {
-                    childNodes[ index ].updateURI(p);
+                    for (int index = 0; index < childNodes.length; index++) {
+                        childNodes[ index ].updateURI(p);
+                  }
                }

                result = new Any(new Type(XBrowseNode.class), this);
@@ -0,0 +1,162 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <sal/config.h>
+
+#include <test/unoapi_test.hxx>
+
+#include <com/sun/star/beans/XPropertySet.hpp>
+#include <com/sun/star/script/browse/XBrowseNode.hpp>
+#include <com/sun/star/script/XInvocation.hpp>
+#include <com/sun/star/ucb/UniversalContentBroker.hpp>
+
+namespace
+{
+class BeanShellTest : public UnoApiTest
+{
+public:
+    BeanShellTest()
+        : UnoApiTest(u"/scripting/qa/extras"_ustr)
+    {
+    }
+
+    void setUp() override;
+
+private:
+    void testRenameEmptyLibrary();
+    void testRenameNonEmptyLibrary();
+
+    CPPUNIT_TEST_SUITE(BeanShellTest);
+    CPPUNIT_TEST(testRenameEmptyLibrary);
+    CPPUNIT_TEST(testRenameNonEmptyLibrary);
+    CPPUNIT_TEST_SUITE_END();
+};
+
+void BeanShellTest::setUp()
+{
+    UnoApiTest::setUp();
+
+    // The ExpandContentProvider is needed for ScriptURIHelper to work
+    css::uno::Reference<css::ucb::XUniversalContentBroker> xUcb
+        = css::ucb::UniversalContentBroker::create(m_xContext);
+    css::uno::Reference<css::ucb::XContentProvider> xExpandProvider(
+        m_xSFactory->createInstance(u"com.sun.star.ucb.ExpandContentProvider"_ustr),
+        css::uno::UNO_QUERY_THROW);
+    xUcb->registerContentProvider(xExpandProvider, u"vnd.sun.star.expand"_ustr, true);
+}
+
+void createChild(css::uno::Reference<css::script::XInvocation>& xInvocation, const OUString& sName)
+{
+    css::uno::Sequence<css::uno::Any> aArgs = { css::uno::Any(sName) };
+    css::uno::Sequence<sal_Int16> aOutParamIndex;
+    css::uno::Sequence<css::uno::Any> aOutParam;
+    xInvocation->invoke("Creatable", aArgs, aOutParamIndex, aOutParam);
+}
+
+void renameLibrary(css::uno::Reference<css::script::XInvocation>& xInvocation,
+                   const OUString& sName)
+{
+    css::uno::Sequence<css::uno::Any> aArgs = { css::uno::Any(sName) };
+    css::uno::Sequence<sal_Int16> aOutParamIndex;
+    css::uno::Sequence<css::uno::Any> aOutParam;
+    css::uno::Any xResult = xInvocation->invoke("Renamable", aArgs, aOutParamIndex, aOutParam);
+
+    css::uno::Reference<css::script::XInvocation> xRenamedInvocation;
+    CPPUNIT_ASSERT(xResult >>= xRenamedInvocation);
+    CPPUNIT_ASSERT_EQUAL(xInvocation, xRenamedInvocation);
+}
+
+css::uno::Reference<css::script::browse::XBrowseNode>
+findChild(const css::uno::Reference<css::script::browse::XBrowseNode>& xParent,
+          std::u16string_view sName)
+{
+    for (const auto& xChild : xParent->getChildNodes())
+    {
+        if (xChild->getName() == sName)
+            return xChild;
+    }
+
+    OString sError
+        = OUStringToOString(Concat2View(u"Couldn’t find "_ustr + sName), RTL_TEXTENCODING_UTF8);
+    CPPUNIT_FAIL(sError.getStr());
+}
+
+void BeanShellTest::testRenameEmptyLibrary()
+{
+    css::uno::Sequence<css::uno::Any> aArgs = { css::uno::Any(u"user"_ustr) };
+
+    css::uno::Reference<css::script::browse::XBrowseNode> xRoot(
+        m_xFactory->createInstanceWithArgumentsAndContext(
+            u"com.sun.star.script.provider.ScriptProviderForBeanShell"_ustr, aArgs, m_xContext),
+        css::uno::UNO_QUERY_THROW);
+
+    css::uno::Reference<css::script::XInvocation> xInvocation(xRoot, css::uno::UNO_QUERY_THROW);
+
+    // Create an empty library
+    createChild(xInvocation, "EmptyLibrary");
+
+    // Make sure the library we just created exists in the hierarchy
+    css::uno::Reference<css::script::XInvocation> xEmptyLibrary(findChild(xRoot, u"EmptyLibrary"),
+                                                                css::uno::UNO_QUERY_THROW);
+
+    // Try renaming it
+    renameLibrary(xEmptyLibrary, "RenamedEmptyLibrary");
+
+    // Make sure it now exists in the hierarchy with the new name
+    findChild(xRoot, u"RenamedEmptyLibrary");
+}
+
+void BeanShellTest::testRenameNonEmptyLibrary()
+{
+    css::uno::Sequence<css::uno::Any> aArgs = { css::uno::Any(u"user"_ustr) };
+
+    css::uno::Reference<css::script::browse::XBrowseNode> xRoot(
+        m_xFactory->createInstanceWithArgumentsAndContext(
+            u"com.sun.star.script.provider.ScriptProviderForBeanShell"_ustr, aArgs, m_xContext),
+        css::uno::UNO_QUERY_THROW);
+
+    css::uno::Reference<css::script::XInvocation> xInvocation(xRoot, css::uno::UNO_QUERY_THROW);
+
+    // Create an empty library
+    createChild(xInvocation, "NonEmptyLibrary");
+
+    // Make sure the library we just created exists in the hierarchy
+    css::uno::Reference<css::script::XInvocation> xNewLibrary(findChild(xRoot, u"NonEmptyLibrary"),
+                                                              css::uno::UNO_QUERY_THROW);
+
+    // Create a script within the new library
+    createChild(xNewLibrary, "SomeScript");
+
+    // Try renaming the library
+    renameLibrary(xNewLibrary, "RenamedNonEmptyLibrary");
+
+    // Make sure it now exists in the hierarchy with the new name
+    css::uno::Reference<css::script::browse::XBrowseNode> xNewNode
+        = findChild(xRoot, u"RenamedNonEmptyLibrary");
+
+    // Make sure it still has the child
+    css::uno::Sequence<css::uno::Reference<css::script::browse::XBrowseNode>> xChildren
+        = xNewNode->getChildNodes();
+    CPPUNIT_ASSERT_EQUAL(sal_Int32(1), xChildren.getLength());
+    CPPUNIT_ASSERT_EQUAL(u"SomeScript.bsh"_ustr, xChildren[0]->getName());
+
+    // Make sure the child has an updated URI
+    css::uno::Reference<css::beans::XPropertySet> xChildProps(xChildren[0],
+                                                              css::uno::UNO_QUERY_THROW);
+    OUString sUri;
+    CPPUNIT_ASSERT(xChildProps->getPropertyValue("URI") >>= sUri);
+    CPPUNIT_ASSERT(sUri.indexOf("RenamedNonEmptyLibrary") != -1);
+}
+
+CPPUNIT_TEST_SUITE_REGISTRATION(BeanShellTest);
+
+} // namespace
+CPPUNIT_PLUGIN_IMPLEMENT();
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */