vcl/source/app/session.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 <memory>
  21 #include "sal/config.h"
  22
  23 #include <cppuhelper/basemutex.hxx>
  24 #include <cppuhelper/compbase.hxx>
  25
  26
  27 #include <vcl/svapp.hxx>
  28
  29 #include <factory.hxx>
  30 #include <svdata.hxx>
  31 #include <salinst.hxx>
  32 #include <salsession.hxx>
  33
  34 #include <com/sun/star/frame/XSessionManagerClient.hpp>
  35 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  36 #include <com/sun/star/frame/XSessionManagerListener2.hpp>
  37
  38 #include <list>
  39
  40 using namespace com::sun::star::uno;
  41 using namespace com::sun::star::lang;
  42 using namespace com::sun::star::frame;
  43
  44 SalSession::~SalSession()
  45 {
  46 }
  47
  48 class VCLSession:
  49     private cppu::BaseMutex,
  50     public cppu::WeakComponentImplHelper < XSessionManagerClient >
  51 {
  52     struct Listener
  53     {
  54         css::uno::Reference< XSessionManagerListener >      m_xListener;
  55         bool                                        m_bInteractionRequested;
  56         bool                                        m_bInteractionDone;
  57         bool                                        m_bSaveDone;
  58
  59         explicit Listener( const css::uno::Reference< XSessionManagerListener >& xListener )
  60                 : m_xListener( xListener ),
  61                   m_bInteractionRequested( false ),
  62                   m_bInteractionDone( false ),
  63                   m_bSaveDone( false )
  64         {}
  65     };
  66
  67     std::list< Listener >                           m_aListeners;
  68     std::unique_ptr< SalSession >                   m_xSession;
  69     bool                                            m_bInteractionRequested;
  70     bool                                            m_bInteractionGranted;
  71     bool                                            m_bInteractionDone;
  72     bool                                            m_bSaveDone;
  73
  74     static void SalSessionEventProc( void* pData, SalSessionEvent* pEvent );
  75
  76     virtual ~VCLSession() override {}
  77
  78     virtual void SAL_CALL addSessionManagerListener( const css::uno::Reference< XSessionManagerListener >& xListener ) override;
  79     virtual void SAL_CALL removeSessionManagerListener( const css::uno::Reference< XSessionManagerListener>& xListener ) override;
  80     virtual void SAL_CALL queryInteraction( const css::uno::Reference< XSessionManagerListener >& xListener ) override;
  81     virtual void SAL_CALL interactionDone( const css::uno::Reference< XSessionManagerListener >& xListener ) override;
  82     virtual void SAL_CALL saveDone( const css::uno::Reference< XSessionManagerListener >& xListener ) override;
  83     virtual sal_Bool SAL_CALL cancelShutdown() override;
  84
  85     void SAL_CALL disposing() override;
  86
  87     void callSaveRequested( bool bShutdown );
  88     void callShutdownCancelled();
  89     void callInteractionGranted( bool bGranted );
  90     void callQuit();
  91
  92 public:
  93     VCLSession();
  94 };
  95
  96 VCLSession::VCLSession()
  97         : cppu::WeakComponentImplHelper< XSessionManagerClient >( m_aMutex ),
  98           m_xSession( ImplGetSVData()->mpDefInst->CreateSalSession() ),
  99           m_bInteractionRequested( false ),
 100           m_bInteractionGranted( false ),
 101           m_bInteractionDone( false ),
 102           m_bSaveDone( false )
 103 {
 104     SAL_INFO("vcl.se", "VCLSession::VCLSession" );
 105
 106     if (m_xSession)
 107         m_xSession->SetCallback( SalSessionEventProc, this );
 108 }
 109
 110 void VCLSession::callSaveRequested( bool bShutdown )
 111 {
 112     SAL_INFO("vcl.se", "VCLSession::callSaveRequested" );
 113
 114     std::list< Listener > aListeners;
 115     {
 116         osl::MutexGuard aGuard( m_aMutex );
 117         // reset listener states
 118         for( std::list< Listener >::iterator it = m_aListeners.begin();
 119              it != m_aListeners.end(); ++it )
 120         {
 121             it->m_bSaveDone = it->m_bInteractionRequested = it->m_bInteractionDone = false;
 122         }
 123
 124         // copy listener list since calling a listener may remove it.
 125         aListeners = m_aListeners;
 126         // set back interaction state
 127         m_bSaveDone = false;
 128         m_bInteractionDone = false;
 129         // without session we assume UI is always possible,
 130         // so it was requested and granted
 131         m_bInteractionRequested = m_bInteractionGranted = !m_xSession;
 132
 133         // answer the session manager even if no listeners available anymore
 134         SAL_WARN_IF(  aListeners.empty(), "vcl.se", "saveRequested but no listeners !" );
 135
 136         SAL_INFO("vcl.se.debug", "  aListeners.empty() = " << (aListeners.empty() ? "true" : "false") <<
 137                                  ", bShutdown = " << (bShutdown ? "true" : "false"));
 138         if( aListeners.empty() )
 139         {
 140             if (m_xSession)
 141                 m_xSession->saveDone();
 142             return;
 143         }
 144     }
 145
 146     SolarMutexReleaser aReleaser;
 147     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 148         it->m_xListener->doSave( bShutdown, false/*bCancelable*/ );
 149 }
 150
 151 void VCLSession::callInteractionGranted( bool bInteractionGranted )
 152 {
 153     SAL_INFO("vcl.se", "VCLSession::callInteractionGranted" );
 154
 155     std::list< Listener > aListeners;
 156     {
 157         osl::MutexGuard aGuard( m_aMutex );
 158         // copy listener list since calling a listener may remove it.
 159         for( std::list< Listener >::const_iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 160             if( it->m_bInteractionRequested )
 161                 aListeners.push_back( *it );
 162
 163         m_bInteractionGranted = bInteractionGranted;
 164
 165         // answer the session manager even if no listeners available anymore
 166         SAL_WARN_IF(  aListeners.empty(), "vcl.se", "interactionGranted but no listeners !" );
 167
 168         SAL_INFO("vcl.se.debug", "  aListeners.empty() = " << (aListeners.empty() ? "true" : "false") <<
 169                                  ", bInteractionGranted = " << (bInteractionGranted ? "true" : "false"));
 170         if( aListeners.empty() )
 171         {
 172             if (m_xSession)
 173                 m_xSession->interactionDone();
 174             return;
 175         }
 176     }
 177
 178     SolarMutexReleaser aReleaser;
 179     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 180         it->m_xListener->approveInteraction( bInteractionGranted );
 181 }
 182
 183 void VCLSession::callShutdownCancelled()
 184 {
 185     SAL_INFO("vcl.se", "VCLSession::callShutdownCancelled");
 186
 187     std::list< Listener > aListeners;
 188     {
 189         osl::MutexGuard aGuard( m_aMutex );
 190         // copy listener list since calling a listener may remove it.
 191         aListeners = m_aListeners;
 192         // set back interaction state
 193         m_bInteractionRequested = m_bInteractionDone = m_bInteractionGranted = false;
 194     }
 195
 196     SolarMutexReleaser aReleaser;
 197     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 198         it->m_xListener->shutdownCanceled();
 199 }
 200
 201 void VCLSession::callQuit()
 202 {
 203     SAL_INFO("vcl.se", "VCLSession::callQuit");
 204
 205     std::list< Listener > aListeners;
 206     {
 207         osl::MutexGuard aGuard( m_aMutex );
 208         // copy listener list since calling a listener may remove it.
 209         aListeners = m_aListeners;
 210         // set back interaction state
 211         m_bInteractionRequested = m_bInteractionDone = m_bInteractionGranted = false;
 212     }
 213
 214     SolarMutexReleaser aReleaser;
 215     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 216     {
 217         css::uno::Reference< XSessionManagerListener2 > xListener2( it->m_xListener, UNO_QUERY );
 218         if( xListener2.is() )
 219             xListener2->doQuit();
 220     }
 221 }
 222
 223 void VCLSession::SalSessionEventProc( void* pData, SalSessionEvent* pEvent )
 224 {
 225     SAL_INFO("vcl.se", "VCLSession::SalSessionEventProc");
 226
 227     VCLSession * pThis = static_cast< VCLSession * >( pData );
 228     switch( pEvent->m_eType )
 229     {
 230         case Interaction:
 231         {
 232             SAL_INFO("vcl.se.debug", "  EventProcType = Interaction");
 233             SalSessionInteractionEvent* pIEv = static_cast<SalSessionInteractionEvent*>(pEvent);
 234             pThis->callInteractionGranted( pIEv->m_bInteractionGranted );
 235         }
 236         break;
 237         case SaveRequest:
 238         {
 239             SAL_INFO("vcl.se.debug", "  EventProcType = SaveRequest");
 240             SalSessionSaveRequestEvent* pSEv = static_cast<SalSessionSaveRequestEvent*>(pEvent);
 241             pThis->callSaveRequested( pSEv->m_bShutdown );
 242         }
 243         break;
 244         case ShutdownCancel:
 245             SAL_INFO("vcl.se.debug", "  EventProcType = ShutdownCancel");
 246             pThis->callShutdownCancelled();
 247             break;
 248         case Quit:
 249             SAL_INFO("vcl.se.debug", "  EventProcType = Quit");
 250             pThis->callQuit();
 251             break;
 252     }
 253 }
 254
 255 void SAL_CALL VCLSession::addSessionManagerListener( const css::uno::Reference<XSessionManagerListener>& xListener )
 256 {
 257     SAL_INFO("vcl.se", "VCLSession::addSessionManagerListener" );
 258
 259     osl::MutexGuard aGuard( m_aMutex );
 260
 261     SAL_INFO("vcl.se.debug", "  m_aListeners.size() = " << m_aListeners.size() );
 262     m_aListeners.push_back( Listener( xListener ) );
 263 }
 264
 265 void SAL_CALL VCLSession::removeSessionManagerListener( const css::uno::Reference<XSessionManagerListener>& xListener )
 266 {
 267     SAL_INFO("vcl.se", "VCLSession::removeSessionManagerListener" );
 268
 269     osl::MutexGuard aGuard( m_aMutex );
 270
 271     std::list< Listener >::iterator it = m_aListeners.begin();
 272
 273     SAL_INFO("vcl.se.debug", "  m_aListeners.size() = " << m_aListeners.size() );
 274     while( it != m_aListeners.end() )
 275     {
 276         if( it->m_xListener == xListener )
 277         {
 278             it = m_aListeners.erase(it);
 279         }
 280         else
 281             ++it;
 282     }
 283 }
 284
 285 void SAL_CALL VCLSession::queryInteraction( const css::uno::Reference<XSessionManagerListener>& xListener )
 286 {
 287     SAL_INFO("vcl.se", "VCLSession::queryInteraction");
 288
 289     SAL_INFO("vcl.se.debug", "  m_bInteractionGranted = " << (m_bInteractionGranted ? "true" : "false") <<
 290                              ", m_bInteractionRequested = "<< (m_bInteractionRequested ? "true" : "false"));
 291     if( m_bInteractionGranted )
 292     {
 293         if( m_bInteractionDone )
 294             xListener->approveInteraction( false );
 295         else
 296             xListener->approveInteraction( true );
 297         return;
 298     }
 299
 300     osl::MutexGuard aGuard( m_aMutex );
 301     if( ! m_bInteractionRequested )
 302     {
 303         m_xSession->queryInteraction();
 304         m_bInteractionRequested = true;
 305     }
 306     for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 307     {
 308         if( it->m_xListener == xListener )
 309         {
 310             SAL_INFO("vcl.se.debug", "  it->m_xListener == xListener");
 311             it->m_bInteractionRequested = true;
 312             it->m_bInteractionDone      = false;
 313         }
 314     }
 315 }
 316
 317 void SAL_CALL VCLSession::interactionDone( const css::uno::Reference< XSessionManagerListener >& xListener )
 318 {
 319     SAL_INFO("vcl.se", "VCLSession::interactionDone");
 320
 321     osl::MutexGuard aGuard( m_aMutex );
 322     int nRequested = 0, nDone = 0;
 323     for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 324     {
 325         if( it->m_bInteractionRequested )
 326         {
 327             nRequested++;
 328             if( xListener == it->m_xListener )
 329                 it->m_bInteractionDone = true;
 330         }
 331         if( it->m_bInteractionDone )
 332             nDone++;
 333     }
 334
 335     SAL_INFO("vcl.se.debug", "  nDone = " << nDone <<
 336                              ", nRequested =" << nRequested);
 337     if( nDone == nRequested && nDone > 0 )
 338     {
 339         m_bInteractionDone = true;
 340         if (m_xSession)
 341             m_xSession->interactionDone();
 342     }
 343 }
 344
 345 void SAL_CALL VCLSession::saveDone( const css::uno::Reference< XSessionManagerListener >& xListener )
 346 {
 347     SAL_INFO("vcl.se", "VCLSession::saveDone");
 348
 349     osl::MutexGuard aGuard( m_aMutex );
 350
 351     bool bSaveDone = true;
 352     for( std::list< Listener >::iterator it = m_aListeners.begin();
 353          it != m_aListeners.end(); ++it )
 354     {
 355         if( it->m_xListener == xListener )
 356             it->m_bSaveDone = true;
 357         if( ! it->m_bSaveDone )
 358             bSaveDone = false;
 359     }
 360
 361     SAL_INFO("vcl.se.debug", "  bSaveDone = " << (bSaveDone ? "true" : "false"));
 362
 363     if( bSaveDone && !m_bSaveDone )
 364     {
 365         m_bSaveDone = true;
 366         if (m_xSession)
 367             m_xSession->saveDone();
 368     }
 369 }
 370
 371 sal_Bool SAL_CALL VCLSession::cancelShutdown()
 372 {
 373     SAL_INFO("vcl.se", "VCLSession::cancelShutdown");
 374
 375     return m_xSession && m_xSession->cancelShutdown();
 376 }
 377
 378 void VCLSession::disposing() {
 379     SAL_INFO("vcl.se", "VCLSession::disposing");
 380
 381     std::list<Listener> list;
 382     {
 383         osl::MutexGuard g(m_aMutex);
 384         list.swap(m_aListeners);
 385     }
 386     css::lang::EventObject src(static_cast<OWeakObject *>(this));
 387     for (auto const & i: list) {
 388         try {
 389             i.m_xListener->disposing(src);
 390             SAL_INFO("vcl.se.debug", "  call Listener disposing");
 391         } catch (css::uno::RuntimeException & e) {
 392             SAL_WARN("vcl.se", "ignoring RuntimeException " << e.Message);
 393         }
 394     }
 395 }
 396
 397 // service implementation
 398
 399 OUString SAL_CALL vcl_session_getImplementationName()
 400 {
 401     SAL_INFO("vcl.se", "vcl_session_getImplementationName");
 402
 403     return OUString( "com.sun.star.frame.VCLSessionManagerClient" );
 404 }
 405
 406 Sequence< OUString > SAL_CALL vcl_session_getSupportedServiceNames()
 407 {
 408     SAL_INFO("vcl.se", "vcl_session_getSupportedServiceNames");
 409
 410     Sequence< OUString > aRet { "com.sun.star.frame.SessionManagerClient" };
 411     return aRet;
 412 }
 413
 414 css::uno::Reference< XInterface > SAL_CALL vcl_session_createInstance( SAL_UNUSED_PARAMETER const css::uno::Reference< XMultiServiceFactory > & )
 415 {
 416     SAL_INFO("vcl.se", "vcl_session_createInstance");
 417
 418     return static_cast< cppu::OWeakObject * >(new VCLSession);
 419 }
 420
 421 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */