framework/source/uielement/recentfilesmenucontroller.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <strings.hrc>
  21 #include <classes/fwkresid.hxx>
  22
  23 #include <comphelper/mimeconfighelper.hxx>
  24 #include <comphelper/processfactory.hxx>
  25 #include <comphelper/propertyvalue.hxx>
  26 #include <cppuhelper/supportsservice.hxx>
  27 #include <osl/mutex.hxx>
  28 #include <svtools/imagemgr.hxx>
  29 #include <svtools/popupmenucontrollerbase.hxx>
  30 #include <tools/urlobj.hxx>
  31 #include <toolkit/awt/vclxmenu.hxx>
  32 #include <unotools/historyoptions.hxx>
  33 #include <vcl/commandinfoprovider.hxx>
  34 #include <vcl/graph.hxx>
  35 #include <vcl/settings.hxx>
  36 #include <vcl/svapp.hxx>
  37 #include <o3tl/string_view.hxx>
  38
  39 #include <officecfg/Office/Common.hxx>
  40
  41 using namespace css;
  42 using namespace com::sun::star::uno;
  43 using namespace com::sun::star::lang;
  44 using namespace com::sun::star::frame;
  45 using namespace com::sun::star::beans;
  46 using namespace com::sun::star::util;
  47
  48 #define MAX_MENU_ITEMS  99
  49 #define MAX_MENU_ITEMS_PER_MODULE  5
  50
  51 namespace {
  52
  53 constexpr OUString CMD_CLEAR_LIST = u".uno:ClearRecentFileList"_ustr;
  54 constexpr OUString CMD_TOGGLE_CURRENTMODULE = u".uno:ToggleCurrentModule"_ustr;
  55 constexpr OUString CMD_OPEN_AS_TEMPLATE = u".uno:OpenTemplate"_ustr;
  56 constexpr OUString CMD_OPEN_REMOTE = u".uno:OpenRemote"_ustr;
  57
  58 class RecentFilesMenuController :  public svt::PopupMenuControllerBase
  59 {
  60     using svt::PopupMenuControllerBase::disposing;
  61
  62 public:
  63     RecentFilesMenuController( const uno::Reference< uno::XComponentContext >& xContext,
  64                                const uno::Sequence< uno::Any >& args );
  65
  66     // XServiceInfo
  67     virtual OUString SAL_CALL getImplementationName() override
  68     {
  69         return u"com.sun.star.comp.framework.RecentFilesMenuController"_ustr;
  70     }
  71
  72     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
  73     {
  74         return cppu::supportsService(this, ServiceName);
  75     }
  76
  77     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
  78     {
  79         return {u"com.sun.star.frame.PopupMenuController"_ustr};
  80     }
  81
  82     // XStatusListener
  83     virtual void SAL_CALL statusChanged( const frame::FeatureStateEvent& Event ) override;
  84
  85     // XMenuListener
  86     virtual void SAL_CALL itemSelected( const awt::MenuEvent& rEvent ) override;
  87     virtual void SAL_CALL itemActivated( const awt::MenuEvent& rEvent ) override;
  88
  89     // XDispatchProvider
  90     virtual uno::Reference< frame::XDispatch > SAL_CALL queryDispatch( const util::URL& aURL, const OUString& sTarget, sal_Int32 nFlags ) override;
  91
  92     // XDispatch
  93     virtual void SAL_CALL dispatch( const util::URL& aURL, const uno::Sequence< beans::PropertyValue >& seqProperties ) override;
  94
  95     // XEventListener
  96     virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
  97
  98 private:
  99     virtual void impl_setPopupMenu(std::unique_lock<std::mutex>& rGuard) override;
 100     void fillPopupMenu(std::unique_lock<std::mutex>& rGuard, css::uno::Reference<css::awt::XPopupMenu > const & rPopupMenu );
 101     void executeEntry( sal_Int32 nIndex );
 102     void executeEntryImpl(std::unique_lock<std::mutex>& rGuard, sal_Int32 nIndex);
 103
 104     std::vector<std::pair<OUString, bool>>   m_aRecentFilesItems;
 105     bool                      m_bDisabled : 1;
 106     bool                      m_bShowToolbarEntries;
 107 };
 108
 109 RecentFilesMenuController::RecentFilesMenuController( const uno::Reference< uno::XComponentContext >& xContext,
 110                                                       const uno::Sequence< uno::Any >& args ) :
 111     svt::PopupMenuControllerBase( xContext ),
 112     m_bDisabled( false ),
 113     m_bShowToolbarEntries( false )
 114 {
 115     css::beans::PropertyValue aPropValue;
 116     for ( uno::Any const & arg : args )
 117     {
 118         arg >>= aPropValue;
 119         if ( aPropValue.Name == "InToolbar" )
 120         {
 121             aPropValue.Value >>= m_bShowToolbarEntries;
 122             break;
 123         }
 124     }
 125 }
 126
 127 void InsertItem(const css::uno::Reference<css::awt::XPopupMenu>& rPopupMenu,
 128                 const OUString& rCommand,
 129                 const css::uno::Reference<css::frame::XFrame>& rFrame)
 130 {
 131     sal_uInt16 nItemId = rPopupMenu->getItemCount() + 1;
 132
 133     if (rFrame.is())
 134     {
 135         OUString aModuleName(vcl::CommandInfoProvider::GetModuleIdentifier(rFrame));
 136         auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(rCommand, aModuleName);
 137         OUString aLabel(vcl::CommandInfoProvider::GetPopupLabelForCommand(aProperties));
 138         OUString aTooltip(vcl::CommandInfoProvider::GetTooltipForCommand(rCommand, aProperties, rFrame));
 139         css::uno::Reference<css::graphic::XGraphic> xGraphic(vcl::CommandInfoProvider::GetXGraphicForCommand(rCommand, rFrame));
 140
 141         rPopupMenu->insertItem(nItemId, aLabel, 0, -1);
 142         rPopupMenu->setItemImage(nItemId, xGraphic, false);
 143         rPopupMenu->setHelpText(nItemId, aTooltip);
 144     }
 145     else
 146         rPopupMenu->insertItem(nItemId, OUString(), 0, -1);
 147
 148     rPopupMenu->setCommand(nItemId, rCommand);
 149 }
 150
 151
 152 // private function
 153 void RecentFilesMenuController::fillPopupMenu(std::unique_lock<std::mutex>& /*rGuard*/, Reference<css::awt::XPopupMenu> const & rPopupMenu)
 154 {
 155     SolarMutexGuard aSolarMutexGuard;
 156
 157     resetPopupMenu( rPopupMenu );
 158
 159     std::vector< SvtHistoryOptions::HistoryItem > aHistoryList = SvtHistoryOptions::GetList( EHistoryType::PickList );
 160
 161     int nPickListMenuItems = std::min<sal_Int32>( aHistoryList.size(), MAX_MENU_ITEMS );
 162     m_aRecentFilesItems.clear();
 163
 164     // tdf#56696 - retrieve expert configuration option if the recent document
 165     // list should show only files that can be handled by the current module
 166     const bool bShowCurrentModuleOnly
 167         = officecfg::Office::Common::History::ShowCurrentModuleOnly::get();
 168
 169     size_t nItemPosModule = 0;
 170     size_t nItemPosPinned = 0;
 171     if (( nPickListMenuItems > 0 ) && !m_bDisabled )
 172     {
 173         size_t nItemPos = 0;
 174
 175         // tdf#155699 - create a lambda to insert a recent document item at a specified position
 176         auto insertHistoryItemAtPos =
 177             [&](const SvtHistoryOptions::HistoryItem& rPickListEntry, const size_t aInsertPosition)
 178         {
 179             m_aRecentFilesItems.insert(m_aRecentFilesItems.begin() + aInsertPosition,
 180                                        { rPickListEntry.sURL, rPickListEntry.isReadOnly });
 181             nItemPos++;
 182         };
 183
 184         if (m_aModuleName != "com.sun.star.frame.StartModule")
 185         {
 186             ::comphelper::MimeConfigurationHelper aConfigHelper(
 187                 comphelper::getProcessComponentContext());
 188
 189             // Show the first MAX_MENU_ITEMS_PER_MODULE items of the current module
 190             // on top of the recent document list.
 191             for (int i = 0; i < nPickListMenuItems; i++)
 192             {
 193                 const SvtHistoryOptions::HistoryItem& rPickListEntry = aHistoryList[i];
 194
 195                 // tdf#155699 - insert pinned document at the beginning of the list
 196                 if (rPickListEntry.isPinned)
 197                 {
 198                     insertHistoryItemAtPos(rPickListEntry, nItemPosPinned);
 199                     nItemPosPinned++;
 200                     nItemPosModule++;
 201                 }
 202                 // tdf#56696 - insert documents of the current module
 203                 else if ((bShowCurrentModuleOnly
 204                           || (nItemPosModule - nItemPosPinned) < MAX_MENU_ITEMS_PER_MODULE)
 205                          && aConfigHelper.GetDocServiceNameFromFilter(rPickListEntry.sFilter)
 206                                 == m_aModuleName)
 207                 {
 208                     insertHistoryItemAtPos(rPickListEntry, nItemPosModule);
 209                     nItemPosModule++;
 210                 }
 211                 // Insert all other documents at the end of the list if the expert option is not set
 212                 else if (!bShowCurrentModuleOnly)
 213                     insertHistoryItemAtPos(rPickListEntry, nItemPos);
 214             }
 215         }
 216         else
 217         {
 218             for (int i = 0; i < nPickListMenuItems; i++)
 219             {
 220                 const SvtHistoryOptions::HistoryItem& rPickListEntry = aHistoryList[i];
 221                 // tdf#155699 - insert pinned document at the beginning of the list
 222                 insertHistoryItemAtPos(rPickListEntry,
 223                                        rPickListEntry.isPinned ? nItemPosModule++ : nItemPos);
 224             }
 225         }
 226     }
 227
 228     if ( !m_aRecentFilesItems.empty() )
 229     {
 230         const sal_uInt32 nCount = m_aRecentFilesItems.size();
 231         StyleSettings aIconSettings;
 232         bool bIsIconsAllowed = aIconSettings.GetUseImagesInMenus();
 233
 234         for ( sal_uInt32 i = 0; i < nCount; i++ )
 235         {
 236
 237             OUStringBuffer aMenuShortCut;
 238             if ( i <= 9 )
 239             {
 240                 if ( i == 9 )
 241                     aMenuShortCut.append( "1~0. " );
 242                 else
 243                 {
 244                     aMenuShortCut.append( "~N. " );
 245                     aMenuShortCut[ 1 ] = sal_Unicode( i + '1' );
 246                 }
 247             }
 248             else
 249             {
 250                 aMenuShortCut.append( OUString::number(sal_Int32( i + 1 ) ) + ". " );
 251             }
 252
 253             OUString aURLString = "vnd.sun.star.popup:RecentFileList?entry=" + OUString::number(i);
 254
 255             // Abbreviate URL
 256             OUString   aMenuTitle;
 257             INetURLObject const aURL(m_aRecentFilesItems[i].first);
 258             OUString aTipHelpText( aURL.getFSysPath( FSysStyle::Detect ) );
 259
 260             if ( aURL.GetProtocol() == INetProtocol::File )
 261             {
 262                 // Do handle file URL differently: don't show the protocol, just the file name
 263                 aMenuTitle = aURL.GetLastName(INetURLObject::DecodeMechanism::WithCharset);
 264             }
 265             else
 266             {
 267                 // In all other URLs show the protocol name before the file name
 268                 aMenuTitle   = INetURLObject::GetSchemeName(aURL.GetProtocol()) + ": " + aURL.getName();
 269             }
 270
 271             aMenuShortCut.append( aMenuTitle );
 272
 273             rPopupMenu->insertItem(sal_uInt16( i+1 ), aMenuShortCut.makeStringAndClear(), 0, -1);
 274
 275             if ( bIsIconsAllowed ) {
 276                 // tdf#146219: don't use SvFileInformationManager::GetImageId,
 277                 // which needs to access the URL to detect if it's a directory
 278                 BitmapEx aThumbnail(SvFileInformationManager::GetFileImageId(aURL));
 279                 rPopupMenu->setItemImage(sal_uInt16(i + 1), Graphic(aThumbnail).GetXGraphic(), false);
 280             }
 281
 282             rPopupMenu->setTipHelpText(sal_uInt16(i + 1), aTipHelpText);
 283             rPopupMenu->setCommand(sal_uInt16(i + 1), aURLString);
 284
 285             // tdf#155699 - show a separator after the pinned recent document items
 286             if (nItemPosPinned > 0 && i == nItemPosPinned - 1)
 287                 rPopupMenu->insertSeparator(-1);
 288
 289             // Show a separator after the MAX_MENU_ITEMS_PER_MODULE recent document items
 290             if (nItemPosModule > 0 && i == nItemPosModule - 1)
 291                 rPopupMenu->insertSeparator(-1);
 292         }
 293
 294         rPopupMenu->insertSeparator(-1);
 295         // Clear List menu entry
 296         rPopupMenu->insertItem(sal_uInt16(nCount + 1), FwkResId(STR_CLEAR_RECENT_FILES), 0, -1);
 297         rPopupMenu->setCommand(sal_uInt16(nCount + 1), CMD_CLEAR_LIST);
 298         rPopupMenu->setHelpText(sal_uInt16(nCount + 1), FwkResId(STR_CLEAR_RECENT_FILES_HELP));
 299
 300         // Toggle current module only
 301         rPopupMenu->insertItem(sal_uInt16(nCount + 2), FwkResId(STR_TOGGLE_CURRENT_MODULE), 0, -1);
 302         rPopupMenu->checkItem(sal_uInt16(nCount + 2), bShowCurrentModuleOnly);
 303         rPopupMenu->setCommand(sal_uInt16(nCount + 2), CMD_TOGGLE_CURRENTMODULE);
 304         rPopupMenu->setHelpText(sal_uInt16(nCount + 2), FwkResId(STR_TOGGLE_CURRENT_MODULE_HELP));
 305
 306         // Open remote menu entry
 307         if ( m_bShowToolbarEntries )
 308         {
 309             rPopupMenu->insertSeparator(-1);
 310             InsertItem(rPopupMenu, CMD_OPEN_AS_TEMPLATE, m_xFrame);
 311             InsertItem(rPopupMenu, CMD_OPEN_REMOTE, m_xFrame);
 312         }
 313     }
 314     else
 315     {
 316         if ( m_bShowToolbarEntries )
 317         {
 318             InsertItem(rPopupMenu, CMD_OPEN_AS_TEMPLATE, m_xFrame);
 319             InsertItem(rPopupMenu, CMD_OPEN_REMOTE, m_xFrame);
 320         }
 321         else
 322         {
 323             // Add InsertSeparator(), otherwise it will display
 324             // the first item icon of recent files instead of displaying no icon.
 325             rPopupMenu->insertSeparator(-1);
 326             // No recent documents => insert "no documents" string
 327             // Do not disable it, otherwise the Toolbar controller and MenuButton
 328             // will display SV_RESID_STRING_NOSELECTIONPOSSIBLE instead of STR_NODOCUMENT
 329             rPopupMenu->insertItem(1, FwkResId(STR_NODOCUMENT), static_cast<sal_Int16>(MenuItemBits::NOSELECT), -1);
 330         }
 331     }
 332 }
 333
 334 void RecentFilesMenuController::executeEntryImpl(std::unique_lock<std::mutex>& rGuard, sal_Int32 nIndex)
 335 {
 336     if (( nIndex < 0 ) ||
 337         ( nIndex >= sal::static_int_cast<sal_Int32>( m_aRecentFilesItems.size() )))
 338         return;
 339
 340     Sequence< PropertyValue > aArgsList{
 341         comphelper::makePropertyValue(u"Referer"_ustr, u"private:user"_ustr),
 342
 343         // documents in the picklist will never be opened as templates
 344         comphelper::makePropertyValue(u"AsTemplate"_ustr, false),
 345
 346         // Type detection needs to know which app we are opening it from.
 347         comphelper::makePropertyValue(u"DocumentService"_ustr, m_aModuleName)
 348     };
 349     if (m_aRecentFilesItems[nIndex].second) // tdf#149170 only add if true
 350     {
 351         aArgsList.realloc(aArgsList.size()+1);
 352         aArgsList.getArray()[aArgsList.size()-1] = comphelper::makePropertyValue(u"ReadOnly"_ustr, true);
 353     }
 354     dispatchCommandImpl(rGuard, m_aRecentFilesItems[nIndex].first, aArgsList, u"_default"_ustr);
 355 }
 356
 357 void RecentFilesMenuController::executeEntry( sal_Int32 nIndex )
 358 {
 359     std::unique_lock aLock(m_aMutex);
 360     executeEntryImpl(aLock, nIndex);
 361 }
 362
 363 // XEventListener
 364 void SAL_CALL RecentFilesMenuController::disposing( const EventObject& )
 365 {
 366     Reference< css::awt::XMenuListener > xHolder(this);
 367
 368     std::unique_lock aLock( m_aMutex );
 369     m_xFrame.clear();
 370     m_xDispatch.clear();
 371
 372     if ( m_xPopupMenu.is() )
 373         m_xPopupMenu->removeMenuListener( Reference< css::awt::XMenuListener >(this) );
 374     m_xPopupMenu.clear();
 375 }
 376
 377 // XStatusListener
 378 void SAL_CALL RecentFilesMenuController::statusChanged( const FeatureStateEvent& Event )
 379 {
 380     std::unique_lock aLock( m_aMutex );
 381     m_bDisabled = !Event.IsEnabled;
 382 }
 383
 384 void SAL_CALL RecentFilesMenuController::itemSelected( const css::awt::MenuEvent& rEvent )
 385 {
 386     Reference< css::awt::XPopupMenu > xPopupMenu;
 387
 388     {
 389         std::unique_lock aLock(m_aMutex);
 390         xPopupMenu = m_xPopupMenu;
 391     }
 392
 393     if ( !xPopupMenu.is() )
 394         return;
 395
 396     const OUString aCommand( xPopupMenu->getCommand( rEvent.MenuId ) );
 397
 398     if ( aCommand == CMD_CLEAR_LIST )
 399     {
 400         SvtHistoryOptions::Clear( EHistoryType::PickList, false );
 401         dispatchCommand(
 402             u"vnd.org.libreoffice.recentdocs:ClearRecentFileList"_ustr,
 403             css::uno::Sequence< css::beans::PropertyValue >() );
 404     }
 405     if ( aCommand == CMD_TOGGLE_CURRENTMODULE )
 406     {
 407         bool bIsExclusive = officecfg::Office::Common::History::ShowCurrentModuleOnly::get();
 408         std::shared_ptr<comphelper::ConfigurationChanges> batch(comphelper::ConfigurationChanges::create());
 409         officecfg::Office::Common::History::ShowCurrentModuleOnly::set(!bIsExclusive, batch);
 410         batch->commit();
 411     }
 412     else if ( aCommand == CMD_OPEN_REMOTE )
 413     {
 414         Sequence< PropertyValue > aArgsList( 0 );
 415         dispatchCommand( CMD_OPEN_REMOTE, aArgsList );
 416     }
 417     else if ( aCommand == CMD_OPEN_AS_TEMPLATE )
 418     {
 419         Sequence< PropertyValue > aArgsList( 0 );
 420         dispatchCommand( CMD_OPEN_AS_TEMPLATE, aArgsList );
 421     }
 422     else
 423         executeEntry( rEvent.MenuId-1 );
 424 }
 425
 426 void SAL_CALL RecentFilesMenuController::itemActivated( const css::awt::MenuEvent& )
 427 {
 428     std::unique_lock aLock( m_aMutex );
 429     impl_setPopupMenu(aLock);
 430 }
 431
 432 // XPopupMenuController
 433 void RecentFilesMenuController::impl_setPopupMenu(std::unique_lock<std::mutex>& rGuard)
 434 {
 435     if ( m_xPopupMenu.is() )
 436         fillPopupMenu(rGuard, m_xPopupMenu);
 437 }
 438
 439 // XDispatchProvider
 440 Reference< XDispatch > SAL_CALL RecentFilesMenuController::queryDispatch(
 441     const URL& aURL,
 442     const OUString& /*sTarget*/,
 443     sal_Int32 /*nFlags*/ )
 444 {
 445     std::unique_lock aLock( m_aMutex );
 446
 447     throwIfDisposed(aLock);
 448
 449     if ( aURL.Complete.startsWith( m_aBaseURL ) )
 450         return Reference< XDispatch >( this );
 451     else
 452         return Reference< XDispatch >();
 453 }
 454
 455 // XDispatch
 456 void SAL_CALL RecentFilesMenuController::dispatch(
 457     const URL& aURL,
 458     const Sequence< PropertyValue >& /*seqProperties*/ )
 459 {
 460     std::unique_lock aLock( m_aMutex );
 461
 462     throwIfDisposed(aLock);
 463
 464     if ( !aURL.Complete.startsWith( m_aBaseURL ) )
 465         return;
 466
 467     // Parse URL to retrieve entry argument and its value
 468     sal_Int32 nQueryPart = aURL.Complete.indexOf( '?', m_aBaseURL.getLength() );
 469     if ( nQueryPart <= 0 )
 470         return;
 471
 472     static constexpr OUString aEntryArgStr( u"entry="_ustr );
 473     sal_Int32 nEntryArg = aURL.Complete.indexOf( aEntryArgStr, nQueryPart );
 474     sal_Int32 nEntryPos = nEntryArg + aEntryArgStr.getLength();
 475     if (( nEntryArg <= 0 ) || ( nEntryPos >= aURL.Complete.getLength() ))
 476         return;
 477
 478     sal_Int32 nAddArgs = aURL.Complete.indexOf( '&', nEntryPos );
 479     std::u16string_view aEntryArg;
 480
 481     if ( nAddArgs < 0 )
 482         aEntryArg = aURL.Complete.subView( nEntryPos );
 483     else
 484         aEntryArg = aURL.Complete.subView( nEntryPos, nAddArgs-nEntryPos );
 485
 486     sal_Int32 nEntry = o3tl::toInt32(aEntryArg);
 487     executeEntryImpl(aLock, nEntry);
 488 }
 489
 490 }
 491
 492 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 493 com_sun_star_comp_framework_RecentFilesMenuController_get_implementation(
 494     css::uno::XComponentContext *context,
 495     css::uno::Sequence<css::uno::Any> const &args)
 496 {
 497     return cppu::acquire(new RecentFilesMenuController(context, args));
 498 }
 499
 500 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */