sfx2/source/appl/sfxpicklist.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 <comphelper/lok.hxx>
  21 #include <comphelper/base64.hxx>
  22 #include <com/sun/star/document/XDocumentProperties.hpp>
  23 #include <unotools/historyoptions.hxx>
  24 #include <unotools/useroptions.hxx>
  25 #include <tools/datetime.hxx>
  26 #include <tools/urlobj.hxx>
  27 #include <svl/inethist.hxx>
  28 #include <vcl/gdimtf.hxx>
  29 #include <vcl/pngwrite.hxx>
  30 #include <vcl/svapp.hxx>
  31 #include <officecfg/Office/Common.hxx>
  32
  33
  34 #include <sfx2/app.hxx>
  35 #include <sfxpicklist.hxx>
  36 #include <sfx2/sfxsids.hrc>
  37 #include <sfx2/event.hxx>
  38 #include <sfx2/objsh.hxx>
  39 #include <sfx2/docfile.hxx>
  40 #include <openurlhint.hxx>
  41 #include <sfx2/docfilt.hxx>
  42 #include <sfx2/viewfrm.hxx>
  43
  44 #include <rtl/instance.hxx>
  45
  46
  47 using namespace ::com::sun::star::uno;
  48 using namespace ::com::sun::star::beans;
  49 using namespace ::com::sun::star::util;
  50
  51
  52 namespace
  53 {
  54     class thePickListMutex
  55         : public rtl::Static<osl::Mutex, thePickListMutex> {};
  56 }
  57
  58 class SfxPickListImpl : public SfxListener
  59 {
  60     /**
  61      * Adds the given document to the pick list (recent documents) if it satisfies
  62        certain requirements, e.g. being writable. Check implementation for requirement
  63        details.
  64      */
  65     static void         AddDocumentToPickList( const SfxObjectShell* pDocShell );
  66
  67 public:
  68     SfxPickListImpl(SfxApplication& rApp);
  69     virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
  70 };
  71
  72 void SfxPickListImpl::AddDocumentToPickList( const SfxObjectShell* pDocSh )
  73 {
  74     if (pDocSh->IsAvoidRecentDocs() || comphelper::LibreOfficeKit::isActive())
  75         return;
  76
  77     SfxMedium *pMed = pDocSh->GetMedium();
  78     if( !pMed )
  79         return;
  80
  81     // Unnamed Documents and embedded-Documents not in Picklist
  82     if ( !pDocSh->HasName() ||
  83             SfxObjectCreateMode::STANDARD != pDocSh->GetCreateMode() )
  84         return;
  85
  86     // Help not in History
  87     INetURLObject aURL( pDocSh->IsDocShared() ? pDocSh->GetSharedFileURL() : pMed->GetOrigURL() );
  88     if ( aURL.GetProtocol() == INetProtocol::VndSunStarHelp )
  89         return;
  90
  91     // add no document that forbids this
  92     if ( !pMed->IsUpdatePickList() )
  93         return;
  94
  95     // ignore hidden documents
  96     if ( !SfxViewFrame::GetFirst( pDocSh ) )
  97         return;
  98
  99     OUString  aTitle = pDocSh->GetTitle(SFX_TITLE_PICKLIST);
 100     OUString  aFilter;
 101     std::shared_ptr<const SfxFilter> pFilter = pMed->GetFilter();
 102     if ( pFilter )
 103         aFilter = pFilter->GetFilterName();
 104
 105     std::optional<OUString> aThumbnail;
 106
 107     // generate the thumbnail
 108     //fdo#74834: only generate thumbnail for history if the corresponding option is not disabled in the configuration
 109     if (!pDocSh->IsModified() && !Application::IsHeadlessModeEnabled() &&
 110             officecfg::Office::Common::History::RecentDocsThumbnail::get())
 111     {
 112         // not modified => the document matches what is in the shell
 113         const SfxUnoAnyItem* pEncryptionDataItem = SfxItemSet::GetItem<SfxUnoAnyItem>(pMed->GetItemSet(), SID_ENCRYPTIONDATA, false);
 114         if ( pEncryptionDataItem )
 115         {
 116             // encrypted document, will show a generic document icon instead
 117             aThumbnail = OUString();
 118         }
 119         else
 120         {
 121             BitmapEx aResultBitmap = pDocSh->GetPreviewBitmap();
 122             if (!aResultBitmap.IsEmpty())
 123             {
 124                 SvMemoryStream aStream(65535, 65535);
 125                 vcl::PNGWriter aWriter(aResultBitmap);
 126                 if (aWriter.Write(aStream))
 127                 {
 128                     Sequence<sal_Int8> aSequence(static_cast<const sal_Int8*>(aStream.GetData()), aStream.Tell());
 129                     OUStringBuffer aBuffer;
 130                     ::comphelper::Base64::encode(aBuffer, aSequence);
 131                     aThumbnail = aBuffer.makeStringAndClear();
 132                 }
 133             }
 134         }
 135     }
 136
 137     // add to svtool history options
 138     SvtHistoryOptions().AppendItem( ePICKLIST,
 139             aURL.GetURLNoPass( INetURLObject::DecodeMechanism::NONE ),
 140             aFilter,
 141             aTitle,
 142             aThumbnail);
 143
 144     if ( aURL.GetProtocol() == INetProtocol::File )
 145         Application::AddToRecentDocumentList( aURL.GetURLNoPass( INetURLObject::DecodeMechanism::NONE ),
 146                                                                  pFilter ? pFilter->GetMimeType() : OUString(),
 147                                                                  pFilter ? pFilter->GetServiceName() : OUString() );
 148 }
 149
 150 SfxPickList::SfxPickList(SfxApplication& rApp)
 151     : mxImpl(new SfxPickListImpl(rApp))
 152 {
 153 }
 154
 155 SfxPickList::~SfxPickList()
 156 {
 157 }
 158
 159 SfxPickListImpl::SfxPickListImpl(SfxApplication& rApp)
 160 {
 161     StartListening(rApp);
 162 }
 163
 164 void SfxPickListImpl::Notify( SfxBroadcaster&, const SfxHint& rHint )
 165 {
 166     const SfxOpenUrlHint* pOpenUrlHint = dynamic_cast<const SfxOpenUrlHint*>(&rHint);
 167     if ( pOpenUrlHint )
 168     {
 169         INetURLHistory::GetOrCreate()->PutUrl( INetURLObject( pOpenUrlHint->GetDocumentURL() ));
 170     }
 171
 172     const SfxEventHint* pEventHint = dynamic_cast<const SfxEventHint*>(&rHint);
 173     if ( !pEventHint )
 174         return;
 175
 176     // only ObjectShell-related events with media interest
 177     SfxObjectShell* pDocSh = pEventHint->GetObjShell();
 178     if( !pDocSh )
 179         return;
 180
 181     switch ( pEventHint->GetEventId() )
 182     {
 183         case SfxEventHintId::CreateDoc:
 184         {
 185             bool bAllowModif = pDocSh->IsEnableSetModified();
 186             if ( bAllowModif )
 187                 pDocSh->EnableSetModified( false );
 188
 189             using namespace ::com::sun::star;
 190             uno::Reference<document::XDocumentProperties> xDocProps(
 191                 pDocSh->getDocProperties());
 192             if (xDocProps.is()) {
 193                 xDocProps->setAuthor( SvtUserOptions().GetFullName() );
 194                 ::DateTime now( ::DateTime::SYSTEM );
 195                 xDocProps->setCreationDate( now.GetUNODateTime() );
 196             }
 197
 198             if ( bAllowModif )
 199                 pDocSh->EnableSetModified( bAllowModif );
 200         }
 201         break;
 202
 203         case SfxEventHintId::OpenDoc:
 204         case SfxEventHintId::SaveDocDone:
 205         case SfxEventHintId::SaveAsDocDone:
 206         case SfxEventHintId::SaveToDocDone:
 207         case SfxEventHintId::CloseDoc:
 208         {
 209             AddDocumentToPickList(pDocSh);
 210         }
 211         break;
 212
 213         case SfxEventHintId::SaveAsDoc:
 214         {
 215             SfxMedium *pMedium = pDocSh->GetMedium();
 216             if (!pMedium)
 217                 return;
 218
 219             // We're starting a "Save As". Add the current document (if it's
 220             // not a "new" document) to the "Recent Documents" list before we
 221             // switch to the new path.
 222             // If the current document is new, path will be empty.
 223             OUString path = pMedium->GetOrigURL();
 224             if (!path.isEmpty())
 225             {
 226                 AddDocumentToPickList(pDocSh);
 227             }
 228         }
 229         break;
 230         default: break;
 231     }
 232 }
 233
 234 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */