vcl/source/app/session.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: session.cxx,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_vcl.hxx"
  33 #include <vcl/svapp.hxx>
  34 #include <vcl/svdata.hxx>
  35 #include <vcl/salinst.hxx>
  36 #include <vcl/salsession.hxx>
  37 #include <cppuhelper/compbase1.hxx>
  38 #include <tools/debug.hxx>
  39 #include <com/sun/star/frame/XSessionManagerClient.hpp>
  40 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  41
  42 #include <list>
  43
  44 using namespace com::sun::star::uno;
  45 using namespace com::sun::star::lang;
  46 using namespace com::sun::star::frame;
  47 using namespace rtl;
  48
  49 SalSession::~SalSession()
  50 {
  51 }
  52
  53 class VCLSession : public cppu::WeakComponentImplHelper1 < XSessionManagerClient >
  54 {
  55     struct Listener
  56     {
  57         Reference< XSessionManagerListener >            m_xListener;
  58         bool                                                                            m_bInteractionRequested;
  59         bool                                                                            m_bInteractionDone;
  60         bool                                                                            m_bSaveDone;
  61
  62         Listener( const Reference< XSessionManagerListener >& xListener )
  63                 : m_xListener( xListener ),
  64                   m_bInteractionRequested( false ),
  65                   m_bInteractionDone( false ),
  66                   m_bSaveDone( false )
  67         {}
  68     };
  69
  70     std::list< Listener >                                                       m_aListeners;
  71     SalSession*                                                                         m_pSession;
  72     osl::Mutex                                                                          m_aMutex;
  73     bool                                                                                        m_bInteractionRequested;
  74     bool                                                                                        m_bInteractionGranted;
  75     bool                                                                                        m_bInteractionDone;
  76     bool                                                                                        m_bSaveDone;
  77
  78     static void SalSessionEventProc( SalSessionEvent* pEvent );
  79     static VCLSession* pOneInstance;
  80
  81     void callSaveRequested( bool bShutdown, bool bCancelable );
  82     void callShutdownCancelled();
  83     void callInteractionGranted( bool bGranted );
  84 public:
  85     VCLSession();
  86     virtual ~VCLSession();
  87
  88     virtual void SAL_CALL addSessionManagerListener( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
  89     virtual void SAL_CALL removeSessionManagerListener( const Reference< XSessionManagerListener>& xListener ) throw( RuntimeException );
  90     virtual void SAL_CALL queryInteraction( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
  91     virtual void SAL_CALL interactionDone( const Reference< XSessionManagerListener >& xListener, sal_Bool bCancelShutdown ) throw( RuntimeException );
  92     virtual void SAL_CALL saveDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException );
  93 };
  94
  95 VCLSession* VCLSession::pOneInstance = NULL;
  96
  97 VCLSession::VCLSession()
  98         : cppu::WeakComponentImplHelper1< XSessionManagerClient >( m_aMutex ),
  99           m_bInteractionRequested( false ),
 100           m_bInteractionGranted( false ),
 101           m_bInteractionDone( false ),
 102           m_bSaveDone( false )
 103 {
 104     DBG_ASSERT( pOneInstance == 0, "One instance  of VCLSession only !" );
 105     pOneInstance = this;
 106     m_pSession = ImplGetSVData()->mpDefInst->CreateSalSession();
 107     if( m_pSession )
 108         m_pSession->SetCallback( SalSessionEventProc );
 109 }
 110
 111 VCLSession::~VCLSession()
 112 {
 113     DBG_ASSERT( pOneInstance == this, "Another instance of VCLSession in destructor !" );
 114     pOneInstance = NULL;
 115     delete m_pSession;
 116 }
 117
 118 void VCLSession::callSaveRequested( bool bShutdown, bool bCancelable )
 119 {
 120     std::list< Listener > aListeners;
 121     {
 122         osl::MutexGuard aGuard( m_aMutex );
 123         // reset listener states
 124         for( std::list< Listener >::iterator it = m_aListeners.begin();
 125              it != m_aListeners.end(); ++it )
 126         {
 127             it->m_bSaveDone = it->m_bInteractionRequested = it->m_bInteractionDone = false;
 128         }
 129
 130         // copy listener list since calling a listener may remove it.
 131         aListeners = m_aListeners;
 132         // set back interaction state
 133         m_bSaveDone = false;
 134         m_bInteractionDone = false;
 135         // without session we assume UI is always possible,
 136         // so it was reqeusted and granted
 137         m_bInteractionRequested = m_bInteractionGranted = m_pSession ? false : true;
 138
 139         // answer the session manager even if no listeners available anymore
 140         DBG_ASSERT( ! aListeners.empty(), "saveRequested but no listeners !" );
 141         if( aListeners.empty() )
 142         {
 143             if( m_pSession )
 144                 m_pSession->saveDone();
 145             return;
 146         }
 147     }
 148
 149     ULONG nAcquireCount = Application::ReleaseSolarMutex();
 150     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 151         it->m_xListener->doSave( bShutdown, bCancelable );
 152     Application::AcquireSolarMutex( nAcquireCount );
 153 }
 154
 155 void VCLSession::callInteractionGranted( bool bInteractionGranted )
 156 {
 157     std::list< Listener > aListeners;
 158     {
 159         osl::MutexGuard aGuard( m_aMutex );
 160         // copy listener list since calling a listener may remove it.
 161         for( std::list< Listener >::const_iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 162             if( it->m_bInteractionRequested )
 163                 aListeners.push_back( *it );
 164
 165         m_bInteractionGranted = bInteractionGranted;
 166
 167         // answer the session manager even if no listeners available anymore
 168         DBG_ASSERT( ! aListeners.empty(), "interactionGranted but no listeners !" );
 169         if( aListeners.empty() )
 170         {
 171             if( m_pSession )
 172                 m_pSession->interactionDone( false );
 173             return;
 174         }
 175     }
 176
 177     ULONG nAcquireCount = Application::ReleaseSolarMutex();
 178     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 179         it->m_xListener->approveInteraction( bInteractionGranted );
 180
 181     Application::AcquireSolarMutex( nAcquireCount );
 182 }
 183
 184 void VCLSession::callShutdownCancelled()
 185 {
 186     std::list< Listener > aListeners;
 187     {
 188         osl::MutexGuard aGuard( m_aMutex );
 189         // copy listener list since calling a listener may remove it.
 190         aListeners = m_aListeners;
 191         // set back interaction state
 192         m_bInteractionRequested = m_bInteractionDone = m_bInteractionGranted = false;
 193     }
 194
 195     ULONG nAcquireCount = Application::ReleaseSolarMutex();
 196     for( std::list< Listener >::const_iterator it = aListeners.begin(); it != aListeners.end(); ++it )
 197         it->m_xListener->shutdownCanceled();
 198     Application::AcquireSolarMutex( nAcquireCount );
 199 }
 200
 201 void VCLSession::SalSessionEventProc( SalSessionEvent* pEvent )
 202 {
 203     switch( pEvent->m_eType )
 204     {
 205         case Interaction:
 206         {
 207             SalSessionInteractionEvent* pIEv = static_cast<SalSessionInteractionEvent*>(pEvent);
 208             pOneInstance->callInteractionGranted( pIEv->m_bInteractionGranted );
 209         }
 210         break;
 211         case SaveRequest:
 212         {
 213             SalSessionSaveRequestEvent* pSEv = static_cast<SalSessionSaveRequestEvent*>(pEvent);
 214             pOneInstance->callSaveRequested( pSEv->m_bShutdown, pSEv->m_bCancelable );
 215         }
 216         break;
 217         case ShutdownCancel:
 218             pOneInstance->callShutdownCancelled();
 219             break;
 220     }
 221 }
 222
 223 void SAL_CALL VCLSession::addSessionManagerListener( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
 224 {
 225     osl::MutexGuard aGuard( m_aMutex );
 226
 227     m_aListeners.push_back( Listener( xListener ) );
 228 }
 229
 230 void SAL_CALL VCLSession::removeSessionManagerListener( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
 231 {
 232     osl::MutexGuard aGuard( m_aMutex );
 233
 234     std::list< Listener >::iterator it = m_aListeners.begin();
 235     while( it != m_aListeners.end() )
 236     {
 237         if( it->m_xListener == xListener )
 238         {
 239             m_aListeners.erase( it );
 240             it = m_aListeners.begin();
 241         }
 242         else
 243             ++it;
 244     }
 245 }
 246
 247 void SAL_CALL VCLSession::queryInteraction( const Reference<XSessionManagerListener>& xListener ) throw( RuntimeException )
 248 {
 249     if( m_bInteractionGranted )
 250     {
 251         if( m_bInteractionDone )
 252             xListener->approveInteraction( false );
 253         else
 254             xListener->approveInteraction( true );
 255         return;
 256     }
 257
 258     osl::MutexGuard aGuard( m_aMutex );
 259     if( ! m_bInteractionRequested )
 260     {
 261         m_pSession->queryInteraction();
 262         m_bInteractionRequested = true;
 263     }
 264     for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 265     {
 266         if( it->m_xListener == xListener )
 267         {
 268             it->m_bInteractionRequested = true;
 269             it->m_bInteractionDone              = false;
 270         }
 271     }
 272 }
 273
 274 void SAL_CALL VCLSession::interactionDone( const Reference< XSessionManagerListener >& xListener, sal_Bool bCancelShutdown ) throw( RuntimeException )
 275 {
 276     osl::MutexGuard aGuard( m_aMutex );
 277     int nRequested = 0, nDone = 0;
 278     for( std::list< Listener >::iterator it = m_aListeners.begin(); it != m_aListeners.end(); ++it )
 279     {
 280         if( it->m_bInteractionRequested )
 281         {
 282             nRequested++;
 283             if( xListener == it->m_xListener )
 284                 it->m_bInteractionDone = true;
 285         }
 286         if( it->m_bInteractionDone )
 287             nDone++;
 288     }
 289     if( nDone == nRequested && nDone > 0 )
 290     {
 291         m_bInteractionDone = true;
 292         if( m_pSession )
 293             m_pSession->interactionDone( bCancelShutdown );
 294     }
 295 }
 296
 297 void SAL_CALL VCLSession::saveDone( const Reference< XSessionManagerListener >& xListener ) throw( RuntimeException )
 298 {
 299     osl::MutexGuard aGuard( m_aMutex );
 300
 301     bool bSaveDone = true;
 302     for( std::list< Listener >::iterator it = m_aListeners.begin();
 303          it != m_aListeners.end(); ++it )
 304     {
 305         if( it->m_xListener == xListener )
 306             it->m_bSaveDone = true;
 307         if( ! it->m_bSaveDone )
 308             bSaveDone = false;
 309     }
 310     if( bSaveDone )
 311     {
 312         m_bSaveDone = true;
 313         if( m_pSession )
 314             m_pSession->saveDone();
 315     }
 316 }
 317
 318 // service implementation
 319
 320 OUString SAL_CALL vcl_session_getImplementationName()
 321 {
 322     static OUString aImplementationName( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.frame.VCLSessionManagerClient" ) );
 323     return aImplementationName;
 324 }
 325
 326 Sequence< rtl::OUString > SAL_CALL vcl_session_getSupportedServiceNames()
 327 {
 328     Sequence< OUString > aRet(1);
 329     aRet[0] = OUString::createFromAscii("com.sun.star.frame.SessionManagerClient");
 330     return aRet;
 331 }
 332
 333 Reference< XInterface > SAL_CALL vcl_session_createInstance( const Reference< XMultiServiceFactory > & /*xMultiServiceFactory*/ )
 334 {
 335     ImplSVData* pSVData = ImplGetSVData();
 336     if( ! pSVData->xSMClient.is() )
 337         pSVData->xSMClient = new VCLSession();
 338
 339     return Reference< XInterface >(pSVData->xSMClient, UNO_QUERY );
 340 }