[Libreoffice-commits] core.git: 2 commits - framework/inc framework/source framework/util
Jan Holesovsky
kendy at collabora.com
Mon Jan 20 11:35:45 PST 2014
framework/inc/services/autorecovery.hxx | 1048 -----------------------
framework/source/register/registerservices.cxx | 2
framework/source/services/autorecovery.cxx | 1119 +++++++++++++++++++++++--
framework/util/fwk.component | 3
4 files changed, 1069 insertions(+), 1103 deletions(-)
New commits:
commit f979a12741d0e5f47b26aa407593ab7c21979f6d
Author: Jan Holesovsky <kendy at collabora.com>
Date: Mon Jan 20 19:53:34 2014 +0100
Forgotten git add, doh!
Change-Id: I6dccc887b400352cc47678d912b5e4d391c96a3b
diff --git a/framework/source/services/autorecovery.cxx b/framework/source/services/autorecovery.cxx
index 0c6282e..c0e0aeb 100644
--- a/framework/source/services/autorecovery.cxx
+++ b/framework/source/services/autorecovery.cxx
@@ -65,6 +65,7 @@
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/awt/XWindow2.hpp>
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
+#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
@@ -76,7 +77,7 @@
#include <comphelper/configurationhelper.hxx>
#include <cppuhelper/exc_hlp.hxx>
-#include <cppuhelper/implbase5.hxx>
+#include <cppuhelper/implbase6.hxx>
#include <cppuhelper/propshlp.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <unotools/mediadescriptor.hxx>
@@ -188,8 +189,9 @@ public:
of documents - including features of an EmergencySave in
case a GPF occurs.
*/
-typedef ::cppu::WeakImplHelper5<
+typedef ::cppu::WeakImplHelper6<
css::lang::XServiceInfo,
+ css::lang::XInitialization,
css::frame::XDispatch,
css::document::XEventListener, // => css.lang.XEventListener
css::util::XChangesListener, // => css.lang.XEventListener
commit 279859fdbc40f68d8f1649fa5b928d9de49e8d9e
Author: Matúš Kukan <matus.kukan at collabora.com>
Date: Thu Jan 9 13:25:21 2014 +0100
fwk: Use constructor feature for AutoRecovery.
Change-Id: I87a6c1c1c6dc92670dccee3f56302e7f234b281d
diff --git a/framework/inc/services/autorecovery.hxx b/framework/inc/services/autorecovery.hxx
deleted file mode 100644
index 04f0c8f..0000000
--- a/framework/inc/services/autorecovery.hxx
+++ /dev/null
@@ -1,1048 +0,0 @@
-/* -*- 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 .
- */
-
-#ifndef INCLUDED_FRAMEWORK_INC_SERVICES_AUTORECOVERY_HXX
-#define INCLUDED_FRAMEWORK_INC_SERVICES_AUTORECOVERY_HXX
-
-#include <threadhelp/threadhelpbase.hxx>
-#include <macros/xinterface.hxx>
-#include <macros/xtypeprovider.hxx>
-#include <macros/xserviceinfo.hxx>
-#include <general.h>
-#include <stdtypes.h>
-
-#include <com/sun/star/uno/XInterface.hpp>
-#include <com/sun/star/lang/XTypeProvider.hpp>
-#include <com/sun/star/lang/XServiceInfo.hpp>
-#include <com/sun/star/lang/XMultiServiceFactory.hpp>
-#include <com/sun/star/frame/XDispatch.hpp>
-#include <com/sun/star/frame/XGlobalEventBroadcaster.hpp>
-#include <com/sun/star/container/XNameAccess.hpp>
-#include <com/sun/star/document/XEventListener.hpp>
-#include <com/sun/star/document/XEventBroadcaster.hpp>
-#include <com/sun/star/frame/XModel.hpp>
-#include <com/sun/star/util/XChangesListener.hpp>
-#include <com/sun/star/task/XStatusIndicator.hpp>
-#include <com/sun/star/util/XModifyListener.hpp>
-
-#include <unotools/mediadescriptor.hxx>
-#include <vcl/timer.hxx>
-#include <vcl/evntpost.hxx>
-#include <cppuhelper/implbase5.hxx>
-#include <cppuhelper/propshlp.hxx>
-
-//_______________________________________________
-// definition
-
-namespace framework
-{
-
-//---------------------------------------
-/** @short hold all needed information for an asynchronous dispatch alive.
-
- @descr Because some operations are forced to be executed asynchronously
- (e.g. requested by our CreashSave/Recovery dialog) ... we must make sure
- that these information wont be set as "normal" members of our AtoRecovery
- instance. Otherwise they can disturb our normal AutoSave-timer handling.
- e.g. it can be unclear then, which progress has to be used for storing documents ...
- */
-struct DispatchParams
-{
- public:
- DispatchParams();
- DispatchParams(const ::comphelper::SequenceAsHashMap& lArgs ,
- const css::uno::Reference< css::uno::XInterface >& xOwner);
- DispatchParams(const DispatchParams& rCopy);
- ~DispatchParams();
-
- DispatchParams& operator=(const DispatchParams& rCopy);
- void forget();
-
- public:
-
- //---------------------------------------
- /** @short can be set from outside and is provided to
- our internal started operations.
-
- @descr Normaly we use the normal status indicator
- of the document windows to show a progress.
- But in case we are used by any special UI,
- it can provide its own status indicator object
- to us - so we use it instead of the normal one.
- */
- css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
-
- //---------------------------------------
- /** TODO document me */
- OUString m_sSavePath;
-
- //---------------------------------------
- /** @short define the current cache entry, which should be used for current
- backup or cleanUp operation ... which is may be done asynchronous */
- sal_Int32 m_nWorkingEntryID;
-
- //---------------------------------------
- /** @short used for asyncoperations, to prevent us from dying.
-
- @descr If our dispatch() method was forced to start the
- internal operation asynchronous ... we send an event
- to start and return immediately. But we must be shure that
- our instance live if the event callback reach us.
- So we hold an uno reference to ourself.
- */
- css::uno::Reference< css::uno::XInterface > m_xHoldRefForAsyncOpAlive;
-};
-
-//_______________________________________________
-/**
- implements the functionality of AutoSave and AutoRecovery
- of documents - including features of an EmergencySave in
- case a GPF occurs.
- */
-typedef ::cppu::WeakImplHelper5<
- css::lang::XServiceInfo,
- css::frame::XDispatch,
- css::document::XEventListener, // => css.lang.XEventListener
- css::util::XChangesListener, // => css.lang.XEventListener
- css::util::XModifyListener > // => css.lang.XEventListener
- AutoRecovery_BASE;
-
-class AutoRecovery : // attention! Must be the first base class to guarentee right initialize lock ...
- private ThreadHelpBase
- , public ::cppu::OBroadcastHelper
- , public ::cppu::OPropertySetHelper // => XPropertySet, XFastPropertySet, XMultiPropertySet
- , public AutoRecovery_BASE
-{
- //___________________________________________
- // types
-
- public:
-
- /** These values are used as flags and represent the current state of a document.
- Every state of the life time of a document has to be recognized here.
-
- @attention Do not change (means reorganize) already used numbers.
- There exists some code inside SVX, which uses the same numbers,
- to analyze such document states.
- Not the best design ... but may be it will be changed later .-)
- */
- enum EDocStates
- {
- /* TEMP STATES */
-
- /// default state, if a document was new created or loaded
- E_UNKNOWN = 0,
- /// modified against the original file
- E_MODIFIED = 1,
- /// an active document can be postponed to be saved later.
- E_POSTPONED = 2,
- /// was already handled during one AutoSave/Recovery session.
- E_HANDLED = 4,
- /** an action was started (saving/loading) ... Can be interesting later if the process may be was interrupted by an exception. */
- E_TRY_SAVE = 8,
- E_TRY_LOAD_BACKUP = 16,
- E_TRY_LOAD_ORIGINAL = 32,
-
- /* FINAL STATES */
-
- /// the Auto/Emergency saved document isnt useable any longer
- E_DAMAGED = 64,
- /// the Auto/Emergency saved document isnt really up-to-date (some changes can be missing)
- E_INCOMPLETE = 128,
- /// the Auto/Emergency saved document was processed successfully
- E_SUCCEDED = 512
- };
-
- /** @short indicates the results of a FAILURE_SAFE operation
-
- @descr We must know, which reason was the real one in case
- we couldnt copy a "failure document" to a user specified path.
- We must know, if we can forget our cache entry or not.
- */
- enum EFailureSafeResult
- {
- E_COPIED,
- E_ORIGINAL_FILE_MISSING,
- E_WRONG_TARGET_PATH
- };
-
- // TODO document me
- enum ETimerType
- {
- /** the timer should not be used next time */
- E_DONT_START_TIMER,
- /** timer (was/must be) started with normal AutoSaveTimeIntervall */
- E_NORMAL_AUTOSAVE_INTERVALL,
- /** timer must be started with special short time intervall,
- to poll for an user idle period */
- E_POLL_FOR_USER_IDLE,
- /** timer mst be started with a very(!) short time intervall,
- to poll for the end of an user action, which does not allow saving documents in general */
- E_POLL_TILL_AUTOSAVE_IS_ALLOWED,
- /** dont start the timer - but calls the same action then before immediately again! */
- E_CALL_ME_BACK
- };
-
- // TODO document me ... flag field
- // Emergency_Save and Recovery overwrites Auto_Save!
- enum EJob
- {
- E_NO_JOB = 0,
- E_AUTO_SAVE = 1,
- E_EMERGENCY_SAVE = 2,
- E_RECOVERY = 4,
- E_ENTRY_BACKUP = 8,
- E_ENTRY_CLEANUP = 16,
- E_PREPARE_EMERGENCY_SAVE = 32,
- E_SESSION_SAVE = 64,
- E_SESSION_RESTORE = 128,
- E_DISABLE_AUTORECOVERY = 256,
- E_SET_AUTOSAVE_STATE = 512,
- E_SESSION_QUIET_QUIT = 1024,
- E_USER_AUTO_SAVE = 2048
- };
-
- //---------------------------------------
- /** @short combine different information about one office document. */
- struct TDocumentInfo
- {
- public:
-
- //-------------------------------
- TDocumentInfo()
- : DocumentState (E_UNKNOWN)
- , UsedForSaving (sal_False)
- , ListenForModify (sal_False)
- , IgnoreClosing (sal_False)
- , ID (-1 )
- {}
-
- //-------------------------------
- /** @short points to the document. */
- css::uno::Reference< css::frame::XModel > Document;
-
- //-------------------------------
- /** @short knows, if the document is really modified since the last autosave,
- or was postponed, because it was an active one etcpp...
-
- @descr Because we have no CHANGE TRACKING mechanism, based on office document,
- we implements it by ourself. We listen for MODIFIED events
- of each document and update this state flag here.
-
- Further we postpone saving of active documents, e.g. if the user
- works currently on it. We wait for an idle period then ...
- */
- sal_Int32 DocumentState;
-
- //-------------------------------
- /** Because our applications not ready for concurrent save requests at the same time,
- we have supress our own AutoSave for the moment, a document will be already saved
- by others.
- */
- sal_Bool UsedForSaving;
-
- //-------------------------------
- /** For every user action, which modifies a document (e.g. key input) we get
- a notification as XModifyListener. That seams to be a "performance issue" .-)
- So we decided to listen for such modify events only for the time in which the document
- was stored as temp. file and was not modified again by the user.
- */
- sal_Bool ListenForModify;
-
- //-------------------------------
- /** For SessionSave we must close all open documents by ourself.
- But because we are listen for documents events, we get some ...
- and deregister these documents from our configuration.
- That's why we mark these documents as "Closed by ourself" so we can
- ignore these "OnUnload" or disposing() events .-)
- */
- sal_Bool IgnoreClosing;
-
- //-------------------------------
- /** TODO: document me */
- OUString OrgURL;
- OUString FactoryURL;
- OUString TemplateURL;
-
- OUString OldTempURL;
- OUString NewTempURL;
-
- OUString AppModule; // e.g. com.sun.star.text.TextDocument - used to identify app module
- OUString FactoryService; // the service to create a document of the module
- OUString RealFilter; // real filter, which was used at loading time
- OUString DefaultFilter; // supports saving of the default format without loosing data
- OUString Extension; // file extension of the default filter
- OUString Title; // can be used as "DisplayName" on every recovery UI!
- ::com::sun::star::uno::Sequence< OUString >
- ViewNames; // names of the view which were active at emergency-save time
-
- sal_Int32 ID;
- };
-
- //---------------------------------------
- /** @short used to know every currently open document. */
- typedef ::std::vector< TDocumentInfo > TDocumentList;
-
- //___________________________________________
- // member
-
- private:
-
- //---------------------------------------
- /** @short the global uno service manager.
- @descr Must be used to create own needed services.
- */
- css::uno::Reference< css::uno::XComponentContext > m_xContext;
-
- //---------------------------------------
- /** @short points to the underlying recovery configuration.
- @descr This instance does not cache - it calls directly the
- configuration API!
- */
- css::uno::Reference< css::container::XNameAccess > m_xRecoveryCFG;
-
- //---------------------------------------
- /** @short proxy weak binding to forward Events to ourself without
- an ownership cycle
- */
- css::uno::Reference< css::util::XChangesListener > m_xRecoveryCFGListener;
-
- //---------------------------------------
- /** @short points to the used configuration package or.openoffice.Setup
- @descr This instance does not cache - it calls directly the
- configuration API!
- */
- css::uno::Reference< css::container::XNameAccess > m_xModuleCFG;
-
- //---------------------------------------
- /** @short holds the global event broadcaster alive,
- where we listen for new created documents.
- */
- css::uno::Reference< css::frame::XGlobalEventBroadcaster > m_xNewDocBroadcaster;
-
- //---------------------------------------
- /** @short proxy weak binding to forward Events to ourself without
- an ownership cycle
- */
- css::uno::Reference< css::document::XEventListener > m_xNewDocBroadcasterListener;
-
- //---------------------------------------
- /** @short because we stop/restart listening sometimes, it's a good idea to know
- if we already registered as listener .-)
- */
- sal_Bool m_bListenForDocEvents;
- sal_Bool m_bListenForConfigChanges;
-
- //---------------------------------------
- /** @short specify the time intervall between two save actions.
- @descr Time is measured in [min].
- */
- sal_Int32 m_nAutoSaveTimeIntervall;
-
- //---------------------------------------
- /** @short for an asynchronous operation we must know, if there is
- at least one running job (may be asynchronous!).
- */
- sal_Int32 m_eJob;
-
- //---------------------------------------
- /** @short the timer, which is used to be informed about the next
- saving time ...
- */
- Timer m_aTimer;
-
- //---------------------------------------
- /** @short make our dispatch asynchronous ... if required to do so! */
- ::vcl::EventPoster m_aAsyncDispatcher;
-
- //---------------------------------------
- /** @see DispatchParams
- */
- DispatchParams m_aDispatchParams;
-
- //---------------------------------------
- /** @short indicates, which time period is currently used by the
- internal timer.
- */
- ETimerType m_eTimerType;
-
- //---------------------------------------
- /** @short this cache is used to hold all information about
- recovery/emergency save documents alive.
- */
- TDocumentList m_lDocCache;
-
- //---------------------------------------
- // TODO document me
- sal_Int32 m_nIdPool;
-
- //---------------------------------------
- /** @short contains all status listener registered at this instance.
- */
- ListenerHash m_lListener;
-
- /** @descr This member is used to prevent us against re-entrance problems.
- A mutex cant help to prevent us from concurrent using of members
- inside the same thread. But e.g. our internaly used stl structures
- are not threadsafe ... and furthermore they cant be used at the same time
- for iteration and add/remove requests!
- So we have to detect such states and ... show a warning.
- May be there will be a better solution next time ... (copying the cache temp.
- bevor using).
-
- And further it's not possible to use a simple boolean value here.
- Because if more then one operation iterates over the same stl container ...
- (only to modify it's elements but dont add new or removing existing ones!)
- it should be possible doing so. But we must guarantee that the last operation reset
- this lock ... not the first one ! So we use a "ref count" mechanism for that."
- */
- sal_Int32 m_nDocCacheLock;
-
- /** @descr These members are used to check the minimum disc space, which must exists
- to start the corresponding operation.
- */
- sal_Int32 m_nMinSpaceDocSave;
- sal_Int32 m_nMinSpaceConfigSave;
-
- //---------------------------------------
- /** @short special debug option to make testing faster.
-
- @descr We dont interpret the timer unit as [min] ...
- we use [ms] instead of that. Further we dont
- wait 10 s for user idle ...
- */
- #if OSL_DEBUG_LEVEL > 1
- sal_Bool m_dbg_bMakeItFaster;
- #endif
-
- //---------------------------------------
- // HACK ... TODO
- css::uno::Reference< css::task::XStatusIndicator > m_xExternalProgress;
-
- //___________________________________________
- // interface
-
- public:
-
- AutoRecovery(const css::uno::Reference< css::uno::XComponentContext >& xContext);
- virtual ~AutoRecovery( );
-
- // XServiceInfo
- DECLARE_XSERVICEINFO
-
- // XInterface
- virtual void SAL_CALL acquire() throw ()
- { OWeakObject::acquire(); }
- virtual void SAL_CALL release() throw ()
- { OWeakObject::release(); }
- virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& type) throw ( ::com::sun::star::uno::RuntimeException );
-
- // XTypeProvider
- virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes( ) throw(::com::sun::star::uno::RuntimeException);
-
- //---------------------------------------
- // css.frame.XDispatch
- virtual void SAL_CALL dispatch(const css::util::URL& aURL ,
- const css::uno::Sequence< css::beans::PropertyValue >& lArguments)
- throw(css::uno::RuntimeException);
-
- virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
- const css::util::URL& aURL )
- throw(css::uno::RuntimeException);
-
- virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
- const css::util::URL& aURL )
- throw(css::uno::RuntimeException);
-
- //---------------------------------------
- // css.document.XEventListener
- /** @short informs about created/opened documents.
-
- @descr Every new opened/created document will be saved internaly
- so it can be checked if its modified. This modified state
- is used later to decide, if it must be saved or not.
-
- @param aEvent
- points to the new created/opened document.
- */
- virtual void SAL_CALL notifyEvent(const css::document::EventObject& aEvent)
- throw(css::uno::RuntimeException);
-
- //---------------------------------------
- // css.util.XChangesListener
- virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
- throw(css::uno::RuntimeException);
-
- //---------------------------------------
- // css.util.XModifyListener
- virtual void SAL_CALL modified(const css::lang::EventObject& aEvent)
- throw(css::uno::RuntimeException);
-
- //---------------------------------------
- // css.lang.XEventListener
- using cppu::OPropertySetHelper::disposing;
- virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
- throw(css::uno::RuntimeException);
-
- //___________________________________________
- // helper
-
- protected:
-
- //---------------------------------------
- // OPropertySetHelper
-
- virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& aConvertedValue,
- css::uno::Any& aOldValue ,
- sal_Int32 nHandle ,
- const css::uno::Any& aValue )
- throw(css::lang::IllegalArgumentException);
-
- virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle,
- const css::uno::Any& aValue )
- throw(css::uno::Exception);
- using cppu::OPropertySetHelper::getFastPropertyValue;
- virtual void SAL_CALL getFastPropertyValue(css::uno::Any& aValue ,
- sal_Int32 nHandle) const;
-
- virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
-
- virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
- throw(css::uno::RuntimeException);
- //___________________________________________
- // helper
-
- private:
-
- //---------------------------------------
- /** @short open the underlying configuration.
-
- @descr This method must be called every time
- a configuartion call is needed. Because
- method works together with the member
- m_xCFG, open it on demand and cache it
- afterwards.
-
- @return [com.sun.star.container.XNameAccess]
- the configuration object
-
- @throw [com.sun.star.uno.RuntimeException]
- if config could not be opened successfully!
-
- @threadsafe
- */
- css::uno::Reference< css::container::XNameAccess > implts_openConfig();
-
- //---------------------------------------
- /** @short read the underlying configuration.
-
- @descr After that we know the initial state - means:
- - if AutoSave was enabled by the user
- - which time intervall has to be used
- - which recovery entries may already exists
-
- @throw [com.sun.star.uno.RuntimeException]
- if config could not be opened or readed successfully!
-
- @threadsafe
- */
- void implts_readConfig();
-
- //---------------------------------------
- /** @short read the underlying configuration...
-
- @descr ... but only keys related to the AutoSave mechanism.
- Means: State and Timer intervall.
- E.g. the recovery list isnt adressed here.
-
- @throw [com.sun.star.uno.RuntimeException]
- if config could not be opened or readed successfully!
-
- @threadsafe
- */
- void implts_readAutoSaveConfig();
-
- //---------------------------------------
- // TODO document me
- void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo ,
- sal_Bool bRemoveIt = sal_False);
-
- //---------------------------------------
- // TODO document me
- void implts_startListening();
- void implts_startModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
-
- //---------------------------------------
- // TODO document me
- void implts_stopListening();
- void implts_stopModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
-
- //---------------------------------------
- /** @short stops and may be(!) restarts the timer.
-
- @descr A running timer is stopped every time here.
- But starting depends from the different internal
- timer variables (e.g. AutoSaveEnabled, AutoSaveTimeIntervall,
- TimerType etcpp.)
-
- @throw [com.sun.star.uno.RuntimeException]
- if timer could not be stopped or started!
-
- @threadsafe
- */
- void implts_updateTimer();
-
- //---------------------------------------
- /** @short stop the timer.
-
- @descr Double calls will be ignored - means we do
- nothing here, if the timer is already disabled.
-
- @throw [com.sun.star.uno.RuntimeException]
- if timer could not be stopped!
-
- @threadsafe
- */
- void implts_stopTimer();
-
- //---------------------------------------
- /** @short callback of our internal timer.
- */
- DECL_LINK(implts_timerExpired, void*);
-
- //---------------------------------------
- /** @short makes our dispatch() method asynchronous!
- */
- DECL_LINK(implts_asyncDispatch, void*);
-
- //---------------------------------------
- /** @short implements the dispatch real. */
- void implts_dispatch(const DispatchParams& aParams);
-
- //---------------------------------------
- /** @short validate new detected document and add it into the internal
- document list.
-
- @descr This method should be called only, if its clear that a new
- document was opened/created during office runtime.
- This method checks, if it's a top level document (means not an embedded one).
- Only such top level documents can be recognized by this auto save mechanism.
-
- @param xDocument
- the new document, which should be checked and registered.
-
- @threadsafe
- */
- void implts_registerDocument(const css::uno::Reference< css::frame::XModel >& xDocument);
-
- //---------------------------------------
- /** @short remove the specified document from our internal document list.
-
- @param xDocument
- the new document, which should be deregistered.
-
- @param bStopListening
- sal_False: must be used in case this method is called withion disposing() of the document,
- where it make no sense to deregister our listener. The container dies ...
- sal_True : must be used in case this method is used on "dergistration" of this document, where
- we must deregister our listener .-)
-
- @threadsafe
- */
- void implts_deregisterDocument(const css::uno::Reference< css::frame::XModel >& xDocument ,
- sal_Bool bStopListening = sal_True);
-
- //---------------------------------------
- // TODO document me
- void implts_markDocumentModifiedAgainstLastBackup(const css::uno::Reference< css::frame::XModel >& xDocument);
-
- //---------------------------------------
- // TODO document me
- void implts_updateModifiedState(const css::uno::Reference< css::frame::XModel >& xDocument);
-
- //---------------------------------------
- // TODO document me
- void implts_updateDocumentUsedForSavingState(const css::uno::Reference< css::frame::XModel >& xDocument ,
- sal_Bool bSaveInProgress);
-
- //---------------------------------------
- // TODO document me
- void implts_markDocumentAsSaved(const css::uno::Reference< css::frame::XModel >& xDocument);
-
- //---------------------------------------
- /** @short search a document inside given list.
-
- @param rList
- reference to a vector, which can contain such
- document.
-
- @param xDocument
- the document, which should be located inside the
- given list.
-
- @return [TDocumentList::iterator]
- which points to the located document.
- If document does not exists - its set to
- rList.end()!
- */
- static TDocumentList::iterator impl_searchDocument( AutoRecovery::TDocumentList& rList ,
- const css::uno::Reference< css::frame::XModel >& xDocument);
-
- //---------------------------------------
- /** TODO document me */
- void implts_changeAllDocVisibility(sal_Bool bVisible);
- void implts_prepareSessionShutdown();
-
- //---------------------------------------
- /** @short save all current opened documents to a specific
- backup directory.
-
- @descr Only really changed documents will be saved here.
-
- Further this method returns a suggestion, if and how it should
- be called again. May be some documents was not saved yet
- and must wait for an user idle period ...
-
- @param bAllowUserIdleLoop
- Because this method is used for different uses cases, it must
- know, which actions are allowed or not.
- AUTO_SAVE =>
- If a document is the most active one, saving it
- will be postponed if there exists other unsaved
- documents. This feature was implemented, because
- we dont wish to disturb the user on it's work.
- ... bAllowUserIdleLoop should be set to sal_True
- EMERGENCY_SAVE / SESSION_SAVE =>
- Here we must finish our work ASAP! It's not allowed
- to postpone any document.
- ... bAllowUserIdleLoop must(!) be set to sal_False
-
- @param pParams
- sometimes this method is required inside an external dispatch request.
- The it contains some special environment variables, which overwrites
- our normal environment.
- AutoSave => pParams == 0
- SessionSave/CrashSave => pParams != 0
-
- @return A suggestion, how the timer (if its not already disabled!)
- should be restarted to full fill the requirements.
-
- @threadsafe
- */
- AutoRecovery::ETimerType implts_saveDocs( sal_Bool bAllowUserIdleLoop,
- sal_Bool bRemoveLockFiles,
- const DispatchParams* pParams = 0);
-
- //---------------------------------------
- /** @short save one of the current documents to a specific
- backup directory.
-
- @descr It:
- - defines a new(!) unique temp file name
- - save the new temp file
- - remove the old temp file
- - patch the given info struct
- - and return errors.
-
- It does not:
- - patch the configuration.
-
- Note further: It paches the info struct
- more then ones. E.g. the new temp URL is set
- before the file is saved. And the old URL is removed
- only if removing oft he old file was successfully.
- If this method returns without an exception - everything
- was OK. Otherwise the info struct can be analyzed to
- get more information, e.g. when the problem occurs.
-
- @param sBackupPath
- the base path for saving such temp files.
-
- @param rInfo
- points to an information structure, where
- e.g. the document, its modified state, the count
- of autosave-retries etcpp. exists.
- Its used also to return the new temp file name
- and some other state values!
-
- @threadsafe
- */
- void implts_saveOneDoc(const OUString& sBackupPath ,
- AutoRecovery::TDocumentInfo& rInfo ,
- const css::uno::Reference< css::task::XStatusIndicator >& xExternalProgress);
-
- //---------------------------------------
- /** @short recovery all documents, which was saved during
- a crash before.
-
- @return A suggestion, how this method must be called back!
-
- @threadsafe
- */
- AutoRecovery::ETimerType implts_openDocs(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_openOneDoc(const OUString& sURL ,
- utl::MediaDescriptor& lDescriptor,
- AutoRecovery::TDocumentInfo& rInfo );
-
- //---------------------------------------
- // TODO document me
- void implts_generateNewTempURL(const OUString& sBackupPath ,
- utl::MediaDescriptor& rMediaDescriptor,
- AutoRecovery::TDocumentInfo& rInfo );
-
- //---------------------------------------
- /** @short notifies all interested listener about the current state
- of the currently running operation.
-
- @descr We support different set's of functions. AUTO_SAVE, EMERGENCY_SAVE,
- AUTO_RECOVERY, FAILURE_SAVE ... etcpp.
- Listener can register itself for any type of supported
- functionality ... but not for document URL's in special.
-
- @param eJob
- is used to know, which set of listener we must notify.
-
- @param aEvent
- describe the event more in detail.
-
- @threadsafe
- */
- void implts_informListener( sal_Int32 eJob ,
- const css::frame::FeatureStateEvent& aEvent);
-
- //---------------------------------------
- /** short create a feature event struct, which can be send
- to any interested listener.
-
- @param eJob
- describe the current running operation
- AUTOSAVE, EMERGENCYSAVE, RECOVERY
-
- @param sEventType
- describe the type of this event
- START, STOP, UPDATE
-
- @param pInfo
- if sOperation is an update, this parameter must be different from NULL
- and is used to send information regarding the current handled document.
-
- @return [css::frame::FeatureStateEvent]
- the event structure for sending.
- */
- static css::frame::FeatureStateEvent implst_createFeatureStateEvent( sal_Int32 eJob ,
- const OUString& sEventType,
- AutoRecovery::TDocumentInfo* pInfo );
-
-
- class ListenerInformer
- {
- private:
- AutoRecovery &m_rRecovery;
- sal_Int32 m_eJob;
- bool m_bStopped;
- public:
- ListenerInformer(AutoRecovery &rRecovery, sal_Int32 eJob)
- : m_rRecovery(rRecovery), m_eJob(eJob), m_bStopped(false)
- {
- }
- void start();
- void stop();
- ~ListenerInformer()
- {
- stop();
- }
- };
-
- //---------------------------------------
-
- // TODO document me
- void implts_resetHandleStates(sal_Bool bLoadCache);
-
- //---------------------------------------
- // TODO document me
- void implts_specifyDefaultFilterAndExtension(AutoRecovery::TDocumentInfo& rInfo);
-
- //---------------------------------------
- // TODO document me
- void implts_specifyAppModuleAndFactory(AutoRecovery::TDocumentInfo& rInfo);
-
- /** retrieves the names of all active views of the given document
- @param rInfo
- the document info, whose <code>Document</code> member must not be <NULL/>.
- */
- void implts_collectActiveViewNames( AutoRecovery::TDocumentInfo& rInfo );
-
- /** updates the configuration so that for all documents, their current view/names are stored
- */
- void implts_persistAllActiveViewNames();
-
- //---------------------------------------
- // TODO document me
- void implts_prepareEmergencySave();
-
- //---------------------------------------
- // TODO document me
- void implts_doEmergencySave(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_doRecovery(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_doSessionSave(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_doSessionQuietQuit(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_doSessionRestore(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_backupWorkingEntry(const DispatchParams& aParams);
-
- //---------------------------------------
- // TODO document me
- void implts_cleanUpWorkingEntry(const DispatchParams& aParams);
-
- //---------------------------------------
- /** try to make sure that all changed config items (not our used
- config access only) will be flushed back to disc.
-
- E.g. our svtools::ConfigItems() has to be flushed explicitly .-(
-
- Note: This method cant fail. Flushing of config entries is an
- optional feature. Errors can be ignored.
- */
- void impl_flushALLConfigChanges();
-
- //---------------------------------------
- // TODO document me
- AutoRecovery::EFailureSafeResult implts_copyFile(const OUString& sSource ,
- const OUString& sTargetPath,
- const OUString& sTargetName);
-
- //---------------------------------------
- /** @short converts m_eJob into a job description, which
- can be used to inform an outside listener
- about the current running operation
-
- @param eJob
- describe the current running operation
- AUTOSAVE, EMERGENCYSAVE, RECOVERY
-
- @return [string]
- a suitable job description of form:
- vnd.sun.star.autorecovery:/do...
- */
- static OUString implst_getJobDescription(sal_Int32 eJob);
-
- //---------------------------------------
- /** @short mape the given URL to an internal int representation.
-
- @param aURL
- the url, which describe the next starting or may be already running
- operation.
-
- @return [long]
- the internal int representation
- see enum EJob
- */
- static sal_Int32 implst_classifyJob(const css::util::URL& aURL);
-
- /// TODO
- void implts_verifyCacheAgainstDesktopDocumentList();
-
- /// TODO document me
- sal_Bool impl_enoughDiscSpace(sal_Int32 nRequiredSpace);
-
- /// TODO document me
- static void impl_showFullDiscError();
-
- //---------------------------------------
- /** @short try to create/use a progress and set it inside the
- environment.
-
- @descr The problem behind: There exists different use case of this method.
- a) An external progress is provided by our CrashSave or Recovery dialog.
- b) We must create our own progress e.g. for an AutoSave
- c) Sometimes our application filters dont use the progress
- provided by the MediaDescriptor. They uses the Frame everytime to create
- it's own progress. So we implemented a HACK for these and now we set
- an InterceptedProgress there for the time WE use this frame for loading/storing documents .-)
-
- @param xNewFrame
- must be set only in case WE create a new frame (e.g. for loading documents
- on session restore or recovery). Then search for a frame using rInfo.Document must
- be supressed and xFrame must be preferred instead .-)
-
- @param rInfo
- used e.g. to find the frame corresponding to a document.
- This frame must be used to create a new progress e.g. for an AutoSave.
-
- @param rArgs
- is used to set the new created progress as parameter on these set.
- */
- void impl_establishProgress(const AutoRecovery::TDocumentInfo& rInfo ,
- utl::MediaDescriptor& rArgs ,
- const css::uno::Reference< css::frame::XFrame >& xNewFrame);
-
- void impl_forgetProgress(const AutoRecovery::TDocumentInfo& rInfo ,
- utl::MediaDescriptor& rArgs ,
- const css::uno::Reference< css::frame::XFrame >& xNewFrame);
-
- //---------------------------------------
- /** try to remove the specified file from disc.
-
- Every URL supported by our UCB component can be used here.
- Further it doesn't matter if the file really exists or not.
- Because removing a non exsistent file will have the same
- result at the end ... a non existing file .-)
-
- On the other side removing of files from disc is an optional
- feature. If we are not able doing so ... its not a real problem.
- Ok - users disc place will be samller then ... but we should produce
- a crash during crash save because we cant delete a temporary file only !
-
- @param sURL
- the url of the file, which should be removed.
- */
- void st_impl_removeFile(const OUString& sURL);
-
- //---------------------------------------
- /** try to remove ".lock" file from disc if office will be terminated
- not using the offical way .-)
-
- This method has to be handled "optional". So every error inside
- has to be ignored ! This method CANT FAIL ... it can forget something only .-)
- */
- void st_impl_removeLockFile();
-};
-
-} // namespace framework
-
-#endif // INCLUDED_FRAMEWORK_INC_SERVICES_AUTORECOVERY_HXX
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/framework/source/register/registerservices.cxx b/framework/source/register/registerservices.cxx
index b28fe16..9b85bf0 100644
--- a/framework/source/register/registerservices.cxx
+++ b/framework/source/register/registerservices.cxx
@@ -41,7 +41,6 @@
#include <uifactory/menubarfactory.hxx>
#include <uifactory/toolboxfactory.hxx>
#include "uiconfiguration/windowstateconfiguration.hxx"
-#include <services/autorecovery.hxx>
#include <uifactory/statusbarfactory.hxx>
#include <uiconfiguration/uicategorydescription.hxx>
#include <services/sessionlistener.hxx>
@@ -62,7 +61,6 @@ COMPONENTGETFACTORY ( fwk,
IFFACTORY( ::framework::ToolBoxFactory ) else
IFFACTORY( ::framework::WindowStateConfiguration ) else
IFFACTORY( ::framework::ToolbarControllerFactory ) else
- IFFACTORY( ::framework::AutoRecovery ) else
IFFACTORY( ::framework::StatusBarFactory ) else
IFFACTORY( ::framework::UICategoryDescription ) else
IFFACTORY( ::framework::SessionListener ) else
diff --git a/framework/source/services/autorecovery.cxx b/framework/source/services/autorecovery.cxx
index 1e12efc..0c6282e 100644
--- a/framework/source/services/autorecovery.cxx
+++ b/framework/source/services/autorecovery.cxx
@@ -19,7 +19,6 @@
#include <config_features.h>
-#include "services/autorecovery.hxx"
#include <loadenv/loadenv.hxx>
#include <loadenv/targethelper.hxx>
@@ -66,12 +65,26 @@
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/awt/XWindow2.hpp>
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
+#include <com/sun/star/lang/XTypeProvider.hpp>
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#include <com/sun/star/frame/XDispatch.hpp>
+#include <com/sun/star/document/XEventListener.hpp>
+#include <com/sun/star/document/XEventBroadcaster.hpp>
+#include <com/sun/star/util/XChangesListener.hpp>
+#include <com/sun/star/task/XStatusIndicator.hpp>
+#include <com/sun/star/util/XModifyListener.hpp>
#include <comphelper/configurationhelper.hxx>
+#include <cppuhelper/exc_hlp.hxx>
+#include <cppuhelper/implbase5.hxx>
+#include <cppuhelper/propshlp.hxx>
+#include <cppuhelper/supportsservice.hxx>
#include <unotools/mediadescriptor.hxx>
#include <comphelper/namedvaluecollection.hxx>
#include <comphelper/processfactory.hxx>
+#include <vcl/evntpost.hxx>
#include <vcl/svapp.hxx>
+#include <vcl/timer.hxx>
#include <unotools/pathoptions.hxx>
#include <tools/diagnose_ex.h>
#include <unotools/tempfile.hxx>
@@ -83,36 +96,1040 @@
#include <unotools/bootstrap.hxx>
#include <unotools/configmgr.hxx>
#include <svl/documentlockfile.hxx>
-#include <cppuhelper/exc_hlp.hxx>
-
#include <tools/urlobj.hxx>
-#include <fwkdllapi.h>
+#include <threadhelp/threadhelpbase.hxx>
+#include <macros/xinterface.hxx>
+#include <macros/xtypeprovider.hxx>
+#include <macros/xserviceinfo.hxx>
+#include <general.h>
+#include <stdtypes.h>
+
+using css::uno::Sequence;
+using css::uno::UNO_QUERY;
+using css::uno::UNO_QUERY_THROW;
+using css::uno::UNO_SET_THROW;
+using css::uno::Reference;
+using css::uno::Any;
+using css::beans::PropertyValue;
+using css::container::XEnumeration;
+using css::document::XDocumentRecovery;
+using css::frame::ModuleManager;
+using css::frame::XModel2;
+using css::frame::XModel;
+using css::frame::XFrame;
+using css::frame::XController2;
+using css::frame::XLoadable;
+using css::frame::XStorable;
+using css::lang::XComponent;
+using namespace framework;
+
+namespace {
+
+//---------------------------------------
+/** @short hold all needed information for an asynchronous dispatch alive.
+
+ @descr Because some operations are forced to be executed asynchronously
+ (e.g. requested by our CreashSave/Recovery dialog) ... we must make sure
+ that these information wont be set as "normal" members of our AtoRecovery
+ instance. Otherwise they can disturb our normal AutoSave-timer handling.
+ e.g. it can be unclear then, which progress has to be used for storing documents ...
+ */
+struct DispatchParams
+{
+public:
+ DispatchParams();
+ DispatchParams(const ::comphelper::SequenceAsHashMap& lArgs ,
+ const css::uno::Reference< css::uno::XInterface >& xOwner);
+ DispatchParams(const DispatchParams& rCopy);
+ ~DispatchParams();
+
+ DispatchParams& operator=(const DispatchParams& rCopy);
+ void forget();
+
+public:
+
+ //---------------------------------------
+ /** @short can be set from outside and is provided to
+ our internal started operations.
+
+ @descr Normaly we use the normal status indicator
+ of the document windows to show a progress.
+ But in case we are used by any special UI,
+ it can provide its own status indicator object
+ to us - so we use it instead of the normal one.
+ */
+ css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
-//_______________________________________________
-// namespaces
+ //---------------------------------------
+ /** TODO document me */
+ OUString m_sSavePath;
-using ::com::sun::star::uno::Sequence;
-using ::com::sun::star::uno::UNO_QUERY;
-using ::com::sun::star::uno::UNO_QUERY_THROW;
-using ::com::sun::star::uno::UNO_SET_THROW;
-using ::com::sun::star::uno::Reference;
-using ::com::sun::star::uno::Any;
-using ::com::sun::star::beans::PropertyValue;
-using ::com::sun::star::container::XEnumeration;
-using ::com::sun::star::document::XDocumentRecovery;
-using ::com::sun::star::frame::ModuleManager;
-using ::com::sun::star::frame::XModel2;
-using ::com::sun::star::frame::XModel;
-using ::com::sun::star::frame::XFrame;
-using ::com::sun::star::frame::XController2;
-using ::com::sun::star::frame::XLoadable;
-using ::com::sun::star::frame::XStorable;
-using ::com::sun::star::lang::XComponent;
+ //---------------------------------------
+ /** @short define the current cache entry, which should be used for current
+ backup or cleanUp operation ... which is may be done asynchronous */
+ sal_Int32 m_nWorkingEntryID;
+ //---------------------------------------
+ /** @short used for asyncoperations, to prevent us from dying.
-namespace framework
+ @descr If our dispatch() method was forced to start the
+ internal operation asynchronous ... we send an event
+ to start and return immediately. But we must be shure that
+ our instance live if the event callback reach us.
+ So we hold an uno reference to ourself.
+ */
+ css::uno::Reference< css::uno::XInterface > m_xHoldRefForAsyncOpAlive;
+};
+
+//_______________________________________________
+/**
+ implements the functionality of AutoSave and AutoRecovery
+ of documents - including features of an EmergencySave in
+ case a GPF occurs.
+ */
+typedef ::cppu::WeakImplHelper5<
+ css::lang::XServiceInfo,
+ css::frame::XDispatch,
+ css::document::XEventListener, // => css.lang.XEventListener
+ css::util::XChangesListener, // => css.lang.XEventListener
+ css::util::XModifyListener > // => css.lang.XEventListener
+ AutoRecovery_BASE;
+
+class AutoRecovery : // attention! Must be the first base class to guarentee right initialize lock ...
+ private ThreadHelpBase
+ , public ::cppu::OBroadcastHelper
+ , public ::cppu::OPropertySetHelper // => XPropertySet, XFastPropertySet, XMultiPropertySet
+ , public AutoRecovery_BASE
{
+public:
+
+ /** These values are used as flags and represent the current state of a document.
+ Every state of the life time of a document has to be recognized here.
+
+ @attention Do not change (means reorganize) already used numbers.
+ There exists some code inside SVX, which uses the same numbers,
+ to analyze such document states.
+ Not the best design ... but may be it will be changed later .-)
+ */
+ enum EDocStates
+ {
+ /* TEMP STATES */
+
+ /// default state, if a document was new created or loaded
+ E_UNKNOWN = 0,
+ /// modified against the original file
+ E_MODIFIED = 1,
+ /// an active document can be postponed to be saved later.
+ E_POSTPONED = 2,
+ /// was already handled during one AutoSave/Recovery session.
+ E_HANDLED = 4,
+ /** an action was started (saving/loading) ... Can be interesting later if the process may be was interrupted by an exception. */
+ E_TRY_SAVE = 8,
+ E_TRY_LOAD_BACKUP = 16,
+ E_TRY_LOAD_ORIGINAL = 32,
+
+ /* FINAL STATES */
+
+ /// the Auto/Emergency saved document isnt useable any longer
+ E_DAMAGED = 64,
+ /// the Auto/Emergency saved document isnt really up-to-date (some changes can be missing)
+ E_INCOMPLETE = 128,
+ /// the Auto/Emergency saved document was processed successfully
+ E_SUCCEDED = 512
+ };
+
+ /** @short indicates the results of a FAILURE_SAFE operation
+
+ @descr We must know, which reason was the real one in case
+ we couldnt copy a "failure document" to a user specified path.
+ We must know, if we can forget our cache entry or not.
+ */
+ enum EFailureSafeResult
+ {
+ E_COPIED,
+ E_ORIGINAL_FILE_MISSING,
+ E_WRONG_TARGET_PATH
+ };
+
+ // TODO document me
+ enum ETimerType
+ {
+ /** the timer should not be used next time */
+ E_DONT_START_TIMER,
+ /** timer (was/must be) started with normal AutoSaveTimeIntervall */
+ E_NORMAL_AUTOSAVE_INTERVALL,
+ /** timer must be started with special short time intervall,
+ to poll for an user idle period */
+ E_POLL_FOR_USER_IDLE,
+ /** timer mst be started with a very(!) short time intervall,
+ to poll for the end of an user action, which does not allow saving documents in general */
+ E_POLL_TILL_AUTOSAVE_IS_ALLOWED,
+ /** dont start the timer - but calls the same action then before immediately again! */
+ E_CALL_ME_BACK
+ };
+
+ // TODO document me ... flag field
+ // Emergency_Save and Recovery overwrites Auto_Save!
+ enum EJob
+ {
+ E_NO_JOB = 0,
+ E_AUTO_SAVE = 1,
+ E_EMERGENCY_SAVE = 2,
+ E_RECOVERY = 4,
+ E_ENTRY_BACKUP = 8,
+ E_ENTRY_CLEANUP = 16,
+ E_PREPARE_EMERGENCY_SAVE = 32,
+ E_SESSION_SAVE = 64,
+ E_SESSION_RESTORE = 128,
+ E_DISABLE_AUTORECOVERY = 256,
+ E_SET_AUTOSAVE_STATE = 512,
+ E_SESSION_QUIET_QUIT = 1024,
+ E_USER_AUTO_SAVE = 2048
+ };
+
+ //---------------------------------------
+ /** @short combine different information about one office document. */
+ struct TDocumentInfo
+ {
+ public:
+
+ //-------------------------------
+ TDocumentInfo()
+ : DocumentState (E_UNKNOWN)
+ , UsedForSaving (sal_False)
+ , ListenForModify (sal_False)
+ , IgnoreClosing (sal_False)
+ , ID (-1 )
+ {}
+
+ //-------------------------------
+ /** @short points to the document. */
+ css::uno::Reference< css::frame::XModel > Document;
+
+ //-------------------------------
+ /** @short knows, if the document is really modified since the last autosave,
+ or was postponed, because it was an active one etcpp...
+
+ @descr Because we have no CHANGE TRACKING mechanism, based on office document,
+ we implements it by ourself. We listen for MODIFIED events
+ of each document and update this state flag here.
+
+ Further we postpone saving of active documents, e.g. if the user
+ works currently on it. We wait for an idle period then ...
+ */
+ sal_Int32 DocumentState;
+
+ //-------------------------------
+ /** Because our applications not ready for concurrent save requests at the same time,
+ we have supress our own AutoSave for the moment, a document will be already saved
+ by others.
+ */
+ sal_Bool UsedForSaving;
+
+ //-------------------------------
+ /** For every user action, which modifies a document (e.g. key input) we get
+ a notification as XModifyListener. That seams to be a "performance issue" .-)
+ So we decided to listen for such modify events only for the time in which the document
+ was stored as temp. file and was not modified again by the user.
+ */
+ sal_Bool ListenForModify;
+
+ //-------------------------------
+ /** For SessionSave we must close all open documents by ourself.
+ But because we are listen for documents events, we get some ...
+ and deregister these documents from our configuration.
+ That's why we mark these documents as "Closed by ourself" so we can
+ ignore these "OnUnload" or disposing() events .-)
+ */
+ sal_Bool IgnoreClosing;
+
+ //-------------------------------
+ /** TODO: document me */
+ OUString OrgURL;
+ OUString FactoryURL;
+ OUString TemplateURL;
+
+ OUString OldTempURL;
+ OUString NewTempURL;
+
+ OUString AppModule; // e.g. com.sun.star.text.TextDocument - used to identify app module
+ OUString FactoryService; // the service to create a document of the module
+ OUString RealFilter; // real filter, which was used at loading time
+ OUString DefaultFilter; // supports saving of the default format without loosing data
+ OUString Extension; // file extension of the default filter
+ OUString Title; // can be used as "DisplayName" on every recovery UI!
+ css::uno::Sequence< OUString >
+ ViewNames; // names of the view which were active at emergency-save time
+
+ sal_Int32 ID;
+ };
+
+ //---------------------------------------
+ /** @short used to know every currently open document. */
+ typedef ::std::vector< TDocumentInfo > TDocumentList;
+
+//___________________________________________
+// member
+
+private:
+
+ //---------------------------------------
+ /** @short the global uno service manager.
+ @descr Must be used to create own needed services.
+ */
+ css::uno::Reference< css::uno::XComponentContext > m_xContext;
+
+ //---------------------------------------
+ /** @short points to the underlying recovery configuration.
+ @descr This instance does not cache - it calls directly the
+ configuration API!
+ */
+ css::uno::Reference< css::container::XNameAccess > m_xRecoveryCFG;
+
+ //---------------------------------------
+ /** @short proxy weak binding to forward Events to ourself without
+ an ownership cycle
+ */
+ css::uno::Reference< css::util::XChangesListener > m_xRecoveryCFGListener;
+
+ //---------------------------------------
+ /** @short points to the used configuration package or.openoffice.Setup
+ @descr This instance does not cache - it calls directly the
+ configuration API!
+ */
+ css::uno::Reference< css::container::XNameAccess > m_xModuleCFG;
+
+ //---------------------------------------
+ /** @short holds the global event broadcaster alive,
+ where we listen for new created documents.
+ */
+ css::uno::Reference< css::frame::XGlobalEventBroadcaster > m_xNewDocBroadcaster;
+
+ //---------------------------------------
+ /** @short proxy weak binding to forward Events to ourself without
+ an ownership cycle
+ */
+ css::uno::Reference< css::document::XEventListener > m_xNewDocBroadcasterListener;
+
+ //---------------------------------------
+ /** @short because we stop/restart listening sometimes, it's a good idea to know
+ if we already registered as listener .-)
+ */
+ sal_Bool m_bListenForDocEvents;
+ sal_Bool m_bListenForConfigChanges;
+
+ //---------------------------------------
+ /** @short specify the time intervall between two save actions.
+ @descr Time is measured in [min].
+ */
+ sal_Int32 m_nAutoSaveTimeIntervall;
+
+ //---------------------------------------
+ /** @short for an asynchronous operation we must know, if there is
+ at least one running job (may be asynchronous!).
+ */
+ sal_Int32 m_eJob;
+
+ //---------------------------------------
+ /** @short the timer, which is used to be informed about the next
+ saving time ...
+ */
+ Timer m_aTimer;
+
+ //---------------------------------------
+ /** @short make our dispatch asynchronous ... if required to do so! */
+ ::vcl::EventPoster m_aAsyncDispatcher;
+
+ //---------------------------------------
+ /** @see DispatchParams
+ */
+ DispatchParams m_aDispatchParams;
+
+ //---------------------------------------
+ /** @short indicates, which time period is currently used by the
+ internal timer.
+ */
+ ETimerType m_eTimerType;
+
+ //---------------------------------------
+ /** @short this cache is used to hold all information about
+ recovery/emergency save documents alive.
+ */
+ TDocumentList m_lDocCache;
+
+ //---------------------------------------
+ // TODO document me
+ sal_Int32 m_nIdPool;
+
+ //---------------------------------------
+ /** @short contains all status listener registered at this instance.
+ */
+ ListenerHash m_lListener;
+
+ /** @descr This member is used to prevent us against re-entrance problems.
+ A mutex cant help to prevent us from concurrent using of members
+ inside the same thread. But e.g. our internaly used stl structures
+ are not threadsafe ... and furthermore they cant be used at the same time
+ for iteration and add/remove requests!
+ So we have to detect such states and ... show a warning.
+ May be there will be a better solution next time ... (copying the cache temp.
+ bevor using).
+
+ And further it's not possible to use a simple boolean value here.
+ Because if more then one operation iterates over the same stl container ...
+ (only to modify it's elements but dont add new or removing existing ones!)
+ it should be possible doing so. But we must guarantee that the last operation reset
+ this lock ... not the first one ! So we use a "ref count" mechanism for that."
+ */
+ sal_Int32 m_nDocCacheLock;
+
+ /** @descr These members are used to check the minimum disc space, which must exists
+ to start the corresponding operation.
+ */
+ sal_Int32 m_nMinSpaceDocSave;
+ sal_Int32 m_nMinSpaceConfigSave;
+
+ //---------------------------------------
+ /** @short special debug option to make testing faster.
+
+ @descr We dont interpret the timer unit as [min] ...
+ we use [ms] instead of that. Further we dont
+ wait 10 s for user idle ...
+ */
+ #if OSL_DEBUG_LEVEL > 1
+ sal_Bool m_dbg_bMakeItFaster;
+ #endif
+
+ //---------------------------------------
+ // HACK ... TODO
+ css::uno::Reference< css::task::XStatusIndicator > m_xExternalProgress;
+
+//___________________________________________
+// interface
+
+public:
+
+ AutoRecovery(const css::uno::Reference< css::uno::XComponentContext >& xContext);
+ virtual ~AutoRecovery( );
+
+ void onCreate();
+
+ virtual OUString SAL_CALL getImplementationName()
+ throw (css::uno::RuntimeException)
+ {
+ return OUString("com.sun.star.comp.framework.AutoRecovery");
+ }
+
+ virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName)
+ throw (css::uno::RuntimeException)
+ {
+ return cppu::supportsService(this, ServiceName);
+ }
+
+ virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames()
+ throw (css::uno::RuntimeException)
+ {
+ css::uno::Sequence< OUString > aSeq(1);
+ aSeq[0] = OUString("com.sun.star.frame.AutoRecovery");
+ return aSeq;
+ }
+
+ // XInterface
+ virtual void SAL_CALL acquire() throw ()
+ { OWeakObject::acquire(); }
+ virtual void SAL_CALL release() throw ()
+ { OWeakObject::release(); }
+ virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& type) throw ( css::uno::RuntimeException );
+
+ // XTypeProvider
+ virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) throw(css::uno::RuntimeException);
+
+ //---------------------------------------
+ // css.frame.XDispatch
+ virtual void SAL_CALL dispatch(const css::util::URL& aURL ,
+ const css::uno::Sequence< css::beans::PropertyValue >& lArguments)
+ throw(css::uno::RuntimeException);
+
+ virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
+ const css::util::URL& aURL )
+ throw(css::uno::RuntimeException);
+
+ virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
+ const css::util::URL& aURL )
+ throw(css::uno::RuntimeException);
+
+ //---------------------------------------
+ // css.document.XEventListener
+ /** @short informs about created/opened documents.
+
+ @descr Every new opened/created document will be saved internaly
+ so it can be checked if its modified. This modified state
+ is used later to decide, if it must be saved or not.
+
+ @param aEvent
+ points to the new created/opened document.
+ */
+ virtual void SAL_CALL notifyEvent(const css::document::EventObject& aEvent)
+ throw(css::uno::RuntimeException);
+
+ //---------------------------------------
+ // css.util.XChangesListener
+ virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
+ throw(css::uno::RuntimeException);
+
+ //---------------------------------------
+ // css.util.XModifyListener
+ virtual void SAL_CALL modified(const css::lang::EventObject& aEvent)
+ throw(css::uno::RuntimeException);
+
+ //---------------------------------------
+ // css.lang.XEventListener
+ using cppu::OPropertySetHelper::disposing;
+ virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
+ throw(css::uno::RuntimeException);
+
+//___________________________________________
+// helper
+
+protected:
+
+ //---------------------------------------
+ // OPropertySetHelper
+
+ virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& aConvertedValue,
+ css::uno::Any& aOldValue ,
+ sal_Int32 nHandle ,
+ const css::uno::Any& aValue )
+ throw(css::lang::IllegalArgumentException);
+
+ virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle,
+ const css::uno::Any& aValue )
+ throw(css::uno::Exception);
+ using cppu::OPropertySetHelper::getFastPropertyValue;
+ virtual void SAL_CALL getFastPropertyValue(css::uno::Any& aValue ,
+ sal_Int32 nHandle) const;
+
+ virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
+
+ virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
+ throw(css::uno::RuntimeException);
+//___________________________________________
+// helper
+
+private:
+
+ //---------------------------------------
+ /** @short open the underlying configuration.
+
+ @descr This method must be called every time
+ a configuartion call is needed. Because
+ method works together with the member
+ m_xCFG, open it on demand and cache it
+ afterwards.
+
+ @return [com.sun.star.container.XNameAccess]
+ the configuration object
+
+ @throw [com.sun.star.uno.RuntimeException]
+ if config could not be opened successfully!
+
+ @threadsafe
+ */
+ css::uno::Reference< css::container::XNameAccess > implts_openConfig();
+
+ //---------------------------------------
+ /** @short read the underlying configuration.
+
+ @descr After that we know the initial state - means:
+ - if AutoSave was enabled by the user
+ - which time intervall has to be used
+ - which recovery entries may already exists
+
+ @throw [com.sun.star.uno.RuntimeException]
+ if config could not be opened or readed successfully!
+
+ @threadsafe
+ */
+ void implts_readConfig();
+
+ //---------------------------------------
+ /** @short read the underlying configuration...
+
+ @descr ... but only keys related to the AutoSave mechanism.
+ Means: State and Timer intervall.
+ E.g. the recovery list isnt adressed here.
+
+ @throw [com.sun.star.uno.RuntimeException]
+ if config could not be opened or readed successfully!
+
+ @threadsafe
+ */
+ void implts_readAutoSaveConfig();
+
+ //---------------------------------------
+ // TODO document me
+ void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo ,
+ sal_Bool bRemoveIt = sal_False);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_startListening();
+ void implts_startModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_stopListening();
+ void implts_stopModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
+
+ //---------------------------------------
+ /** @short stops and may be(!) restarts the timer.
+
+ @descr A running timer is stopped every time here.
+ But starting depends from the different internal
+ timer variables (e.g. AutoSaveEnabled, AutoSaveTimeIntervall,
+ TimerType etcpp.)
+
+ @throw [com.sun.star.uno.RuntimeException]
+ if timer could not be stopped or started!
+
+ @threadsafe
+ */
+ void implts_updateTimer();
+
+ //---------------------------------------
+ /** @short stop the timer.
+
+ @descr Double calls will be ignored - means we do
+ nothing here, if the timer is already disabled.
+
+ @throw [com.sun.star.uno.RuntimeException]
+ if timer could not be stopped!
+
+ @threadsafe
+ */
+ void implts_stopTimer();
+
+ //---------------------------------------
+ /** @short callback of our internal timer.
+ */
+ DECL_LINK(implts_timerExpired, void*);
+
+ //---------------------------------------
+ /** @short makes our dispatch() method asynchronous!
+ */
+ DECL_LINK(implts_asyncDispatch, void*);
+
+ //---------------------------------------
+ /** @short implements the dispatch real. */
+ void implts_dispatch(const DispatchParams& aParams);
+
+ //---------------------------------------
+ /** @short validate new detected document and add it into the internal
+ document list.
+
+ @descr This method should be called only, if its clear that a new
+ document was opened/created during office runtime.
+ This method checks, if it's a top level document (means not an embedded one).
+ Only such top level documents can be recognized by this auto save mechanism.
+
+ @param xDocument
+ the new document, which should be checked and registered.
+
+ @threadsafe
+ */
+ void implts_registerDocument(const css::uno::Reference< css::frame::XModel >& xDocument);
+
+ //---------------------------------------
+ /** @short remove the specified document from our internal document list.
+
+ @param xDocument
+ the new document, which should be deregistered.
+
+ @param bStopListening
+ sal_False: must be used in case this method is called withion disposing() of the document,
+ where it make no sense to deregister our listener. The container dies ...
+ sal_True : must be used in case this method is used on "dergistration" of this document, where
+ we must deregister our listener .-)
+
+ @threadsafe
+ */
+ void implts_deregisterDocument(const css::uno::Reference< css::frame::XModel >& xDocument ,
+ sal_Bool bStopListening = sal_True);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_markDocumentModifiedAgainstLastBackup(const css::uno::Reference< css::frame::XModel >& xDocument);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_updateModifiedState(const css::uno::Reference< css::frame::XModel >& xDocument);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_updateDocumentUsedForSavingState(const css::uno::Reference< css::frame::XModel >& xDocument ,
+ sal_Bool bSaveInProgress);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_markDocumentAsSaved(const css::uno::Reference< css::frame::XModel >& xDocument);
+
+ //---------------------------------------
+ /** @short search a document inside given list.
+
+ @param rList
+ reference to a vector, which can contain such
+ document.
+
+ @param xDocument
+ the document, which should be located inside the
+ given list.
+
+ @return [TDocumentList::iterator]
+ which points to the located document.
+ If document does not exists - its set to
+ rList.end()!
+ */
+ static TDocumentList::iterator impl_searchDocument( AutoRecovery::TDocumentList& rList ,
+ const css::uno::Reference< css::frame::XModel >& xDocument);
+
+ //---------------------------------------
+ /** TODO document me */
+ void implts_changeAllDocVisibility(sal_Bool bVisible);
+ void implts_prepareSessionShutdown();
+
+ //---------------------------------------
+ /** @short save all current opened documents to a specific
+ backup directory.
+
+ @descr Only really changed documents will be saved here.
+
+ Further this method returns a suggestion, if and how it should
+ be called again. May be some documents was not saved yet
+ and must wait for an user idle period ...
+
+ @param bAllowUserIdleLoop
+ Because this method is used for different uses cases, it must
+ know, which actions are allowed or not.
+ AUTO_SAVE =>
+ If a document is the most active one, saving it
+ will be postponed if there exists other unsaved
+ documents. This feature was implemented, because
+ we dont wish to disturb the user on it's work.
+ ... bAllowUserIdleLoop should be set to sal_True
+ EMERGENCY_SAVE / SESSION_SAVE =>
+ Here we must finish our work ASAP! It's not allowed
+ to postpone any document.
+ ... bAllowUserIdleLoop must(!) be set to sal_False
+
+ @param pParams
+ sometimes this method is required inside an external dispatch request.
+ The it contains some special environment variables, which overwrites
+ our normal environment.
+ AutoSave => pParams == 0
+ SessionSave/CrashSave => pParams != 0
+
+ @return A suggestion, how the timer (if its not already disabled!)
+ should be restarted to full fill the requirements.
+
+ @threadsafe
+ */
+ AutoRecovery::ETimerType implts_saveDocs( sal_Bool bAllowUserIdleLoop,
+ sal_Bool bRemoveLockFiles,
+ const DispatchParams* pParams = 0);
+
+ //---------------------------------------
+ /** @short save one of the current documents to a specific
+ backup directory.
+
+ @descr It:
+ - defines a new(!) unique temp file name
+ - save the new temp file
+ - remove the old temp file
+ - patch the given info struct
+ - and return errors.
+
+ It does not:
+ - patch the configuration.
+
+ Note further: It paches the info struct
+ more then ones. E.g. the new temp URL is set
+ before the file is saved. And the old URL is removed
+ only if removing oft he old file was successfully.
+ If this method returns without an exception - everything
+ was OK. Otherwise the info struct can be analyzed to
+ get more information, e.g. when the problem occurs.
+
+ @param sBackupPath
+ the base path for saving such temp files.
+
+ @param rInfo
+ points to an information structure, where
+ e.g. the document, its modified state, the count
+ of autosave-retries etcpp. exists.
+ Its used also to return the new temp file name
+ and some other state values!
+
+ @threadsafe
+ */
+ void implts_saveOneDoc(const OUString& sBackupPath ,
+ AutoRecovery::TDocumentInfo& rInfo ,
+ const css::uno::Reference< css::task::XStatusIndicator >& xExternalProgress);
+
+ //---------------------------------------
+ /** @short recovery all documents, which was saved during
+ a crash before.
+
+ @return A suggestion, how this method must be called back!
+
+ @threadsafe
+ */
+ AutoRecovery::ETimerType implts_openDocs(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_openOneDoc(const OUString& sURL ,
+ utl::MediaDescriptor& lDescriptor,
+ AutoRecovery::TDocumentInfo& rInfo );
+
+ //---------------------------------------
+ // TODO document me
+ void implts_generateNewTempURL(const OUString& sBackupPath ,
+ utl::MediaDescriptor& rMediaDescriptor,
+ AutoRecovery::TDocumentInfo& rInfo );
+
+ //---------------------------------------
+ /** @short notifies all interested listener about the current state
+ of the currently running operation.
+
+ @descr We support different set's of functions. AUTO_SAVE, EMERGENCY_SAVE,
+ AUTO_RECOVERY, FAILURE_SAVE ... etcpp.
+ Listener can register itself for any type of supported
+ functionality ... but not for document URL's in special.
+
+ @param eJob
+ is used to know, which set of listener we must notify.
+
+ @param aEvent
+ describe the event more in detail.
+
+ @threadsafe
+ */
+ void implts_informListener( sal_Int32 eJob ,
+ const css::frame::FeatureStateEvent& aEvent);
+
+ //---------------------------------------
+ /** short create a feature event struct, which can be send
+ to any interested listener.
+
+ @param eJob
+ describe the current running operation
+ AUTOSAVE, EMERGENCYSAVE, RECOVERY
+
+ @param sEventType
+ describe the type of this event
+ START, STOP, UPDATE
+
+ @param pInfo
+ if sOperation is an update, this parameter must be different from NULL
+ and is used to send information regarding the current handled document.
+
+ @return [css::frame::FeatureStateEvent]
+ the event structure for sending.
+ */
+ static css::frame::FeatureStateEvent implst_createFeatureStateEvent( sal_Int32 eJob ,
+ const OUString& sEventType,
+ AutoRecovery::TDocumentInfo* pInfo );
+
+
+ class ListenerInformer
+ {
+ private:
+ AutoRecovery &m_rRecovery;
+ sal_Int32 m_eJob;
+ bool m_bStopped;
+ public:
+ ListenerInformer(AutoRecovery &rRecovery, sal_Int32 eJob)
+ : m_rRecovery(rRecovery), m_eJob(eJob), m_bStopped(false)
+ {
+ }
+ void start();
+ void stop();
+ ~ListenerInformer()
+ {
+ stop();
+ }
+ };
+
+ //---------------------------------------
+
+ // TODO document me
+ void implts_resetHandleStates(sal_Bool bLoadCache);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_specifyDefaultFilterAndExtension(AutoRecovery::TDocumentInfo& rInfo);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_specifyAppModuleAndFactory(AutoRecovery::TDocumentInfo& rInfo);
+
+ /** retrieves the names of all active views of the given document
+ @param rInfo
+ the document info, whose <code>Document</code> member must not be <NULL/>.
+ */
+ void implts_collectActiveViewNames( AutoRecovery::TDocumentInfo& rInfo );
+
+ /** updates the configuration so that for all documents, their current view/names are stored
+ */
+ void implts_persistAllActiveViewNames();
+
+ //---------------------------------------
+ // TODO document me
+ void implts_prepareEmergencySave();
+
+ //---------------------------------------
+ // TODO document me
+ void implts_doEmergencySave(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_doRecovery(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_doSessionSave(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_doSessionQuietQuit(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_doSessionRestore(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_backupWorkingEntry(const DispatchParams& aParams);
+
+ //---------------------------------------
+ // TODO document me
+ void implts_cleanUpWorkingEntry(const DispatchParams& aParams);
+
+ //---------------------------------------
+ /** try to make sure that all changed config items (not our used
+ config access only) will be flushed back to disc.
+
+ E.g. our svtools::ConfigItems() has to be flushed explicitly .-(
+
+ Note: This method cant fail. Flushing of config entries is an
+ optional feature. Errors can be ignored.
+ */
+ void impl_flushALLConfigChanges();
+
+ //---------------------------------------
+ // TODO document me
+ AutoRecovery::EFailureSafeResult implts_copyFile(const OUString& sSource ,
+ const OUString& sTargetPath,
+ const OUString& sTargetName);
+
+ //---------------------------------------
+ /** @short converts m_eJob into a job description, which
+ can be used to inform an outside listener
+ about the current running operation
+
+ @param eJob
+ describe the current running operation
+ AUTOSAVE, EMERGENCYSAVE, RECOVERY
+
+ @return [string]
+ a suitable job description of form:
+ vnd.sun.star.autorecovery:/do...
+ */
+ static OUString implst_getJobDescription(sal_Int32 eJob);
+
+ //---------------------------------------
+ /** @short mape the given URL to an internal int representation.
+
+ @param aURL
+ the url, which describe the next starting or may be already running
+ operation.
+
+ @return [long]
+ the internal int representation
+ see enum EJob
+ */
+ static sal_Int32 implst_classifyJob(const css::util::URL& aURL);
+
+ /// TODO
+ void implts_verifyCacheAgainstDesktopDocumentList();
+
+ /// TODO document me
+ sal_Bool impl_enoughDiscSpace(sal_Int32 nRequiredSpace);
+
+ /// TODO document me
+ static void impl_showFullDiscError();
+
+ //---------------------------------------
+ /** @short try to create/use a progress and set it inside the
+ environment.
+
+ @descr The problem behind: There exists different use case of this method.
+ a) An external progress is provided by our CrashSave or Recovery dialog.
+ b) We must create our own progress e.g. for an AutoSave
+ c) Sometimes our application filters dont use the progress
+ provided by the MediaDescriptor. They uses the Frame everytime to create
+ it's own progress. So we implemented a HACK for these and now we set
+ an InterceptedProgress there for the time WE use this frame for loading/storing documents .-)
+
+ @param xNewFrame
+ must be set only in case WE create a new frame (e.g. for loading documents
+ on session restore or recovery). Then search for a frame using rInfo.Document must
+ be supressed and xFrame must be preferred instead .-)
+
+ @param rInfo
+ used e.g. to find the frame corresponding to a document.
+ This frame must be used to create a new progress e.g. for an AutoSave.
+
+ @param rArgs
+ is used to set the new created progress as parameter on these set.
+ */
+ void impl_establishProgress(const AutoRecovery::TDocumentInfo& rInfo ,
+ utl::MediaDescriptor& rArgs ,
+ const css::uno::Reference< css::frame::XFrame >& xNewFrame);
+
+ void impl_forgetProgress(const AutoRecovery::TDocumentInfo& rInfo ,
+ utl::MediaDescriptor& rArgs ,
+ const css::uno::Reference< css::frame::XFrame >& xNewFrame);
+
+ //---------------------------------------
+ /** try to remove the specified file from disc.
+
+ Every URL supported by our UCB component can be used here.
+ Further it doesn't matter if the file really exists or not.
+ Because removing a non exsistent file will have the same
+ result at the end ... a non existing file .-)
+
+ On the other side removing of files from disc is an optional
+ feature. If we are not able doing so ... its not a real problem.
+ Ok - users disc place will be samller then ... but we should produce
+ a crash during crash save because we cant delete a temporary file only !
+
+ @param sURL
+ the url of the file, which should be removed.
+ */
+ void st_impl_removeFile(const OUString& sURL);
+
+ //---------------------------------------
+ /** try to remove ".lock" file from disc if office will be terminated
+ not using the offical way .-)
+
+ This method has to be handled "optional". So every error inside
+ has to be ignored ! This method CANT FAIL ... it can forget something only .-)
+ */
+ void st_impl_removeLockFile();
+};
+
//-----------------------------------------------
// recovery.xcu
@@ -377,33 +1394,6 @@ void DispatchParams::forget()
};
//-----------------------------------------------
-DEFINE_XSERVICEINFO_ONEINSTANCESERVICE_2(AutoRecovery ,
- ::cppu::OWeakObject ,
- "com.sun.star.frame.AutoRecovery",
- IMPLEMENTATIONNAME_AUTORECOVERY)
-
-//-----------------------------------------------
-DEFINE_INIT_SERVICE(
- AutoRecovery,
- {
- /*Attention
- I think we don't need any mutex or lock here ... because we are called by our own static method impl_createInstance()
- to create a new instance of this class by our own supported service factory.
- see macro DEFINE_XSERVICEINFO_MULTISERVICE and "impl_initService()" for further information!
- */
-
- // read configuration to know if autosave/recovery is on/off etcpp...
- implts_readConfig();
-
- implts_startListening();
-
- // establish callback for our internal used timer.
- // Note: Its only active, if the timer will be started ...
- m_aTimer.SetTimeoutHdl(LINK(this, AutoRecovery, implts_timerExpired));
- }
- )
-
-//-----------------------------------------------
AutoRecovery::AutoRecovery(const css::uno::Reference< css::uno::XComponentContext >& xContext)
: ThreadHelpBase (&Application::GetSolarMutex() )
, ::cppu::OBroadcastHelper ( m_aLock.getShareableOslMutex() )
@@ -427,6 +1417,18 @@ AutoRecovery::AutoRecovery(const css::uno::Reference< css::uno::XComponentContex
{
}
+void AutoRecovery::onCreate()
+{
+ // read configuration to know if autosave/recovery is on/off etcpp...
+ implts_readConfig();
+
+ implts_startListening();
+
+ // establish callback for our internal used timer.
+ // Note: Its only active, if the timer will be started ...
+ m_aTimer.SetTimeoutHdl(LINK(this, AutoRecovery, implts_timerExpired));
+}
+
//-----------------------------------------------
AutoRecovery::~AutoRecovery()
{
@@ -3626,6 +4628,17 @@ void AutoRecovery::st_impl_removeLockFile()
}
}
-} // namespace framework
+}
+
+extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
+com_sun_star_comp_framework_AutoRecovery_get_implementation(
+ css::uno::XComponentContext *context,
+ css::uno::Sequence<css::uno::Any> const &)
+{
+ rtl::Reference<AutoRecovery> x(new AutoRecovery(context));
+ x->onCreate();
+ x->acquire();
+ return static_cast<cppu::OWeakObject *>(x.get());
+}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/framework/util/fwk.component b/framework/util/fwk.component
index 7d6f394..336052e 100644
--- a/framework/util/fwk.component
+++ b/framework/util/fwk.component
@@ -26,7 +26,8 @@
constructor="com_sun_star_comp_framework_AddonsToolBarFactory_get_implementation">
<service name="com.sun.star.ui.ToolBarFactory"/>
</implementation>
- <implementation name="com.sun.star.comp.framework.AutoRecovery">
+ <implementation name="com.sun.star.comp.framework.AutoRecovery"
+ constructor="com_sun_star_comp_framework_AutoRecovery_get_implementation">
<service name="com.sun.star.frame.AutoRecovery"/>
</implementation>
<implementation name="com.sun.star.comp.framework.ControlMenuController"
More information about the Libreoffice-commits
mailing list