From b54d0d262bbafbc08efd1cbc93af61b786f89821 Mon Sep 17 00:00:00 2001 From: Samuel Mehrbrodt Date: Mon, 14 Mar 2022 10:04:17 +0100 Subject: Add UNO API for custom Jump Lists Allows adding custom jump list categories to Windows Task Bar Change-Id: I13b6c3ad5de386cf74e2b346f10889bc46a8ad4e --- Repository.mk | 1 + include/sal/log-areas.dox | 1 + offapi/UnoApi_offapi.mk | 7 + offapi/com/sun/star/system/windows/JumpList.idl | 33 +++ .../com/sun/star/system/windows/JumpListItem.idl | 45 ++++ offapi/com/sun/star/system/windows/XJumpList.idl | 88 +++++++ shell/Library_jumplist.mk | 37 +++ shell/Module_shell.mk | 1 + shell/source/win32/jumplist/JumpList.cxx | 290 +++++++++++++++++++++ shell/source/win32/jumplist/jumplist.component | 17 ++ 10 files changed, 520 insertions(+) create mode 100755 offapi/com/sun/star/system/windows/JumpList.idl create mode 100755 offapi/com/sun/star/system/windows/JumpListItem.idl create mode 100755 offapi/com/sun/star/system/windows/XJumpList.idl create mode 100755 shell/Library_jumplist.mk create mode 100755 shell/source/win32/jumplist/JumpList.cxx create mode 100755 shell/source/win32/jumplist/jumplist.component diff --git a/Repository.mk b/Repository.mk index 639c0db413eb..49a46b454409 100644 --- a/Repository.mk +++ b/Repository.mk @@ -391,6 +391,7 @@ $(eval $(call gb_Helper_register_libraries_for_install,OOOLIBS,ooo, \ hyphen \ icg \ $(if $(ENABLE_JAVA),jdbc) \ + jumplist \ $(if $(ENABLE_LDAP),ldapbe2) \ $(if $(filter WNT,$(OS)),WinUserInfoBe) \ localebe1 \ diff --git a/include/sal/log-areas.dox b/include/sal/log-areas.dox index 9a0c43587bc9..40575f96e69a 100644 --- a/include/sal/log-areas.dox +++ b/include/sal/log-areas.dox @@ -625,6 +625,7 @@ certain functionality. @li @c scripting @li @c scripting.provider @li @c shell +@li @c shell.jumplist @li @c stoc @li @c store @li @c svg diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk index c86e7d5a7800..aa85f3a525e9 100644 --- a/offapi/UnoApi_offapi.mk +++ b/offapi/UnoApi_offapi.mk @@ -3621,6 +3621,13 @@ $(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/system,\ XSimpleMailMessage2 \ XSystemShellExecute \ )) + +$(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/system/windows,\ + JumpList \ + JumpListItem \ + XJumpList \ +)) + $(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/table,\ BorderLine \ BorderLine2 \ diff --git a/offapi/com/sun/star/system/windows/JumpList.idl b/offapi/com/sun/star/system/windows/JumpList.idl new file mode 100755 index 000000000000..82becd522b69 --- /dev/null +++ b/offapi/com/sun/star/system/windows/JumpList.idl @@ -0,0 +1,33 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_system_windows_JumpList_idl__ +#define __com_sun_star_system_windows_JumpList_idl__ + + +module com { module sun { module star { module system { module windows { + + +interface XJumpList; + +/** Specifies a Jump List service. Allows to add custom commands to the Windows Jump List. + + @since LibreOffice 7.4 + + @see com::sun::star::system::windows::XJumpList +*/ + +service JumpList : XJumpList; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/offapi/com/sun/star/system/windows/JumpListItem.idl b/offapi/com/sun/star/system/windows/JumpListItem.idl new file mode 100755 index 000000000000..310e5551911a --- /dev/null +++ b/offapi/com/sun/star/system/windows/JumpListItem.idl @@ -0,0 +1,45 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_system_windows_JumpListItem_idl__ +#define __com_sun_star_system_windows_JumpListItem_idl__ + +#include +#include +#include + + +module com { module sun { module star { module system { module windows { + +/** Specifies an item for com::sun::star::system::windows::XJumpList . + + @since LibreOffice 7.4 +*/ + +struct JumpListItem +{ + /** Item name. Appears in the JumpList. Has to be unique per category. */ + string name; + + /** Item description, appears as tooltip */ + string description; + + /** Arguments to be passed to LibreOffice. + This can be a file to be loaded, or any command line parameter supported by LibreOffice, and any combination of the two. */ + string arguments; + + /** Icon to be displayed along the name. This should be a local path name like `C:\path\to\icon` */ + string iconPath; +}; + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/offapi/com/sun/star/system/windows/XJumpList.idl b/offapi/com/sun/star/system/windows/XJumpList.idl new file mode 100755 index 000000000000..c483149e5dd8 --- /dev/null +++ b/offapi/com/sun/star/system/windows/XJumpList.idl @@ -0,0 +1,88 @@ +/* -*- 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/. + */ + +#ifndef __com_sun_star_system_windows_XJumpList_idl__ +#define __com_sun_star_system_windows_XJumpList_idl__ + +#include +#include +#include + + +module com { module sun { module star { module system { module windows { + +/** Specifies an interface for adding custom jump lists to the task bar (Windows only) + + @since LibreOffice 7.4 +*/ +interface XJumpList: com::sun::star::uno::XInterface +{ + /** Add a jump list category + + @param category + Specifies the category name. It will appear as the title of the custom jump list. + + @param jumpListItems + Specifies a list of com::sun::star::system::JumpListItem. + These will be added as entries below the category name in the custom jump list. + Make sure you don't add items which the user has removed before + (check the result of `getRemovedItems` before updating a category). + + @param application + Used to map the jump list to the correct application. Use one of the following values: +
    +
  • Writer
    • +
  • Calc
    • +
  • Impress
    • +
  • Draw
    • +
  • Math
    • +
  • Base
    • +
  • Startcenter
    • +
+ + "Startcenter" will map to the generic "LibreOffice" icon. + + @throws com::sun::star::lang::IllegalArgumentException + When an empty category name, or an invalid application name is given. + */ + void appendCategory( [in] string category, + [in] sequence jumpListItems, + [in] string application ) + raises( ::com::sun::star::lang::IllegalArgumentException ); + + /** Returns items that were removed from the jump list by the user. + + `appendCategory` will fail if you try to reinsert an item which was removed by the user before. + Use this method to learn which items were removed by the user. + + @param application + Used to map the jump list to the correct application. Use one of the following values: +
    +
  • Writer
    • +
  • Calc
    • +
  • Impress
    • +
  • Draw
    • +
  • Math
    • +
  • Base
    • +
  • Startcenter
    • +
+ + "Startcenter" will map to the generic "LibreOffice" icon. + + @return List of removed items. + */ + sequence getRemovedItems([in] string application); +}; + + +}; }; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/shell/Library_jumplist.mk b/shell/Library_jumplist.mk new file mode 100755 index 000000000000..943fabdd4080 --- /dev/null +++ b/shell/Library_jumplist.mk @@ -0,0 +1,37 @@ +# -*- 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_Library_Library,jumplist)) + +$(eval $(call gb_Library_use_sdk_api,jumplist)) + +$(eval $(call gb_Library_use_libraries,jumplist,\ + comphelper \ + cppu \ + cppuhelper \ + sal \ +)) + +ifeq ($(OS),WNT) + +$(eval $(call gb_Library_use_system_win32_libs,jumplist,\ + ole32 \ + Propsys \ + shell32 \ +)) + +$(eval $(call gb_Library_set_componentfile,jumplist,shell/source/win32/jumplist/jumplist,services)) + +$(eval $(call gb_Library_add_exception_objects,jumplist,\ + shell/source/win32/jumplist/JumpList \ +)) + +endif # OS + +# vim: set noet sw=4 ts=4: diff --git a/shell/Module_shell.mk b/shell/Module_shell.mk index c0c42cc5bea5..b955ecbf695c 100644 --- a/shell/Module_shell.mk +++ b/shell/Module_shell.mk @@ -43,6 +43,7 @@ $(eval $(call gb_Module_add_targets,shell,\ Executable_senddoc \ Library_smplmail \ Library_wininetbe \ + Library_jumplist \ Executable_spsupp_helper \ )) diff --git a/shell/source/win32/jumplist/JumpList.cxx b/shell/source/win32/jumplist/JumpList.cxx new file mode 100755 index 000000000000..74874c8bc53e --- /dev/null +++ b/shell/source/win32/jumplist/JumpList.cxx @@ -0,0 +1,290 @@ +/* -*- 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 + +#include +#include + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +using namespace comphelper; +using namespace cppu; +using namespace css; +using namespace css::uno; +using namespace css::lang; +using namespace css::system::windows; +using namespace osl; + +using sal::systools::COMReference; +using sal::systools::COM_QUERY_THROW; +using sal::systools::ComError; +using sal::systools::ThrowIfFailed; + +class JumpListImpl : public WeakComponentImplHelper +{ + Reference m_xContext; + Mutex m_aMutex; + +public: + explicit JumpListImpl(const Reference& xContext); + ~JumpListImpl(); + + // XJumpList + virtual void SAL_CALL appendCategory(const OUString& sCategory, + const Sequence& aJumpListItems, + const OUString& sDocumentService) override; + virtual Sequence + SAL_CALL getRemovedItems(const OUString& sDocumentService) override; + + // XServiceInfo + virtual OUString SAL_CALL getImplementationName() override; + virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override; + virtual Sequence SAL_CALL getSupportedServiceNames() override; +}; + +JumpListImpl::JumpListImpl(const Reference& xContext) + : WeakComponentImplHelper(m_aMutex) + , m_xContext(xContext) +{ +} + +JumpListImpl::~JumpListImpl() {} + +void SAL_CALL JumpListImpl::appendCategory(const OUString& sCategory, + const Sequence& aJumpListItems, + const OUString& sApplication) +{ + if (sCategory.isEmpty()) + { + throw IllegalArgumentException("Parameter 'category' must not be empty", + static_cast(this), 1); + } + if (sApplication != "Writer" && sApplication != "Calc" && sApplication != "Impress" + && sApplication != "Draw" && sApplication != "Math" && sApplication != "Base" + && sApplication != "Startcenter") + { + throw IllegalArgumentException( + "Parameter 'application' must be one of 'Writer', 'Calc', 'Impress', 'Draw', " + "'Math', 'Base', 'Startcenter'.", + static_cast(this), 1); + } + OUString sApplicationID("TheDocumentFoundation.LibreOffice." + sApplication); + + try + { + COMReference aDestinationList; + CoCreateInstance(CLSID_DestinationList, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&aDestinationList)); + + aDestinationList->SetAppID(o3tl::toW(sApplicationID.getStr())); + + UINT min_slots; + COMReference removed; + ThrowIfFailed(aDestinationList->BeginList(&min_slots, IID_PPV_ARGS(&removed)), + "BeginList failed"); + + OUString sofficeURL; + OUString sofficePath; + oslProcessError err = osl_getExecutableFile(&sofficeURL.pData); + FileBase::getSystemPathFromFileURL(sofficeURL, sofficePath); + if (err != osl_Process_E_None) + { + SAL_WARN("shell.jumplist", "osl_getExecutableFile failed"); + return; + } + // We need to run soffice.exe, not soffice.bin + sofficePath = sofficePath.replaceFirst("soffice.bin", "soffice.exe"); + + COMReference aCollection; + CoCreateInstance(CLSID_EnumerableObjectCollection, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&aCollection)); + + for (auto item : aJumpListItems) + { + if (item.name.isEmpty()) + continue; + try + { + COMReference pShellLinkItem; + CoCreateInstance(CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&pShellLinkItem)); + + { + COMReference pps(pShellLinkItem, COM_QUERY_THROW); + + PROPVARIANT propvar; + sal::systools::ThrowIfFailed( + InitPropVariantFromString(o3tl::toW(item.name.getStr()), &propvar), + "InitPropVariantFromString failed."); + + ThrowIfFailed(pps->SetValue(PKEY_Title, propvar), "SetValue failed."); + + ThrowIfFailed(pps->Commit(), "Commit failed."); + + PropVariantClear(&propvar); + } + ThrowIfFailed( + pShellLinkItem->SetDescription(o3tl::toW(item.description.getStr())), + OString("Setting description '" + item.description.toUtf8() + "' failed.")); + + ThrowIfFailed(pShellLinkItem->SetPath(o3tl::toW(sofficePath.getStr())), + OString("Setting path '" + sofficePath.toUtf8() + "' failed.")); + + ThrowIfFailed( + pShellLinkItem->SetArguments(o3tl::toW(item.arguments.getStr())), + OString("Setting arguments '" + item.arguments.toUtf8() + "' failed.")); + + ThrowIfFailed( + pShellLinkItem->SetIconLocation(o3tl::toW(item.iconPath.getStr()), 0), + OString("Setting icon path '" + item.iconPath.toUtf8() + "' failed.")); + + aCollection->AddObject(pShellLinkItem.get()); + } + catch (const ComError& e) + { + SAL_WARN("shell.jumplist", e.what()); + continue; + } + } + + sal::systools::COMReference pObjectArray(aCollection, COM_QUERY_THROW); + ThrowIfFailed( + aDestinationList->AppendCategory(o3tl::toW(sCategory.getStr()), pObjectArray.get()), + "AppendCategory failed. You are not allowed to immediately re-insert entries which " + "were removed by the user. Please see the output of `getRemovedItems`."); + + ThrowIfFailed(aDestinationList->CommitList(), "CommitList failed."); + } + catch (const ComError& e) + { + SAL_WARN("shell.jumplist", e.what()); + } +} + +Sequence SAL_CALL JumpListImpl::getRemovedItems(const OUString& sApplication) +{ + if (sApplication != "Writer" && sApplication != "Calc" && sApplication != "Impress" + && sApplication != "Draw" && sApplication != "Math" && sApplication != "Base" + && sApplication != "Startcenter") + { + throw IllegalArgumentException( + "Parameter 'application' must be one of 'Writer', 'Calc', 'Impress', 'Draw', " + "'Math', 'Base', 'Startcenter'.", + static_cast(this), 1); + } + OUString sApplicationID("TheDocumentFoundation.LibreOffice." + sApplication); + + std::vector removedItems; + try + { + sal::systools::COMReference aDestinationList; + CoCreateInstance(CLSID_DestinationList, nullptr, CLSCTX_INPROC_SERVER, + IID_PPV_ARGS(&aDestinationList)); + + aDestinationList->SetAppID(o3tl::toW(sApplicationID.getStr())); + + sal::systools::COMReference removed; + ThrowIfFailed(aDestinationList->GetRemovedDestinations(IID_PPV_ARGS(&removed)), + "BeginList failed"); + + UINT removed_count; + if (SUCCEEDED(removed->GetCount(&removed_count) && (removed_count > 0))) + { + JumpListItem item; + sal::systools::COMReference pShellLinkItem; + for (UINT i = 0; i < removed_count; ++i) + { + if (SUCCEEDED(removed->GetAt(i, IID_PPV_ARGS(&pShellLinkItem)))) + { + sal::systools::COMReference propertyStore(pShellLinkItem, + COM_QUERY_THROW); + PROPVARIANT propvar; + ThrowIfFailed(propertyStore->GetValue(PKEY_Title, &propvar), + "GetValue failed."); + item.name = o3tl::toU(PropVariantToStringWithDefault(propvar, L"")); + + ThrowIfFailed(propertyStore->GetValue(PKEY_Link_Arguments, &propvar), + "GetValue failed."); + item.arguments = o3tl::toU(PropVariantToStringWithDefault(propvar, L"")); + PropVariantClear(&propvar); + + wchar_t itemDesc[MAX_PATH]; + ThrowIfFailed(pShellLinkItem->GetDescription( + itemDesc, std::extent::value), + "GetDescription failed."); + item.description = o3tl::toU(itemDesc); + + wchar_t path[MAX_PATH]; + int icon_index; + ThrowIfFailed(pShellLinkItem->GetIconLocation( + path, std::extent::value, &icon_index), + "GetIconLocation failed."); + item.iconPath = o3tl::toU(path); + + removedItems.emplace_back(item); + } + } + } + } + catch (const ComError& e) + { + SAL_WARN("shell.jumplist", e.what()); + } + + return containerToSequence(removedItems); +} + +// XServiceInfo + +OUString SAL_CALL JumpListImpl::getImplementationName() +{ + return "com.sun.star.system.windows.JumpListImpl"; +} + +sal_Bool SAL_CALL JumpListImpl::supportsService(const OUString& ServiceName) +{ + return cppu::supportsService(this, ServiceName); +} + +Sequence SAL_CALL JumpListImpl::getSupportedServiceNames() +{ + return { "com.sun.star.system.windows.JumpList" }; +} + +extern "C" SAL_DLLPUBLIC_EXPORT XInterface* +shell_JumpListExec_get_implementation(XComponentContext* context, Sequence const&) +{ + return acquire(new JumpListImpl(context)); +} + +/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */ diff --git a/shell/source/win32/jumplist/jumplist.component b/shell/source/win32/jumplist/jumplist.component new file mode 100755 index 000000000000..b6b6a9aa632d --- /dev/null +++ b/shell/source/win32/jumplist/jumplist.component @@ -0,0 +1,17 @@ + + + + + + + + -- cgit