# Cppcheck report - LibreOffice: framework/source/services/sessionlistener.cxx

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419

    /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
    /*
     * 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/.
     *
     * This file incorporates work covered by the following license notice:
     *
     *   Licensed to the Apache Software Foundation (ASF) under one or more
     *   contributor license agreements. See the NOTICE file distributed
     *   with this work for additional information regarding copyright
     *   ownership. The ASF licenses this file to you under the Apache
     *   License, Version 2.0 (the "License"); you may not use this file
     *   except in compliance with the License. You may obtain a copy of
     *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
     */

    #include <sal/types.h>

    #include <services/desktop.hxx>
    #include <classes/filtercache.hxx>
    #include <protocols.h>
    #include <general.h>

    #include <vcl/svapp.hxx>
    #include <unotools/tempfile.hxx>
    #include <com/sun/star/beans/NamedValue.hpp>
    #include <com/sun/star/beans/PropertyValue.hpp>
    #include <com/sun/star/frame/theAutoRecovery.hpp>
    #include <com/sun/star/frame/Desktop.hpp>
    #include <com/sun/star/frame/FeatureStateEvent.hpp>
    #include <com/sun/star/frame/XDispatch.hpp>
    #include <com/sun/star/frame/XSessionManagerListener2.hpp>
    #include <com/sun/star/frame/XSessionManagerClient.hpp>
    #include <com/sun/star/frame/XStatusListener.hpp>
    #include <com/sun/star/lang/EventObject.hpp>
    #include <com/sun/star/lang/XInitialization.hpp>
    #include <com/sun/star/util/URLTransformer.hpp>
    #include <com/sun/star/util/XURLTransformer.hpp>
    #include <com/sun/star/util/URL.hpp>
    #include <cppuhelper/implbase4.hxx>
    #include <cppuhelper/supportsservice.hxx>
    #include <unotools/pathoptions.hxx>

    #include <com/sun/star/uno/Any.hxx>
    #include <com/sun/star/uno/Sequence.hxx>

    using namespace css;
    using namespace com::sun::star::uno;
    using namespace com::sun::star::util;
    using namespace com::sun::star::beans;
    using namespace framework;

    namespace {

    /// @HTML
    /** @short  implements flat/deep detection of file/stream formats and provides
                further read/write access to the global office type configuration.

        @descr  Using of this class makes it possible to get information about the
                format type of a given URL or stream. The returned internal type name
                can be used to get more information about this format. Further this
                class provides full access to the configuration data and following
                implementations will support some special query modes.

        @author     as96863

        @docdate    10.03.2003 by as96863

        @todo       <ul>
                        <li>implementation of query mode</li>
                        <li>simple restore mechanism of last consistent cache state,
                            if flush failed</li>
                    </ul>
     */
    typedef cppu::WeakImplHelper4<
        css::lang::XInitialization,
        css::frame::XSessionManagerListener2,
        css::frame::XStatusListener,
        css::lang::XServiceInfo> SessionListener_BASE;

    class SessionListener : public SessionListener_BASE
    {
    private:
        osl::Mutex m_aMutex;

        /** reference to the uno service manager, which created this service.
            It can be used to create own needed helper services. */
        css::uno::Reference< css::uno::XComponentContext > m_xContext;

        css::uno::Reference< css::frame::XSessionManagerClient > m_rSessionManager;

        // restore handling
        bool m_bRestored;

        bool m_bSessionStoreRequested;

        bool m_bAllowUserInteractionOnQuit;
        bool m_bTerminated;

        // in case of synchronous call the caller should do saveDone() call himself!
        void StoreSession( bool bAsync );

        // let session quietly close the documents, remove lock files, store configuration and etc.
        void QuitSessionQuietly();

    public:
        SessionListener( const css::uno::Reference< css::uno::XComponentContext >& xContext );

        virtual ~SessionListener();

        virtual OUString SAL_CALL getImplementationName()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            return OUString("com.sun.star.comp.frame.SessionListener");
        }

        virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName)
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            return cppu::supportsService(this, ServiceName);
        }

        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            css::uno::Sequence< OUString > aSeq(1);
            aSeq[0] = "com.sun.star.frame.SessionListener";
            return aSeq;
        }

        virtual void SAL_CALL disposing(const com::sun::star::lang::EventObject&) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;

        // XInitialization
        virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any  >& args) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;

        // XSessionManagerListener
        virtual void SAL_CALL doSave( sal_Bool bShutdown, sal_Bool bCancelable )
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
        virtual void SAL_CALL approveInteraction( sal_Bool bInteractionGranted )
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
       virtual void SAL_CALL shutdownCanceled()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
       virtual sal_Bool SAL_CALL doRestore()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;

        // XSessionManagerListener2
        virtual void SAL_CALL doQuit()
            throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;

        // XStatusListener
        virtual void SAL_CALL statusChanged(const com::sun::star::frame::FeatureStateEvent& event)
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
    };

    SessionListener::SessionListener(const css::uno::Reference< css::uno::XComponentContext >& rxContext )
            : m_xContext( rxContext )
            , m_bRestored( false )
            , m_bSessionStoreRequested( false )
            , m_bAllowUserInteractionOnQuit( false )
            , m_bTerminated( false )
    {
        SAL_INFO("fwk.session", "SessionListener::SessionListener");
    }

    SessionListener::~SessionListener()
    {
        SAL_INFO("fwk.session", "SessionListener::~SessionListener");
        if (m_rSessionManager.is())
        {
            css::uno::Reference< XSessionManagerListener> me(this);
            m_rSessionManager->removeSessionManagerListener(me);
        }
    }

    void SessionListener::StoreSession( bool bAsync )
    {
        SAL_INFO("fwk.session", "SessionListener::StoreSession");
        osl::MutexGuard g(m_aMutex);
        try
        {
            // xd create SERVICENAME_AUTORECOVERY -> frame::XDispatch
            // xd->dispatch("vnd.sun.star.autorecovery:/doSessionSave, async=bAsync
            // on stop event m_rSessionManager->saveDone(this); in case of asynchronous call
            // in case of synchronous call the caller should do saveDone() call himself!

            css::uno::Reference< frame::XDispatch > xDispatch = css::frame::theAutoRecovery::get( m_xContext );
            css::uno::Reference< XURLTransformer > xURLTransformer = URLTransformer::create( m_xContext );
            URL aURL;
            aURL.Complete = "vnd.sun.star.autorecovery:/doSessionSave";
            xURLTransformer->parseStrict(aURL);

            // in case of asynchronous call the notification will trigger saveDone()
            if ( bAsync )
                xDispatch->addStatusListener(this, aURL);

            Sequence< PropertyValue > args(1);
            args[0] = PropertyValue(OUString("DispatchAsynchron"),-1,makeAny(bAsync),PropertyState_DIRECT_VALUE);
            xDispatch->dispatch(aURL, args);
        } catch (const com::sun::star::uno::Exception& e) {
            SAL_WARN("fwk.session",e.Message);
            // save failed, but tell manager to go on if we havent yet dispatched the request
            // in case of synchronous saving the notification is done by the caller
            if ( bAsync && m_rSessionManager.is() )
                m_rSessionManager->saveDone(this);
        }
    }

    void SessionListener::QuitSessionQuietly()
    {
        SAL_INFO("fwk.session", "SessionListener::QuitSessionQuietly");
        osl::MutexGuard g(m_aMutex);
        try
        {
            // xd create SERVICENAME_AUTORECOVERY -> frame::XDispatch
            // xd->dispatch("vnd.sun.star.autorecovery:/doSessionQuietQuit, async=false
            // it is done synchronously to avoid conflict with normal quit process

            css::uno::Reference< frame::XDispatch > xDispatch = css::frame::theAutoRecovery::get( m_xContext );
            css::uno::Reference< XURLTransformer > xURLTransformer = URLTransformer::create( m_xContext );
            URL aURL;
            aURL.Complete = "vnd.sun.star.autorecovery:/doSessionQuietQuit";
            xURLTransformer->parseStrict(aURL);

            Sequence< PropertyValue > args(1);
            args[0] = PropertyValue(OUString("DispatchAsynchron"),-1,makeAny(sal_False),PropertyState_DIRECT_VALUE);
            xDispatch->dispatch(aURL, args);
        } catch (const com::sun::star::uno::Exception& e) {
            SAL_WARN("fwk.session",e.Message);
        }
    }

    void SAL_CALL SessionListener::disposing(const com::sun::star::lang::EventObject&) throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::disposing");
    }

    void SAL_CALL SessionListener::initialize(const Sequence< Any  >& args)
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::initialize");

        OUString aSMgr("com.sun.star.frame.SessionManagerClient");
        if ( (args.getLength() == 1) && (args[0] >>= m_bAllowUserInteractionOnQuit) )
           ;// do nothing
        else if (args.getLength() > 0)
        {
            NamedValue v;
            for (int i = 0; i < args.getLength(); i++)
            {
                if (args[i] >>= v)
                {
                    if ( v.Name == "SessionManagerName" )
                        v.Value >>= aSMgr;
                    else if ( v.Name == "SessionManager" )
                        v.Value >>= m_rSessionManager;
                    else if ( v.Name == "AllowUserInteractionOnQuit" )
                        v.Value >>= m_bAllowUserInteractionOnQuit;
                }
            }
        }
        if (!m_rSessionManager.is())
            m_rSessionManager = css::uno::Reference< frame::XSessionManagerClient >
                (m_xContext->getServiceManager()->createInstanceWithContext(aSMgr, m_xContext), UNO_QUERY);

        if (m_rSessionManager.is())
        {
            m_rSessionManager->addSessionManagerListener(this);
        }
    }

    void SAL_CALL SessionListener::statusChanged(const frame::FeatureStateEvent& event)
        throw (css::uno::RuntimeException, std::exception)
    {
       SAL_INFO("fwk.session", "SessionListener::statusChanged");
       if ( event.FeatureURL.Complete == "vnd.sun.star.autorecovery:/doSessionRestore" )
        {
            if (event.FeatureDescriptor == "update")
                m_bRestored = true; // a document was restored

        }
        else if ( event.FeatureURL.Complete == "vnd.sun.star.autorecovery:/doSessionSave" )
        {
            if (event.FeatureDescriptor == "stop")
            {
                if (m_rSessionManager.is())
                    m_rSessionManager->saveDone(this); // done with save
            }
        }
    }

    sal_Bool SAL_CALL SessionListener::doRestore()
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::doRestore");
        osl::MutexGuard g(m_aMutex);
        m_bRestored = false;
        try {
            css::uno::Reference< frame::XDispatch > xDispatch = css::frame::theAutoRecovery::get( m_xContext );

            URL aURL;
            aURL.Complete = "vnd.sun.star.autorecovery:/doSessionRestore";
            css::uno::Reference< XURLTransformer > xURLTransformer(URLTransformer::create(m_xContext));
            xURLTransformer->parseStrict(aURL);
            Sequence< PropertyValue > args;
            xDispatch->addStatusListener(this, aURL);
            xDispatch->dispatch(aURL, args);
            m_bRestored = true;

        } catch (const com::sun::star::uno::Exception& e) {
            SAL_WARN("fwk.session",e.Message);
        }

        return m_bRestored;
    }

    void SAL_CALL SessionListener::doSave( sal_Bool bShutdown, sal_Bool /*bCancelable*/ )
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::doSave");
        if (bShutdown)
        {
            m_bSessionStoreRequested = true; // there is no need to protect it with mutex
            if ( m_bAllowUserInteractionOnQuit && m_rSessionManager.is() )
                m_rSessionManager->queryInteraction( static_cast< css::frame::XSessionManagerListener* >( this ) );
            else
                StoreSession( true );
        }
        // we don't have anything to do so tell the session manager we're done
        else if( m_rSessionManager.is() )
            m_rSessionManager->saveDone( this );
    }

    void SAL_CALL SessionListener::approveInteraction( sal_Bool bInteractionGranted )
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::approveInteraction");
        // do AutoSave as the first step
        osl::MutexGuard g(m_aMutex);

        if ( bInteractionGranted )
        {
            // close the office documents in normal way
            try
            {
                // first of all let the session be stored to be sure that we lose no information
                StoreSession( false );

                css::uno::Reference< css::frame::XDesktop2 > xDesktop = css::frame::Desktop::create( m_xContext );
                // honestly: how many implementations of XDesktop will we ever have?
                // so casting this directly to the implementation
                Desktop* pDesktop(dynamic_cast<Desktop*>(xDesktop.get()));
                if(pDesktop)
                {
                    SAL_INFO("fwk.session", "XDesktop is a framework::Desktop -- good.");
                    m_bTerminated = pDesktop->terminateQuickstarterToo();
                }
                else
                {
                    SAL_WARN("fwk.session", "XDesktop is not a framework::Desktop -- this should never happen.");
                    m_bTerminated = xDesktop->terminate();
                }

                if ( m_rSessionManager.is() )
                {
                    // false means that the application closing has been cancelled
                    if ( !m_bTerminated )
                        m_rSessionManager->cancelShutdown();
                    else
                        m_rSessionManager->interactionDone( this );
                }
            }
            catch( const css::uno::Exception& )
            {
                StoreSession( true );
                m_rSessionManager->interactionDone( this );
            }

            if ( m_rSessionManager.is() )
                m_rSessionManager->saveDone(this);
        }
        else
        {
            StoreSession( true );
        }
    }

    void SessionListener::shutdownCanceled()
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::shutdownCanceled");
        // set the state back
        m_bSessionStoreRequested = false; // there is no need to protect it with mutex
    }

    void SessionListener::doQuit()
        throw (RuntimeException, std::exception)
    {
        SAL_INFO("fwk.session", "SessionListener::doQuit");
        if ( m_bSessionStoreRequested && !m_bTerminated )
        {
            // let the session be closed quietly in this case
            QuitSessionQuietly();
        }
    }

    }

    extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
    com_sun_star_comp_frame_SessionListener_get_implementation(<--- The function 'com_sun_star_comp_frame_SessionListener_get_implementation' is never used.
        css::uno::XComponentContext *context,
        css::uno::Sequence<css::uno::Any> const &)
    {
        return cppu::acquire(new SessionListener(context));
    }

    /* vim:set shiftwidth=4 softtabstop=4 expandtab: */