?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
update dev300-m58
[ooovba.git] / framework / inc / services / autorecovery.hxx
blobab249fc5ba1157387fa30d057d033969f2aa10d0
1 /*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * $RCSfile: autorecovery.hxx,v $
10 * $Revision: 1.15 $
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************/
30
31 #ifndef __FRAMEWORK_SERVICES_AUTORECOVERY_HXX_
32 #define __FRAMEWORK_SERVICES_AUTORECOVERY_HXX_
33
34 //_______________________________________________
35 // own includes
36
37 #include <threadhelp/threadhelpbase.hxx>
38 #include <macros/xinterface.hxx>
39 #include <macros/xtypeprovider.hxx>
40 #include <macros/xserviceinfo.hxx>
41 #include <general.h>
42 #include <stdtypes.h>
43
44 //_______________________________________________
45 // interface includes
46 #include <com/sun/star/uno/XInterface.hpp>
47 #include <com/sun/star/lang/XTypeProvider.hpp>
48 #include <com/sun/star/lang/XServiceInfo.hpp>
49 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
50 #include <com/sun/star/frame/XDispatch.hpp>
51 #include <com/sun/star/container/XNameAccess.hpp>
52 #include <com/sun/star/document/XEventListener.hpp>
53 #include <com/sun/star/document/XEventBroadcaster.hpp>
54 #include <com/sun/star/frame/XModel.hpp>
55 #include <com/sun/star/util/XChangesListener.hpp>
56 #include <com/sun/star/task/XStatusIndicator.hpp>
57 #include <com/sun/star/util/XModifyListener.hpp>
58
59 //_______________________________________________
60 // other includes
61 #include <comphelper/mediadescriptor.hxx>
62 #include <vcl/timer.hxx>
63 #include <vcl/evntpost.hxx>
64 #include <cppuhelper/interfacecontainer.hxx>
65 #include <cppuhelper/propshlp.hxx>
66 #include <cppuhelper/weak.hxx>
67
68 //_______________________________________________
69 // definition
70
71 #ifndef css
72 namespace css = ::com::sun::star;
73 #endif
74
75 namespace framework
76 {
77
78 //---------------------------------------
79 /** @short hold all needed informations for an asynchronous dispatch alive.
80
81 @descr Because some operations are forced to be executed asynchronously
82 (e.g. requested by our CreashSave/Recovery dialog) ... we must make sure
83 that these informations wont be set as "normal" members of our AtoRecovery
84 instance. Otherwise they can disturb our normal AutoSave-timer handling.
85 e.g. it can be unclear then, which progress has to be used for storing documents ...
86 */
87 struct DispatchParams
88 {
89 public:
90 DispatchParams();
91 DispatchParams(const ::comphelper::SequenceAsHashMap& lArgs ,
92 const css::uno::Reference< css::uno::XInterface >& xOwner);
93 DispatchParams(const DispatchParams& rCopy);
94 ~DispatchParams();
95
96 DispatchParams& operator=(const DispatchParams& rCopy);
97 void forget();
98
99 public:
100
101 //---------------------------------------
102 /** @short can be set from outside and is provided to
103 our internal started operations.
104
105 @descr Normaly we use the normal status indicator
106 of the document windows to show a progress.
107 But in case we are used by any special UI,
108 it can provide its own status indicator object
109 to us - so we use it instead of the normal one.
110 */
111 css::uno::Reference< css::task::XStatusIndicator > m_xProgress;
112
113 //---------------------------------------
114 /** TODO document me */
115 ::rtl::OUString m_sSavePath;
116
117 //---------------------------------------
118 /** @short define the current cache entry, which should be used for current
119 backup or cleanUp operation ... which is may be done asynchronous */
120 sal_Int32 m_nWorkingEntryID;
121
122 //---------------------------------------
123 /** @short used for asyncoperations, to prevent us from dying.
124
125 @descr If our dispatch() method was forced to start the
126 internal operation asynchronous ... we send an event
127 to start and return immediatly. But we must be shure that
128 our instance live if the event callback reach us.
129 So we hold an uno reference to ourself.
130 */
131 css::uno::Reference< css::uno::XInterface > m_xHoldRefForAsyncOpAlive;
132 };
133
134 //_______________________________________________
135 /**
136 implements the functionality of AutoSave and AutoRecovery
137 of documents - including features of an EmergencySave in
138 case a GPF occures.
139 */
140 class AutoRecovery : public css::lang::XTypeProvider
141 , public css::lang::XServiceInfo
142 , public css::frame::XDispatch
143 , public css::document::XEventListener // => css.lang.XEventListener
144 , public css::util::XChangesListener // => css.lang.XEventListener
145 , public css::util::XModifyListener // => css.lang.XEventListener
146 // attention! Must be the first base class to guarentee right initialize lock ...
147 , private ThreadHelpBase
148 , public ::cppu::OBroadcastHelper
149 , public ::cppu::OPropertySetHelper // => XPropertySet, XFastPropertySet, XMultiPropertySet
150 , public ::cppu::OWeakObject
151 {
152 //___________________________________________
153 // types
154
155 public:
156
157 /** These values are used as flags and represent the current state of a document.
158 Every state of the life time of a document has to be recognized here.
159
160 @attention Do not change (means reorganize) already used numbers.
161 There exists some code inside SVX, which uses the same numbers,
162 to analyze such document states.
163 Not the best design ... but may be it will be changed later .-)
164 */
165 enum EDocStates
166 {
167 /* TEMP STATES */
168
169 /// default state, if a document was new created or loaded
170 E_UNKNOWN = 0,
171 /// modified against the original file
172 E_MODIFIED = 1,
173 /** We differe between the states: "modified in general" and "modified after last AutoSave".
174 The first state will be interesting in case the crashed document will be restored. Then we have
175 set the right modify state after loading the document. But the second state let us optimize the
176 AutoSave itself. see member ListenForModify too ...
177 */
178 E_MODIFIED_SINCE_LAST_AUTOSAVE = 1024,
179 /// an active document can be postponed to be saved later.
180 E_POSTPONED = 2,
181 /// was already handled during one AutoSave/Recovery session.
182 E_HANDLED = 4,
183 /** an action was started (saving/loading) ... Can be interesting later if the process may be was interrupted by an exception. */
184 E_TRY_SAVE = 8,
185 E_TRY_LOAD_BACKUP = 16,
186 E_TRY_LOAD_ORIGINAL = 32,
187
188 /* FINAL STATES */
189
190 /// the Auto/Emergency saved document isnt useable any longer
191 E_DAMAGED = 64,
192 /// the Auto/Emergency saved document isnt realy up-to-date (some changes can be missing)
193 E_INCOMPLETE = 128,
194 /// the Auto/Emergency saved document was processed successfully
195 E_SUCCEDED = 512
196 };
197
198 /** @short indicates the results of a FAILURE_SAFE operation
199
200 @descr We must know, which reason was the real one in case
201 we couldnt copy a "failure document" to a user specified path.
202 We must know, if we can forget our cache entry or not.
203 */
204 enum EFailureSafeResult
205 {
206 E_COPIED,
207 E_ORIGINAL_FILE_MISSING,
208 E_WRONG_TARGET_PATH
209 };
210
211 // TODO document me
212 enum ETimerType
213 {
214 /** the timer shouldnt be used next time */
215 E_DONT_START_TIMER,
216 /** timer (was/must be) started with normal AutoSaveTimeIntervall */
217 E_NORMAL_AUTOSAVE_INTERVALL,
218 /** timer must be started with special short time intervall,
219 to poll for an user idle period */
220 E_POLL_FOR_USER_IDLE,
221 /** timer mst be started with a very(!) short time intervall,
222 to poll for the end of an user action, which does not allow saving documents in general */
223 E_POLL_TILL_AUTOSAVE_IS_ALLOWED,
224 /** dont start the timer - but calls the same action then before immediatly again! */
225 E_CALL_ME_BACK
226 };
227
228 // TODO document me ... flag field
229 // Emergency_Save and Recovery overwrites Auto_Save!
230 enum EJob
231 {
232 E_NO_JOB = 0,
233 E_AUTO_SAVE = 1,
234 E_EMERGENCY_SAVE = 2,
235 E_RECOVERY = 4,
236 E_ENTRY_BACKUP = 8,
237 E_ENTRY_CLEANUP = 16,
238 E_PREPARE_EMERGENCY_SAVE = 32,
239 E_SESSION_SAVE = 64,
240 E_SESSION_RESTORE = 128,
241 E_DISABLE_AUTORECOVERY = 256,
242 E_SET_AUTOSAVE_STATE = 512
243 };
244
245 //---------------------------------------
246 /** @short combine different informations about one office document. */
247 struct TDocumentInfo
248 {
249 public:
250
251 //-------------------------------
252 TDocumentInfo()
253 : DocumentState (E_UNKNOWN)
254 , UsedForSaving (sal_False)
255 , ListenForModify (sal_False)
256 , IgnoreClosing (sal_False)
257 , ID (-1 )
258 {}
259
260 //-------------------------------
261 /** @short points to the document. */
262 css::uno::Reference< css::frame::XModel > Document;
263
264 //-------------------------------
265 /** @short knows, if the document is realy modified since the last autosave,
266 or was postponed, because it was an active one etcpp...
267
268 @descr Because we have no CHANGE TRACKING mechanism, based on office document,
269 we implements it by ourself. We listen for MODIFIED events
270 of each document and update this state flag here.
271
272 Further we postpone saving of active documents, e.g. if the user
273 works currently on it. We wait for an idle period then ...
274 */
275 sal_Int32 DocumentState;
276
277 //-------------------------------
278 /** Because our applications not ready for concurrent save requests at the same time,
279 we have supress our own AutoSave for the moment, a document will be already saved
280 by others.
281 */
282 sal_Bool UsedForSaving;
283
284 //-------------------------------
285 /** For every user action, which modifies a document (e.g. key input) we get
286 a notification as XModifyListener. That seams to be a "performance issue" .-)
287 So we decided to listen for such modify events only for the time in which the document
288 was stored as temp. file and was not modified again by the user.
289 */
290 sal_Bool ListenForModify;
291
292 //-------------------------------
293 /** For SessionSave we must close all open documents by ourself.
294 But because we are listen for documents events, we get some ...
295 and deregister these documents from our configuration.
296 That's why we mark these documents as "Closed by ourself" so we can
297 ignore these "OnUnload" or disposing() events .-)
298 */
299 sal_Bool IgnoreClosing;
300
301 //-------------------------------
302 /** TODO: document me */
303 ::rtl::OUString OrgURL;
304 ::rtl::OUString FactoryURL;
305 ::rtl::OUString TemplateURL;
306
307 ::rtl::OUString OldTempURL;
308 ::rtl::OUString NewTempURL;
309
310 ::rtl::OUString AppModule; // e.g. com.sun.star.text.TextDocument - used to identify app module
311 ::rtl::OUString RealFilter; // real filter, which was used at loading time
312 ::rtl::OUString DefaultFilter; // supports saving of the default format without loosing data
313 ::rtl::OUString Extension; // file extension of the default filter
314 ::rtl::OUString Title; // can be used as "DisplayName" on every recovery UI!
315
316 sal_Int32 ID;
317 };
318
319 //---------------------------------------
320 /** @short used to know every currently open document. */
321 typedef ::std::vector< TDocumentInfo > TDocumentList;
322
323 //___________________________________________
324 // member
325
326 private:
327
328 //---------------------------------------
329 /** @short the global uno service manager.
330 @descr Must be used to create own needed services.
331 */
332 css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
333
334 //---------------------------------------
335 /** @short points to the underlying recovery configuration.
336 @descr This instance does not cache - it calls directly the
337 configuration API!
338 */
339 css::uno::Reference< css::container::XNameAccess > m_xRecoveryCFG;
340
341 //---------------------------------------
342 /** @short points to the used configuration package or.openoffice.Setup
343 @descr This instance does not cache - it calls directly the
344 configuration API!
345 */
346 css::uno::Reference< css::container::XNameAccess > m_xModuleCFG;
347
348 //---------------------------------------
349 /** @short holds the global event broadcaster alive,
350 where we listen for new created documents.
351 */
352 css::uno::Reference< css::document::XEventBroadcaster > m_xNewDocBroadcaster;
353
354 //---------------------------------------
355 /** @short because we stop/restart listening sometimes, it's a good idea to know
356 if we already registered as listener .-)
357 */
358 sal_Bool m_bListenForDocEvents;
359 sal_Bool m_bListenForConfigChanges;
360
361 //---------------------------------------
362 /** @short specify the time intervall between two save actions.
363 @descr Time is measured in [min].
364 */
365 sal_Int32 m_nAutoSaveTimeIntervall;
366
367 //---------------------------------------
368 /** @short for an asynchronous operation we must know, if there is
369 at least one running job (may be asynchronous!).
370 */
371 sal_Int32 m_eJob;
372
373 //---------------------------------------
374 /** @short the timer, which is used to be informed about the next
375 saving time ...
376 */
377 Timer m_aTimer;
378
379 //---------------------------------------
380 /** @short make our dispatch asynchronous ... if required to do so! */
381 ::vcl::EventPoster m_aAsyncDispatcher;
382
383 //---------------------------------------
384 /** @see DispatchParams
385 */
386 DispatchParams m_aDispatchParams;
387
388 //---------------------------------------
389 /** @short indicates, which time period is currently used by the
390 internal timer.
391 */
392 ETimerType m_eTimerType;
393
394 //---------------------------------------
395 /** @short this cache is used to hold all informations about
396 recovery/emergency save documents alive.
397 */
398 TDocumentList m_lDocCache;
399
400 //---------------------------------------
401 // TODO document me
402 sal_Int32 m_nIdPool;
403
404 //---------------------------------------
405 /** @short contains all status listener registered at this instance.
406 */
407 ListenerHash m_lListener;
408
409 /** @descr This member is used to prevent us against re-entrance problems.
410 A mutex cant help to prevent us from concurrent using of members
411 inside the same thread. But e.g. our internaly used stl structures
412 are not threadsafe ... and furthermore they cant be used at the same time
413 for iteration and add/remove requests!
414 So we have to detect such states and ... show a warning.
415 May be there will be a better solution next time ... (copying the cache temp.
416 bevor using).
417
418 And further it's not possible to use a simple boolean value here.
419 Because if more then one operation iterates over the same stl container ...
420 (only to modify it's elements but dont add new or removing existing ones!)
421 it should be possible doing so. But we must guarantee that the last operation reset
422 this lock ... not the first one ! So we use a "ref count" mechanism for that."
423 */
424 sal_Int32 m_nDocCacheLock;
425
426 /** @descr These members are used to check the minimum disc space, which must exists
427 to start the corresponding operation.
428 */
429 sal_Int32 m_nMinSpaceDocSave;
430 sal_Int32 m_nMinSpaceConfigSave;
431
432 //---------------------------------------
433 /** @short special debug option to make testing faster.
434
435 @descr We dont interpret the timer unit as [min] ...
436 we use [ms] instead of that. Further we dont
437 wait 10 s for user idle ...
438 */
439 #if OSL_DEBUG_LEVEL > 1
440 sal_Bool m_dbg_bMakeItFaster;
441 #endif
442
443 //---------------------------------------
444 // HACK ... TODO
445 css::uno::Reference< css::task::XStatusIndicator > m_xExternalProgress;
446
447 //___________________________________________
448 // interface
449
450 public:
451
452 AutoRecovery(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
453 virtual ~AutoRecovery( );
454
455 // XInterface, XTypeProvider, XServiceInfo
456 FWK_DECLARE_XINTERFACE
457 FWK_DECLARE_XTYPEPROVIDER
458 DECLARE_XSERVICEINFO
459
460 //---------------------------------------
461 // css.frame.XDispatch
462 virtual void SAL_CALL dispatch(const css::util::URL& aURL ,
463 const css::uno::Sequence< css::beans::PropertyValue >& lArguments)
464 throw(css::uno::RuntimeException);
465
466 virtual void SAL_CALL addStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
467 const css::util::URL& aURL )
468 throw(css::uno::RuntimeException);
469
470 virtual void SAL_CALL removeStatusListener(const css::uno::Reference< css::frame::XStatusListener >& xListener,
471 const css::util::URL& aURL )
472 throw(css::uno::RuntimeException);
473
474 //---------------------------------------
475 // css.document.XEventListener
476 /** @short informs about created/opened documents.
477
478 @descr Every new opened/created document will be saved internaly
479 so it can be checked if its modified. This modified state
480 is used later to decide, if it must be saved or not.
481
482 @param aEvent
483 points to the new created/opened document.
484 */
485 virtual void SAL_CALL notifyEvent(const css::document::EventObject& aEvent)
486 throw(css::uno::RuntimeException);
487
488 //---------------------------------------
489 // css.util.XChangesListener
490 virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
491 throw(css::uno::RuntimeException);
492
493 //---------------------------------------
494 // css.util.XModifyListener
495 virtual void SAL_CALL modified(const css::lang::EventObject& aEvent)
496 throw(css::uno::RuntimeException);
497
498 //---------------------------------------
499 // css.lang.XEventListener
500 using cppu::OPropertySetHelper::disposing;
501 virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
502 throw(css::uno::RuntimeException);
503
504 //___________________________________________
505 // helper
506
507 protected:
508
509 //---------------------------------------
510 // OPropertySetHelper
511
512 virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& aConvertedValue,
513 css::uno::Any& aOldValue ,
514 sal_Int32 nHandle ,
515 const css::uno::Any& aValue )
516 throw(css::lang::IllegalArgumentException);
517
518 virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle,
519 const css::uno::Any& aValue )
520 throw(css::uno::Exception);
521 using cppu::OPropertySetHelper::getFastPropertyValue;
522 virtual void SAL_CALL getFastPropertyValue(css::uno::Any& aValue ,
523 sal_Int32 nHandle) const;
524
525 virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
526
527 virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo()
528 throw(css::uno::RuntimeException);
529 //___________________________________________
530 // helper
531
532 private:
533
534 //---------------------------------------
535 /** @short open the underlying configuration.
536
537 @descr This method must be called everytimes
538 a configuartion call is needed. Because
539 method works together with the member
540 m_xCFG, open it on demand and cache it
541 afterwards.
542
543 @return [com.sun.star.container.XNameAccess]
544 the configuration object
545
546 @throw [com.sun.star.uno.RuntimeException]
547 if config could not be opened successfully!
548
549 @threadsafe
550 */
551 css::uno::Reference< css::container::XNameAccess > implts_openConfig();
552
553 //---------------------------------------
554 /** @short read the underlying configuration.
555
556 @descr After that we know the initial state - means:
557 - if AutoSave was enabled by the user
558 - which time intervall has to be used
559 - which recovery entries may already exists
560
561 @throw [com.sun.star.uno.RuntimeException]
562 if config could not be opened or readed successfully!
563
564 @threadsafe
565 */
566 void implts_readConfig();
567
568 //---------------------------------------
569 /** @short read the underlying configuration...
570
571 @descr ... but only keys related to the AutoSave mechanism.
572 Means: State and Timer intervall.
573 E.g. the recovery list isnt adressed here.
574
575 @throw [com.sun.star.uno.RuntimeException]
576 if config could not be opened or readed successfully!
577
578 @threadsafe
579 */
580 void implts_readAutoSaveConfig();
581
582 //---------------------------------------
583 // TODO document me
584 void implts_flushConfigItem(const AutoRecovery::TDocumentInfo& rInfo ,
585 sal_Bool bRemoveIt = sal_False);
586
587 //---------------------------------------
588 // TODO document me
589 void implts_startListening();
590 void implts_startModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
591
592 //---------------------------------------
593 // TODO document me
594 void implts_stopListening();
595 void implts_stopModifyListeningOnDoc(AutoRecovery::TDocumentInfo& rInfo);
596
597 //---------------------------------------
598 /** @short stops and may be(!) restarts the timer.
599
600 @descr A running timer is stopped everytimes here.
601 But starting depends from the different internal
602 timer variables (e.g. AutoSaveEnabled, AutoSaveTimeIntervall,
603 TimerType etcpp.)
604
605 @throw [com.sun.star.uno.RuntimeException]
606 if timer could not be stopped or started!
607
608 @threadsafe
609 */
610 void implts_actualizeTimer();
611
612 //---------------------------------------
613 /** @short stop the timer.
614
615 @descr Double calls will be ignored - means we do
616 nothing here, if the timer is already disabled.
617
618 @throw [com.sun.star.uno.RuntimeException]
619 if timer could not be stopped!
620
621 @threadsafe
622 */
623 void implts_stopTimer();
624
625 //---------------------------------------
626 /** @short callback of our internal timer.
627 */
628 DECL_LINK(implts_timerExpired, void*);
629
630 //---------------------------------------
631 /** @short makes our dispatch() method asynchronous!
632 */
633 DECL_LINK(implts_asyncDispatch, void*);
634
635 //---------------------------------------
636 /** @short implements the dispatch real. */
637 void implts_dispatch(const DispatchParams& aParams);
638
639 //---------------------------------------
640 /** @short validate new detected document and add it into the internal
641 document list.
642
643 @descr This method should be called only, if its clear that a new
644 document was opened/created during office runtime.
645 This method checks, if its a top level document (means not an embedded one).
646 Only such top level documents can be recognized by this auto save mechanism.
647
648 @param xDocument
649 the new document, which should be checked and registered.
650
651 @threadsafe
652 */
653 void implts_registerDocument(const css::uno::Reference< css::frame::XModel >& xDocument);
654
655 //---------------------------------------
656 /** @short remove the specified document from our internal document list.
657
658 @param xDocument
659 the new document, which should be deregistered.
660
661 @param bStopListening
662 FALSE: must be used in case this method is called withion disposing() of the document,
663 where it make no sense to deregister our listener. The container dies ...
664 TRUE : must be used in case this method is used on "dergistration" of this document, where
665 we must deregister our listener .-)
666
667 @threadsafe
668 */
669 void implts_deregisterDocument(const css::uno::Reference< css::frame::XModel >& xDocument ,
670 sal_Bool bStopListening = sal_True);
671
672 //---------------------------------------
673 // TODO document me
674 void implts_markDocumentModifiedAgainstLastBackup(const css::uno::Reference< css::frame::XModel >& xDocument);
675
676 //---------------------------------------
677 // TODO document me
678 void implts_actualizeModifiedState(const css::uno::Reference< css::frame::XModel >& xDocument);
679
680 //---------------------------------------
681 // TODO document me
682 void implts_updateDocumentUsedForSavingState(const css::uno::Reference< css::frame::XModel >& xDocument ,
683 sal_Bool bSaveInProgress);
684
685 //---------------------------------------
686 // TODO document me
687 void implts_markDocumentAsSaved(const css::uno::Reference< css::frame::XModel >& xDocument);
688
689 //---------------------------------------
690 /** @short search a document inside given list.
691
692 @param rList
693 reference to a vector, which can contain such
694 document.
695
696 @param xDocument
697 the document, which should be located inside the
698 given list.
699
700 @return [TDocumentList::iterator]
701 which points to the located document.
702 If document does not exists - its set to
703 rList.end()!
704 */
705 static TDocumentList::iterator impl_searchDocument( AutoRecovery::TDocumentList& rList ,
706 const css::uno::Reference< css::frame::XModel >& xDocument);
707
708 //---------------------------------------
709 /** TODO document me */
710 void implts_changeAllDocVisibility(sal_Bool bVisible);
711 void implts_prepareSessionShutdown();
712
713 //---------------------------------------
714 /** @short save all current opened documents to a specific
715 backup directory.
716
717 @descr Only realy changed documents will be saved here.
718
719 Further this method returns a suggestion, if and how it should
720 be called again. May be some documents was not saved yet
721 and must wait for an user idle period ...
722
723 @param bAllowUserIdleLoop
724 Because this method is used for different uses cases, it must
725 know, which actions are allowed or not.
726 AUTO_SAVE =>
727 If a document is the most active one, saving it
728 will be postponed if there exists other unsaved
729 documents. This feature was implemented, because
730 we dont wish to disturb the user on it's work.
731 ... bAllowUserIdleLoop should be set to TRUE
732 EMERGENCY_SAVE / SESSION_SAVE =>
733 Here we must finish our work ASAP! It's not allowed
734 to postpone any document.
735 ... bAllowUserIdleLoop must(!) be set to FALSE
736
737 @param pParams
738 sometimes this method is required inside an external dispatch request.
739 The it contains some special environment variables, which overwrites
740 our normal environment.
741 AutoSave => pParams == 0
742 SessionSave/CrashSave => pParams != 0
743
744 @return A suggestion, how the timer (if its not already disabled!)
745 should be restarted to full fill the requirements.
746
747 @threadsafe
748 */
749 AutoRecovery::ETimerType implts_saveDocs( sal_Bool bAllowUserIdleLoop,
750 sal_Bool bRemoveLockFiles,
751 const DispatchParams* pParams = 0);
752
753 //---------------------------------------
754 /** @short save one of the current documents to a specific
755 backup directory.
756
757 @descr It:
758 - defines a new(!) unique temp file name
759 - save the new temp file
760 - remove the old temp file
761 - patch the given info struct
762 - and return errors.
763
764 It does not:
765 - patch the configuration.
766
767 Note further: It paches the info struct
768 more then ones. E.g. the new temp URL is set
769 before the file is saved. And the old URL is removed
770 only if removing oft he old file was successfully.
771 If this method returns without an exception - everything
772 was OK. Otherwhise the info struct can be analyzed to
773 get more information, e.g. when the problem occures.
774
775 @param sBackupPath
776 the base path for saving such temp files.
777
778 @param rInfo
779 points to an informations structure, where
780 e.g. the document, its modified state, the count
781 of autosave-retries etcpp. exists.
782 Its used also to return the new temp file name
783 and some other state values!
784
785 @threadsafe
786 */
787 void implts_saveOneDoc(const ::rtl::OUString& sBackupPath ,
788 AutoRecovery::TDocumentInfo& rInfo ,
789 const css::uno::Reference< css::task::XStatusIndicator >& xExternalProgress);
790
791 //---------------------------------------
792 /** @short recovery all documents, which was saved during
793 a crash before.
794
795 @return A suggestion, how this method must be called back!
796
797 @threadsafe
798 */
799 AutoRecovery::ETimerType implts_openDocs(const DispatchParams& aParams);
800
801 //---------------------------------------
802 // TODO document me
803 void implts_openOneDoc(const ::rtl::OUString& sURL ,
804 ::comphelper::MediaDescriptor& lDescriptor,
805 AutoRecovery::TDocumentInfo& rInfo );
806
807 //---------------------------------------
808 // TODO document me
809 void implts_generateNewTempURL(const ::rtl::OUString& sBackupPath ,
810 ::comphelper::MediaDescriptor& rMediaDescriptor,
811 AutoRecovery::TDocumentInfo& rInfo );
812
813 //---------------------------------------
814 /** @short notifies all interested listener about the current state
815 of the currently running operation.
816
817 @descr We support different set's of functions. AUTO_SAVE, EMERGENCY_SAVE,
818 AUTO_RECOVERY, FAILURE_SAVE ... etcpp.
819 Listener can register itself for any type of supported
820 functionality ... but not for document URL's in special.
821
822 @param eJob
823 is used to know, which set of listener we must notify.
824
825 @param aEvent
826 describe the event more in detail.
827
828 @threadsafe
829 */
830 void implts_informListener( sal_Int32 eJob ,
831 const css::frame::FeatureStateEvent& aEvent);
832
833 //---------------------------------------
834 /** short create a feature event struct, which can be send
835 to any interested listener.
836
837 @param eJob
838 describe the current running operation
839 AUTOSAVE, EMERGENCYSAVE, RECOVERY
840
841 @param sEventType
842 describe the type of this event
843 START, STOP, UPDATE
844
845 @param pInfo
846 if sOperation is an update, this parameter must be different from NULL
847 and is used to send informations regarding the current handled document.
848
849 @return [css::frame::FeatureStateEvent]
850 the event structure for sending.
851 */
852 static css::frame::FeatureStateEvent implst_createFeatureStateEvent( sal_Int32 eJob ,
853 const ::rtl::OUString& sEventType,
854 AutoRecovery::TDocumentInfo* pInfo );
855
856 //---------------------------------------
857
858 // TODO document me
859 void implts_resetHandleStates(sal_Bool bLoadCache);
860
861 //---------------------------------------
862 // TODO document me
863 void implts_specifyDefaultFilterAndExtension(AutoRecovery::TDocumentInfo& rInfo);
864
865 //---------------------------------------
866 // TODO document me
867 void implts_specifyAppModuleAndFactoryURL(AutoRecovery::TDocumentInfo& rInfo);
868
869 //---------------------------------------
870 // TODO document me
871 void implts_prepareEmergencySave();
872
873 //---------------------------------------
874 // TODO document me
875 void implts_doEmergencySave(const DispatchParams& aParams);
876
877 //---------------------------------------
878 // TODO document me
879 void implts_doRecovery(const DispatchParams& aParams);
880
881 //---------------------------------------
882 // TODO document me
883 void implts_doSessionSave(const DispatchParams& aParams);
884
885 //---------------------------------------
886 // TODO document me
887 void implts_doSessionRestore(const DispatchParams& aParams);
888
889 //---------------------------------------
890 // TODO document me
891 void implts_backupWorkingEntry(const DispatchParams& aParams);
892
893 //---------------------------------------
894 // TODO document me
895 void implts_cleanUpWorkingEntry(const DispatchParams& aParams);
896
897 //---------------------------------------
898 /** try to make sure that all changed config items (not our used
899 config access only) will be flushed back to disc.
900
901 E.g. our svtools::ConfigItems() has to be flushed explicitly .-(
902
903 Note: This method cant fail. Flushing of config entries is an
904 optional feature. Errors can be ignored.
905 */
906 void impl_flushALLConfigChanges();
907
908 //---------------------------------------
909 // TODO document me
910 AutoRecovery::EFailureSafeResult implts_copyFile(const ::rtl::OUString& sSource ,
911 const ::rtl::OUString& sTargetPath,
912 const ::rtl::OUString& sTargetName);
913
914 //---------------------------------------
915 /** @short converts m_eJob into a job description, which
916 can be used to inform an outside listener
917 about the current running operation
918
919 @param eJob
920 describe the current running operation
921 AUTOSAVE, EMERGENCYSAVE, RECOVERY
922
923 @return [string]
924 a suitable job description of form:
925 vnd.sun.star.autorecovery:/do...
926 */
927 static ::rtl::OUString implst_getJobDescription(sal_Int32 eJob);
928
929 //---------------------------------------
930 /** @short mape the given URL to an internal int representation.
931
932 @param aURL
933 the url, which describe the next starting or may be already running
934 operation.
935
936 @return [long]
937 the internal int representation
938 see enum EJob
939 */
940 static sal_Int32 implst_classifyJob(const css::util::URL& aURL);
941
942 /// TODO
943 void implts_verifyCacheAgainstDesktopDocumentList();
944
945 /// TODO document me
946 sal_Bool impl_enoughDiscSpace(sal_Int32 nRequiredSpace);
947
948 /// TODO document me
949 static void impl_showFullDiscError();
950
951 //---------------------------------------
952 /** @short try to create/use a progress and set it inside the
953 environment.
954
955 @descr The problem behind: There exists different use case of this method.
956 a) An external progress is provided by our CrashSave or Recovery dialog.
957 b) We must create our own progress e.g. for an AutoSave
958 c) Sometimes our application filters dont use the progress
959 provided by the MediaDescriptor. They uses the Frame everytime to create
960 it's own progress. So we implemented a HACK for these and now we set
961 an InterceptedProgress there for the time WE use this frame for loading/storing documents .-)
962
963 @param xNewFrame
964 must be set only in case WE create a new frame (e.g. for loading documents
965 on session restore or recovery). Then search for a frame using rInfo.Document must
966 be supressed and xFrame must be preferred instead .-)
967
968 @param rInfo
969 used e.g. to find the frame corresponding to a document.
970 This frame must be used to create a new progress e.g. for an AutoSave.
971
972 @param rArgs
973 is used to set the new created progress as parameter on these set.
974 */
975 void impl_establishProgress(const AutoRecovery::TDocumentInfo& rInfo ,
976 ::comphelper::MediaDescriptor& rArgs ,
977 const css::uno::Reference< css::frame::XFrame >& xNewFrame);
978
979 void impl_forgetProgress(const AutoRecovery::TDocumentInfo& rInfo ,
980 ::comphelper::MediaDescriptor& rArgs ,
981 const css::uno::Reference< css::frame::XFrame >& xNewFrame);
982
983 //---------------------------------------
984 /** try to remove the specified file from disc.
985
986 Every URL supported by our UCB component can be used here.
987 Further it doesnt matter if the file realy exists or not.
988 Because removing a non exsistent file will have the same
989 result at the end ... a non existing file .-)
990
991 On the other side removing of files from disc is an optional
992 feature. If we are not able doing so ... its not a real problem.
993 Ok - users disc place will be samller then ... but we should produce
994 a crash during crash save because we cant delete a temporary file only !
995
996 @param sURL
997 the url of the file, which should be removed.
998 */
999 static void st_impl_removeFile(const ::rtl::OUString& sURL);
1000
1001 //---------------------------------------
1002 /** try to remove ".lock" file from disc if office will be terminated
1003 not using the offical way .-)
1004
1005 This method has to be handled "optional". So every error inside
1006 has to be ignored ! This method CANT FAIL ... it can forget something only .-)
1007 */
1008 static void st_impl_removeLockFile();
1009 };
1010
1011 } // namespace framework
1012
1013 #endif // __FRAMEWORK_SERVICES_AUTORECOVERY_HXX_
vba interoperability for OOo