1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <config_features.h>
#include "arrdecl.hxx"
#include <map>
#include <cppuhelper/implbase.hxx>
#include <com/sun/star/util/XCloseable.hpp>
#include <com/sun/star/frame/XComponentLoader.hpp>
#include <com/sun/star/frame/Desktop.hpp>
#include <com/sun/star/util/XCloseBroadcaster.hpp>
#include <com/sun/star/util/XCloseListener.hpp>
#include <com/sun/star/util/XModifyBroadcaster.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/frame/XTitle.hpp>
#include <osl/file.hxx>
#include <osl/mutex.hxx>
#include <rtl/instance.hxx>
#include <vcl/msgbox.hxx>
#include <vcl/wrkwin.hxx>
#include <vcl/svapp.hxx>
#include <svl/eitem.hxx>
#include <svl/lstner.hxx>
#include <sfx2/sfxhelp.hxx>
#include <basic/sbstar.hxx>
#include <svl/stritem.hxx>
#include <basic/sbx.hxx>
#include <unotools/configmgr.hxx>
#include <unotools/eventcfg.hxx>
#include <sfx2/objsh.hxx>
#include <sfx2/signaturestate.hxx>
#include <sfx2/sfxmodelfactory.hxx>
#include <basic/sbuno.hxx>
#include <svtools/sfxecode.hxx>
#include <svtools/ehdl.hxx>
#include <unotools/printwarningoptions.hxx>
#include <comphelper/processfactory.hxx>
#include <comphelper/string.hxx>
#include <com/sun/star/document/XStorageBasedDocument.hpp>
#include <com/sun/star/script/DocumentDialogLibraryContainer.hpp>
#include <com/sun/star/script/DocumentScriptLibraryContainer.hpp>
#include <com/sun/star/document/XEmbeddedScripts.hpp>
#include <com/sun/star/document/XScriptInvocationContext.hpp>
#include <svl/urihelper.hxx>
#include <unotools/pathoptions.hxx>
#include <svl/sharecontrolfile.hxx>
#include <unotools/ucbhelper.hxx>
#include <svtools/asynclink.hxx>
#include <tools/diagnose_ex.h>
#include <tools/globname.hxx>
#include <comphelper/classids.hxx>
#include <sfx2/app.hxx>
#include <sfx2/docfac.hxx>
#include <sfx2/docfile.hxx>
#include <sfx2/event.hxx>
#include <sfx2/dispatch.hxx>
#include <sfx2/viewsh.hxx>
#include <sfx2/viewfrm.hxx>
#include <sfx2/sfxresid.hxx>
#include "objshimp.hxx"
#include "sfxtypes.hxx"
#include <sfx2/evntconf.hxx>
#include <sfx2/request.hxx>
#include "doc.hrc"
#include "sfxlocal.hrc"
#include "appdata.hxx"
#include <sfx2/sfxsids.hrc>
#include <basic/basmgr.hxx>
#include <svtools/svtools.hrc>
#include <sfx2/QuerySaveDocument.hxx>
#include "helpid.hrc"
#include <sfx2/msg.hxx>
#include "appbaslib.hxx"
#include <sfx2/sfxbasemodel.hxx>
#include <shellimpl.hxx>
#include <sfx2/notebookbar/SfxNotebookBar.hxx>
#include <basic/basicmanagerrepository.hxx>
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::script;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::document;
using ::basic::BasicManagerRepository;
#include <uno/mapping.hxx>
#include "sfxslots.hxx"
namespace {
class theCurrentComponent : public rtl::Static< WeakReference< XInterface >, theCurrentComponent > {};
#if HAVE_FEATURE_SCRIPTING
// remember all registered components for VBA compatibility, to be able to remove them on disposing the model
typedef ::std::map< XInterface*, OUString > VBAConstantNameMap;
static VBAConstantNameMap s_aRegisteredVBAConstants;
OUString lclGetVBAGlobalConstName( const Reference< XInterface >& rxComponent )
{
OSL_ENSURE( rxComponent.is(), "lclGetVBAGlobalConstName - missing component" );
VBAConstantNameMap::iterator aIt = s_aRegisteredVBAConstants.find( rxComponent.get() );
if( aIt != s_aRegisteredVBAConstants.end() )
return aIt->second;
uno::Reference< beans::XPropertySet > xProps( rxComponent, uno::UNO_QUERY );
if( xProps.is() ) try
{
OUString aConstName;
xProps->getPropertyValue("VBAGlobalConstantName") >>= aConstName;
return aConstName;
}
catch (const uno::Exception&) // not supported
{
}
return OUString();
}
#endif
} // namespace
class SfxModelListener_Impl : public ::cppu::WeakImplHelper< css::util::XCloseListener >
{
SfxObjectShell* mpDoc;
public:
explicit SfxModelListener_Impl( SfxObjectShell* pDoc ) : mpDoc(pDoc) {};
virtual void SAL_CALL queryClosing( const css::lang::EventObject& aEvent, sal_Bool bDeliverOwnership )
throw ( css::uno::RuntimeException, css::util::CloseVetoException, std::exception) override ;
virtual void SAL_CALL notifyClosing( const css::lang::EventObject& aEvent ) throw ( css::uno::RuntimeException, std::exception ) override ;
virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw ( css::uno::RuntimeException, std::exception ) override ;
};
void SAL_CALL SfxModelListener_Impl::queryClosing( const css::lang::EventObject& , sal_Bool )
throw ( css::uno::RuntimeException, css::util::CloseVetoException, std::exception)
{
}
void SAL_CALL SfxModelListener_Impl::notifyClosing( const css::lang::EventObject& ) throw ( css::uno::RuntimeException, std::exception )
{
SolarMutexGuard aSolarGuard;
mpDoc->Broadcast( SfxHint(SFX_HINT_DEINITIALIZING) );
}
void SAL_CALL SfxModelListener_Impl::disposing( const css::lang::EventObject& _rEvent ) throw ( css::uno::RuntimeException, std::exception )
{
// am I ThisComponent in AppBasic?
SolarMutexGuard aSolarGuard;
if ( SfxObjectShell::GetCurrentComponent() == _rEvent.Source )
{
// remove ThisComponent reference from AppBasic
SfxObjectShell::SetCurrentComponent( Reference< XInterface >() );
}
#if HAVE_FEATURE_SCRIPTING
/* Remove VBA component from AppBasic. As every application registers its
own current component, the disposed component may not be the "current
component" of the SfxObjectShell. */
if ( _rEvent.Source.is() )
{
VBAConstantNameMap::iterator aIt = s_aRegisteredVBAConstants.find( _rEvent.Source.get() );
if ( aIt != s_aRegisteredVBAConstants.end() )
{
if ( BasicManager* pAppMgr = SfxApplication::GetBasicManager() )
pAppMgr->SetGlobalUNOConstant( aIt->second, Any( Reference< XInterface >() ) );
s_aRegisteredVBAConstants.erase( aIt );
}
}
#endif
if ( !mpDoc->Get_Impl()->bClosing )
// GCC crashes when already in the destructor, so first query the Flag
mpDoc->DoClose();
}
SfxObjectShell_Impl::SfxObjectShell_Impl( SfxObjectShell& _rDocShell )
:mpObjectContainer(nullptr)
,rDocShell( _rDocShell )
,aMacroMode( *this )
,pProgress( nullptr)
,nTime( DateTime::SYSTEM )
,nVisualDocumentNumber( USHRT_MAX)
,nDocumentSignatureState( SignatureState::UNKNOWN )
,nScriptingSignatureState( SignatureState::UNKNOWN )
,bInList( false)
,bClosing( false)
,bIsSaving( false)
,bPasswd( false)
,bIsNamedVisible( false)
,bIsAbortingImport ( false)
,bImportDone ( false)
,bInPrepareClose( false )
,bPreparedForClose( false )
,bForbidReload( false )
,bBasicInitialized( false )
,bIsPrintJobCancelable( true )
,bOwnsStorage( true )
,bInitialized( false )
,bSignatureErrorIsShown( false )
,bModelInitialized( false )
,bPreserveVersions( true )
,m_bMacroSignBroken( false )
,m_bNoBasicCapabilities( false )
,m_bDocRecoverySupport( true )
,bQueryLoadTemplate( true )
,bLoadReadonly( false )
,bUseUserData( true )
,bUseThumbnailSave( true )
,bSaveVersionOnClose( false )
,m_bSharedXMLFlag( false )
,m_bAllowShareControlFileClean( true )
,m_bConfigOptionsChecked( false )
,lErr(ERRCODE_NONE)
,nEventId ( 0)
,pReloadTimer ( nullptr)
,nLoadedFlags ( SfxLoadedFlags::ALL )
,nFlagsInProgress( SfxLoadedFlags::NONE )
,bModalMode( false )
,bRunningMacro( false )
,nAutoLoadLocks( 0 )
,eFlags( SfxObjectShellFlags::UNDEFINED )
,bReadOnlyUI( false )
,nStyleFilter( 0 )
,bDisposing( false )
,m_bEnableSetModified( true )
,m_bIsModified( false )
,m_nMapUnit( MapUnit::Map100thMM )
,m_bCreateTempStor( false )
,m_bIsInit( false )
,m_bIncomplEncrWarnShown( false )
,m_nModifyPasswordHash( 0 )
,m_bModifyPasswordEntered( false )
,m_bSavingForSigning( false )
{
SfxObjectShell* pDoc = &_rDocShell;
SfxObjectShellArr_Impl &rArr = SfxGetpApp()->GetObjectShells_Impl();
rArr.push_back( pDoc );
bInList = true;
}
SfxObjectShell_Impl::~SfxObjectShell_Impl()
{
}
SfxObjectShell::SfxObjectShell( const SfxModelFlags i_nCreationFlags )
: pImpl(new SfxObjectShell_Impl(*this))
, pMedium(nullptr)
, eCreateMode(SfxObjectCreateMode::STANDARD)
, bHasName(false)
, bIsInGenerateThumbnail (false)
, mbAvoidRecentDocs(false)
{
if (i_nCreationFlags & SfxModelFlags::EMBEDDED_OBJECT)
eCreateMode = SfxObjectCreateMode::EMBEDDED;
else if (i_nCreationFlags & SfxModelFlags::EXTERNAL_LINK)
eCreateMode = SfxObjectCreateMode::INTERNAL;
const bool bScriptSupport = ( i_nCreationFlags & SfxModelFlags::DISABLE_EMBEDDED_SCRIPTS ) == SfxModelFlags::NONE;
if ( !bScriptSupport )
SetHasNoBasic();
const bool bDocRecovery = ( i_nCreationFlags & SfxModelFlags::DISABLE_DOCUMENT_RECOVERY ) == SfxModelFlags::NONE;
if ( !bDocRecovery )
pImpl->m_bDocRecoverySupport = false;
}
/** Constructor of the class SfxObjectShell.
@param eMode Purpose, to which the SfxObjectShell is created:
SfxObjectCreateMode::EMBEDDED (default) as SO-Server from within another Document
SfxObjectCreateMode::STANDARD, as a normal Document open stand-alone
SfxObjectCreateMode::PREVIEW to enable a Preview, if possible are only little information is needed
SfxObjectCreateMode::ORGANIZER to be displayed in the Organizer, here nothing of the contents is used
*/
SfxObjectShell::SfxObjectShell(SfxObjectCreateMode eMode)
: pImpl(new SfxObjectShell_Impl(*this))
, pMedium(nullptr)
, eCreateMode(eMode)
, bHasName(false)
, bIsInGenerateThumbnail(false)
, mbAvoidRecentDocs(false)
{
}
SfxObjectShell::~SfxObjectShell()
{
if ( IsEnableSetModified() )
EnableSetModified( false );
// Never call GetInPlaceObject(), the access to the derivative branch
// SfxInternObject is not allowed because of a compiler bug
SfxObjectShell::CloseInternal();
pImpl->pBaseModel.set( nullptr );
DELETEX(AutoReloadTimer_Impl, pImpl->pReloadTimer );
SfxApplication *pSfxApp = SfxGetpApp();
if ( USHRT_MAX != pImpl->nVisualDocumentNumber )
pSfxApp->ReleaseIndex(pImpl->nVisualDocumentNumber);
// Destroy Basic-Manager
pImpl->aBasicManager.reset( nullptr );
if ( pSfxApp->GetDdeService() )
pSfxApp->RemoveDdeTopic( this );
pImpl->pBaseModel.set( nullptr );
// don't call GetStorage() here, in case of Load Failure it's possible that a storage was never assigned!
if ( pMedium && pMedium->HasStorage_Impl() && pMedium->GetStorage( false ) == pImpl->m_xDocStorage )
pMedium->CanDisposeStorage_Impl( false );
if ( pImpl->mpObjectContainer )
{
pImpl->mpObjectContainer->CloseEmbeddedObjects();
delete pImpl->mpObjectContainer;
}
if ( pImpl->bOwnsStorage && pImpl->m_xDocStorage.is() )
pImpl->m_xDocStorage->dispose();
if ( pMedium )
{
pMedium->CloseAndReleaseStreams_Impl();
#if HAVE_FEATURE_MULTIUSER_ENVIRONMENT
if ( IsDocShared() )
FreeSharedFile();
#endif
DELETEX( SfxMedium, pMedium );
}
// The removing of the temporary file must be done as the latest step in the document destruction
if ( !pImpl->aTempName.isEmpty() )
{
OUString aTmp;
osl::FileBase::getFileURLFromSystemPath( pImpl->aTempName, aTmp );
::utl::UCBContentHelper::Kill( aTmp );
}
}
void SfxObjectShell::Stamp_SetPrintCancelState(bool bState)
{
pImpl->bIsPrintJobCancelable = bState;
}
bool SfxObjectShell::Stamp_GetPrintCancelState() const
{
return pImpl->bIsPrintJobCancelable;
}
// closes the Object and all its views
bool SfxObjectShell::Close()
{
SfxObjectShellRef aRef(this);
return CloseInternal();
}
// variant that does not take a reference to itself, so we can call it during object destruction
bool SfxObjectShell::CloseInternal()
{
if ( !pImpl->bClosing )
{
// Do not close if a progress is still running
if ( !pImpl->bDisposing && GetProgress() )
return false;
pImpl->bClosing = true;
Reference< util::XCloseable > xCloseable( GetBaseModel(), UNO_QUERY );
if ( xCloseable.is() )
{
try
{
xCloseable->close( true );
}
catch (const Exception&)
{
pImpl->bClosing = false;
}
}
if ( pImpl->bClosing )
{
// remove from Document list
// If there is no App, there is no document to remove
// no need to call GetOrCreate here
SfxApplication *pSfxApp = SfxApplication::Get();
if(pSfxApp)
{
SfxObjectShellArr_Impl &rDocs = pSfxApp->GetObjectShells_Impl();
SfxObjectShellArr_Impl::iterator it = std::find( rDocs.begin(), rDocs.end(), this );
if ( it != rDocs.end() )
rDocs.erase( it );
pImpl->bInList = false;
}
}
}
return true;
}
OUString SfxObjectShell::CreateShellID( const SfxObjectShell* pShell )
{
if (!pShell)
return OUString();
OUString aShellID;
SfxMedium* pMedium = pShell->GetMedium();
if (pMedium)
aShellID = pMedium->GetBaseURL();
if (!aShellID.isEmpty())
return aShellID;
sal_Int64 nShellID = reinterpret_cast<sal_Int64>(pShell);
aShellID = "0x" + OUString::number(nShellID, 16);
return aShellID;
}
// returns a pointer the first SfxDocument of specified type
SfxObjectShell* SfxObjectShell::GetFirst
(
const std::function<bool ( const SfxObjectShell* )>& isObjectShell,
bool bOnlyVisible
)
{
SfxObjectShellArr_Impl &rDocs = SfxGetpApp()->GetObjectShells_Impl();
// search for a SfxDocument of the specified type
for (SfxObjectShell* pSh : rDocs)
{
if ( bOnlyVisible && pSh->IsPreview() && pSh->IsReadOnly() )
continue;
if ( (!isObjectShell || isObjectShell( pSh)) &&
( !bOnlyVisible || SfxViewFrame::GetFirst( pSh )))
return pSh;
}
return nullptr;
}
// returns a pointer to the next SfxDocument of specified type behind *pDoc
SfxObjectShell* SfxObjectShell::GetNext
(
const SfxObjectShell& rPrev,
const std::function<bool ( const SfxObjectShell* )>& isObjectShell,
bool bOnlyVisible
)
{
SfxObjectShellArr_Impl &rDocs = SfxGetpApp()->GetObjectShells_Impl();
// refind the specified predecessor
sal_uInt16 nPos;
for ( nPos = 0; nPos < rDocs.size(); ++nPos )
if ( rDocs[nPos] == &rPrev )
break;
// search for the next SfxDocument of the specified type
for ( ++nPos; nPos < rDocs.size(); ++nPos )
{
SfxObjectShell* pSh = rDocs[ nPos ];
if ( bOnlyVisible && pSh->IsPreview() && pSh->IsReadOnly() )
continue;
if ( (!isObjectShell || isObjectShell( pSh)) &&
( !bOnlyVisible || SfxViewFrame::GetFirst( pSh )))
return pSh;
}
return nullptr;
}
SfxObjectShell* SfxObjectShell::Current()
{
SfxViewFrame *pFrame = SfxViewFrame::Current();
return pFrame ? pFrame->GetObjectShell() : nullptr;
}
bool SfxObjectShell::IsInPrepareClose() const
{
return pImpl->bInPrepareClose;
}
struct BoolEnv_Impl
{
SfxObjectShell_Impl* pImpl;
explicit BoolEnv_Impl( SfxObjectShell_Impl* pImplP) : pImpl( pImplP )
{ pImplP->bInPrepareClose = true; }
~BoolEnv_Impl() { pImpl->bInPrepareClose = false; }
};
bool SfxObjectShell::PrepareClose
(
bool bUI // true: Dialog and so on is allowed
// false: silent-mode
)
{
if( pImpl->bInPrepareClose || pImpl->bPreparedForClose )
return true;
BoolEnv_Impl aBoolEnv( pImpl.get() );
// DocModalDialog?
if ( IsInModalMode() )
return false;
SfxViewFrame* pFirst = SfxViewFrame::GetFirst( this );
if( pFirst && !pFirst->GetFrame().PrepareClose_Impl( bUI ) )
return false;
// prepare views for closing
for ( SfxViewFrame* pFrm = SfxViewFrame::GetFirst( this );
pFrm; pFrm = SfxViewFrame::GetNext( *pFrm, this ) )
{
DBG_ASSERT(pFrm->GetViewShell(),"No Shell");
if ( pFrm->GetViewShell() )
{
bool bRet = pFrm->GetViewShell()->PrepareClose( bUI );
if ( !bRet )
return bRet;
}
}
SfxApplication *pSfxApp = SfxGetpApp();
pSfxApp->NotifyEvent( SfxEventHint(SFX_EVENT_PREPARECLOSEDOC, GlobalEventConfig::GetEventName(GlobalEventId::PREPARECLOSEDOC), this) );
if( GetCreateMode() == SfxObjectCreateMode::EMBEDDED )
{
pImpl->bPreparedForClose = true;
return true;
}
// Ask if possible if it should be saved
// only ask for the Document in the visible window
SfxViewFrame *pFrame = SfxObjectShell::Current() == this
? SfxViewFrame::Current() : SfxViewFrame::GetFirst( this );
if ( bUI && IsModified() && pFrame )
{
// restore minimized
SfxFrame& rTop = pFrame->GetTopFrame();
SfxViewFrame::SetViewFrame( rTop.GetCurrentViewFrame() );
pFrame->GetFrame().Appear();
// Ask if to save
short nRet = RET_YES;
{
const Reference< XTitle > xTitle( *pImpl->pBaseModel.get(), UNO_QUERY_THROW );
const OUString sTitle = xTitle->getTitle ();
nRet = ExecuteQuerySaveDocument(&pFrame->GetWindow(),sTitle);
}
/*HACK for plugin::destroy()*/
if ( RET_YES == nRet )
{
// Save by each Dispatcher
const SfxPoolItem *pPoolItem;
if ( IsSaveVersionOnClose() )
{
SfxStringItem aItem( SID_DOCINFO_COMMENTS, SfxResId(STR_AUTOMATICVERSION).toString() );
SfxBoolItem aWarnItem( SID_FAIL_ON_WARNING, bUI );
const SfxPoolItem* ppArgs[] = { &aItem, &aWarnItem, nullptr };
pPoolItem = pFrame->GetBindings().ExecuteSynchron( SID_SAVEDOC, ppArgs );
}
else
{
SfxBoolItem aWarnItem( SID_FAIL_ON_WARNING, bUI );
const SfxPoolItem* ppArgs[] = { &aWarnItem, nullptr };
pPoolItem = pFrame->GetBindings().ExecuteSynchron( IsReadOnlyMedium() ? SID_SAVEASDOC : SID_SAVEDOC, ppArgs );
}
if ( !pPoolItem || dynamic_cast< const SfxVoidItem *>( pPoolItem ) != nullptr || ( dynamic_cast< const SfxBoolItem *>( pPoolItem ) != nullptr && !static_cast<const SfxBoolItem*>( pPoolItem )->GetValue() ) )
return false;
}
else if ( RET_CANCEL == nRet )
// Cancelled
return false;
}
if ( pFrame )
sfx2::SfxNotebookBar::CloseMethod(pFrame->GetBindings());
pImpl->bPreparedForClose = true;
return true;
}
#if HAVE_FEATURE_SCRIPTING
namespace
{
BasicManager* lcl_getBasicManagerForDocument( const SfxObjectShell& _rDocument )
{
if ( !_rDocument.Get_Impl()->m_bNoBasicCapabilities )
{
if ( !_rDocument.Get_Impl()->bBasicInitialized )
const_cast< SfxObjectShell& >( _rDocument ).InitBasicManager_Impl();
return _rDocument.Get_Impl()->aBasicManager.get();
}
// assume we do not have Basic ourself, but we can refer to another
// document which does (by our model's XScriptInvocationContext::getScriptContainer).
// In this case, we return the BasicManager of this other document.
OSL_ENSURE( !Reference< XEmbeddedScripts >( _rDocument.GetModel(), UNO_QUERY ).is(),
"lcl_getBasicManagerForDocument: inconsistency: no Basic, but an XEmbeddedScripts?" );
Reference< XModel > xForeignDocument;
Reference< XScriptInvocationContext > xContext( _rDocument.GetModel(), UNO_QUERY );
if ( xContext.is() )
{
xForeignDocument.set( xContext->getScriptContainer(), UNO_QUERY );
OSL_ENSURE( xForeignDocument.is() && xForeignDocument != _rDocument.GetModel(),
"lcl_getBasicManagerForDocument: no Basic, but providing ourself as script container?" );
}
BasicManager* pBasMgr = nullptr;
if ( xForeignDocument.is() )
pBasMgr = ::basic::BasicManagerRepository::getDocumentBasicManager( xForeignDocument );
return pBasMgr;
}
}
#endif
BasicManager* SfxObjectShell::GetBasicManager() const
{
BasicManager* pBasMgr = nullptr;
#if HAVE_FEATURE_SCRIPTING
try
{
pBasMgr = lcl_getBasicManagerForDocument( *this );
if ( !pBasMgr )
pBasMgr = SfxApplication::GetBasicManager();
}
catch (const css::ucb::ContentCreationException& e)
{
SAL_WARN("sfx.doc", "caught exception " << e.Message);
}
#endif
return pBasMgr;
}
void SfxObjectShell::SetHasNoBasic()
{
pImpl->m_bNoBasicCapabilities = true;
}
bool SfxObjectShell::HasBasic() const
{
#if !HAVE_FEATURE_SCRIPTING
return false;
#else
if ( pImpl->m_bNoBasicCapabilities )
return false;
if ( !pImpl->bBasicInitialized )
const_cast< SfxObjectShell* >( this )->InitBasicManager_Impl();
return pImpl->aBasicManager.isValid();
#endif
}
#if HAVE_FEATURE_SCRIPTING
namespace
{
const Reference< XLibraryContainer >&
lcl_getOrCreateLibraryContainer( bool _bScript, Reference< XLibraryContainer >& _rxContainer,
const Reference< XModel >& _rxDocument )
{
if ( !_rxContainer.is() )
{
try
{
Reference< XStorageBasedDocument > xStorageDoc( _rxDocument, UNO_QUERY );
const Reference< XComponentContext > xContext(
::comphelper::getProcessComponentContext() );
_rxContainer.set ( _bScript
? DocumentScriptLibraryContainer::create(
xContext, xStorageDoc )
: DocumentDialogLibraryContainer::create(
xContext, xStorageDoc )
, UNO_QUERY_THROW );
}
catch (const Exception&)
{
DBG_UNHANDLED_EXCEPTION();
}
}
return _rxContainer;
}
}
#endif
Reference< XLibraryContainer > SfxObjectShell::GetDialogContainer()
{
#if HAVE_FEATURE_SCRIPTING
try
{
if ( !pImpl->m_bNoBasicCapabilities )
return lcl_getOrCreateLibraryContainer( false, pImpl->xDialogLibraries, GetModel() );
BasicManager* pBasMgr = lcl_getBasicManagerForDocument( *this );
if ( pBasMgr )
return pBasMgr->GetDialogLibraryContainer().get();
}
catch (const css::ucb::ContentCreationException& e)
{
SAL_WARN("sfx.doc", "caught exception " << e.Message);
}
SAL_WARN("sfx.doc", "SfxObjectShell::GetDialogContainer: falling back to the application - is this really expected here?");
#endif
return SfxGetpApp()->GetDialogContainer();
}
Reference< XLibraryContainer > SfxObjectShell::GetBasicContainer()
{
#if HAVE_FEATURE_SCRIPTING
if (!utl::ConfigManager::IsAvoidConfig())
{
try
{
if ( !pImpl->m_bNoBasicCapabilities )
return lcl_getOrCreateLibraryContainer( true, pImpl->xBasicLibraries, GetModel() );
BasicManager* pBasMgr = lcl_getBasicManagerForDocument( *this );
if ( pBasMgr )
return pBasMgr->GetScriptLibraryContainer().get();
}
catch (const css::ucb::ContentCreationException& e)
{
SAL_WARN("sfx.doc", "caught exception " << e.Message);
}
}
SAL_WARN("sfx.doc", "SfxObjectShell::GetBasicContainer: falling back to the application - is this really expected here?");
#endif
return SfxGetpApp()->GetBasicContainer();
}
StarBASIC* SfxObjectShell::GetBasic() const
{
#if !HAVE_FEATURE_SCRIPTING
return NULL;
#else
BasicManager * pMan = GetBasicManager();
return pMan ? pMan->GetLib(0) : nullptr;
#endif
}
void SfxObjectShell::InitBasicManager_Impl()
/* [Description]
Creates a document's BasicManager and loads it, if we are already based on
a storage.
[Note]
This method has to be called by implementations of <SvPersist::Load()>
(with its pStor parameter) and by implementations of <SvPersist::InitNew()>
(with pStor = 0).
*/
{
/* #163556# (DR) - Handling of recursive calls while creating the Basic
manager.
It is possible that (while creating the Basic manager) the code that
imports the Basic storage wants to access the Basic manager again.
Especially in VBA compatibility mode, there is code that wants to
access the "VBA Globals" object which is stored as global UNO constant
in the Basic manager.
To achieve correct handling of the recursive calls of this function
from lcl_getBasicManagerForDocument(), the implementation of the
function BasicManagerRepository::getDocumentBasicManager() has been
changed to return the Basic manager currently under construction, when
called repeatedly.
The variable pImpl->bBasicInitialized will be set to sal_True after
construction now, to ensure that the recursive call of the function
lcl_getBasicManagerForDocument() will be routed into this function too.
Calling BasicManagerHolder::reset() twice is not a big problem, as it
does not take ownership but stores only the raw pointer. Owner of all
Basic managers is the global BasicManagerRepository instance.
*/
#if HAVE_FEATURE_SCRIPTING
DBG_ASSERT( !pImpl->bBasicInitialized && !pImpl->aBasicManager.isValid(), "Lokaler BasicManager bereits vorhanden");
try
{
pImpl->aBasicManager.reset( BasicManagerRepository::getDocumentBasicManager( GetModel() ) );
}
catch (const css::ucb::ContentCreationException& e)
{
SAL_WARN("sfx.doc", "caught exception " << e.Message);
}
DBG_ASSERT( pImpl->aBasicManager.isValid(), "SfxObjectShell::InitBasicManager_Impl: did not get a BasicManager!" );
pImpl->bBasicInitialized = true;
#endif
}
bool SfxObjectShell::DoClose()
{
return Close();
}
SfxObjectShell* SfxObjectShell::GetObjectShell()
{
return this;
}
uno::Sequence< OUString > SfxObjectShell::GetEventNames()
{
static uno::Sequence< OUString >* pEventNameContainer = nullptr;
if ( !pEventNameContainer )
{
SolarMutexGuard aGuard;
if ( !pEventNameContainer )
{
static uno::Sequence< OUString > aEventNameContainer = rtl::Reference<GlobalEventConfig>(new GlobalEventConfig)->getElementNames();
pEventNameContainer = &aEventNameContainer;
}
}
return *pEventNameContainer;
}
css::uno::Reference< css::frame::XModel > SfxObjectShell::GetModel() const
{
return GetBaseModel();
}
void SfxObjectShell::SetBaseModel( SfxBaseModel* pModel )
{
OSL_ENSURE( !pImpl->pBaseModel.is() || pModel == nullptr, "Model already set!" );
pImpl->pBaseModel.set( pModel );
if ( pImpl->pBaseModel.is() )
{
pImpl->pBaseModel->addCloseListener( new SfxModelListener_Impl(this) );
}
}
css::uno::Reference< css::frame::XModel > SfxObjectShell::GetBaseModel() const
{
return pImpl->pBaseModel.get();
}
void SfxObjectShell::SetAutoStyleFilterIndex(sal_uInt16 nSet)
{
pImpl->nStyleFilter = nSet;
}
sal_uInt16 SfxObjectShell::GetAutoStyleFilterIndex()
{
return pImpl->nStyleFilter;
}
void SfxObjectShell::SetCurrentComponent( const Reference< XInterface >& _rxComponent )
{
WeakReference< XInterface >& rTheCurrentComponent = theCurrentComponent::get();
Reference< XInterface > xOldCurrentComp(rTheCurrentComponent);
if ( _rxComponent == xOldCurrentComp )
// nothing to do
return;
// note that "_rxComponent.get() == s_xCurrentComponent.get().get()" is /sufficient/, but not
// /required/ for "_rxComponent == s_xCurrentComponent.get()".
// In other words, it's still possible that we here do something which is not necessary,
// but we should have filtered quite some unnecessary calls already.
#if HAVE_FEATURE_SCRIPTING
BasicManager* pAppMgr = SfxApplication::GetBasicManager();
rTheCurrentComponent = _rxComponent;
if ( pAppMgr )
{
// set "ThisComponent" for Basic
pAppMgr->SetGlobalUNOConstant( "ThisComponent", Any( _rxComponent ) );
// set new current component for VBA compatibility
if ( _rxComponent.is() )
{
OUString aVBAConstName = lclGetVBAGlobalConstName( _rxComponent );
if ( !aVBAConstName.isEmpty() )
{
pAppMgr->SetGlobalUNOConstant( aVBAConstName, Any( _rxComponent ) );
s_aRegisteredVBAConstants[ _rxComponent.get() ] = aVBAConstName;
}
}
// no new component passed -> remove last registered VBA component
else if ( xOldCurrentComp.is() )
{
OUString aVBAConstName = lclGetVBAGlobalConstName( xOldCurrentComp );
if ( !aVBAConstName.isEmpty() )
{
pAppMgr->SetGlobalUNOConstant( aVBAConstName, Any( Reference< XInterface >() ) );
s_aRegisteredVBAConstants.erase( xOldCurrentComp.get() );
}
}
}
#endif
}
Reference< XInterface > SfxObjectShell::GetCurrentComponent()
{
return theCurrentComponent::get();
}
OUString SfxObjectShell::GetServiceNameFromFactory( const OUString& rFact )
{
//! Remove everything behind name!
OUString aFact( rFact );
OUString aPrefix("private:factory/");
if ( aFact.startsWith( aPrefix ) )
aFact = aFact.copy( aPrefix.getLength() );
sal_Int32 nPos = aFact.indexOf( '?' );
OUString aParam;
if ( nPos != -1 )
{
aParam = aFact.copy( nPos );
aFact = aFact.copy( 0, nPos );
aParam = aParam.copy(1);
}
aFact = aFact.replaceAll("4", "");
aFact = aFact.toAsciiLowerCase();
// HACK: sometimes a real document service name is given here instead of
// a factory short name. Set return value directly to this service name as fallback
// in case next lines of code does nothing ...
// use rFact instead of normed aFact value !
OUString aServiceName = rFact;
if ( aFact == "swriter" )
{
aServiceName = "com.sun.star.text.TextDocument";
}
else if ( aFact == "sweb" || aFact == "swriter/web" )
{
aServiceName = "com.sun.star.text.WebDocument";
}
else if ( aFact == "sglobal" || aFact == "swriter/globaldocument" )
{
aServiceName = "com.sun.star.text.GlobalDocument";
}
else if ( aFact == "scalc" )
{
aServiceName = "com.sun.star.sheet.SpreadsheetDocument";
}
else if ( aFact == "sdraw" )
{
aServiceName = "com.sun.star.drawing.DrawingDocument";
}
else if ( aFact == "simpress" )
{
aServiceName = "com.sun.star.presentation.PresentationDocument";
}
else if ( aFact == "schart" )
{
aServiceName = "com.sun.star.chart.ChartDocument";
}
else if ( aFact == "smath" )
{
aServiceName = "com.sun.star.formula.FormulaProperties";
}
#if HAVE_FEATURE_SCRIPTING
else if ( aFact == "sbasic" )
{
aServiceName = "com.sun.star.script.BasicIDE";
}
#endif
#if HAVE_FEATURE_DBCONNECTIVITY
else if ( aFact == "sdatabase" )
{
aServiceName = "com.sun.star.sdb.OfficeDatabaseDocument";
}
#endif
return aServiceName;
}
SfxObjectShell* SfxObjectShell::CreateObjectByFactoryName( const OUString& rFact, SfxObjectCreateMode eMode )
{
return CreateObject( GetServiceNameFromFactory( rFact ), eMode );
}
SfxObjectShell* SfxObjectShell::CreateObject( const OUString& rServiceName, SfxObjectCreateMode eCreateMode )
{
if ( !rServiceName.isEmpty() )
{
uno::Reference < frame::XModel > xDoc( ::comphelper::getProcessServiceFactory()->createInstance( rServiceName ), UNO_QUERY );
if ( xDoc.is() )
{
uno::Reference < lang::XUnoTunnel > xObj( xDoc, UNO_QUERY );
uno::Sequence < sal_Int8 > aSeq( SvGlobalName( SFX_GLOBAL_CLASSID ).GetByteSequence() );
sal_Int64 nHandle = xObj->getSomething( aSeq );
if ( nHandle )
{
SfxObjectShell* pRet = reinterpret_cast< SfxObjectShell* >( sal::static_int_cast< sal_IntPtr >( nHandle ));
pRet->SetCreateMode_Impl( eCreateMode );
return pRet;
}
}
}
return nullptr;
}
Reference<lang::XComponent> SfxObjectShell::CreateAndLoadComponent( const SfxItemSet& rSet )
{
uno::Sequence < beans::PropertyValue > aProps;
TransformItems( SID_OPENDOC, rSet, aProps );
const SfxStringItem* pFileNameItem = rSet.GetItem<SfxStringItem>(SID_FILE_NAME, false);
const SfxStringItem* pTargetItem = rSet.GetItem<SfxStringItem>(SID_TARGETNAME, false);
OUString aURL;
OUString aTarget("_blank");
if ( pFileNameItem )
aURL = pFileNameItem->GetValue();
if ( pTargetItem )
aTarget = pTargetItem->GetValue();
uno::Reference < frame::XComponentLoader > xLoader;
xLoader.set( frame::Desktop::create(comphelper::getProcessComponentContext()), uno::UNO_QUERY );
Reference <lang::XComponent> xComp;
try
{
xComp = xLoader->loadComponentFromURL(aURL, aTarget, 0, aProps);
}
catch (const uno::Exception&)
{
}
return xComp;
}
SfxObjectShell* SfxObjectShell::GetShellFromComponent( const Reference<lang::XComponent>& xComp )
{
try
{
Reference<lang::XUnoTunnel> xTunnel(xComp, UNO_QUERY_THROW);
Sequence <sal_Int8> aSeq( SvGlobalName( SFX_GLOBAL_CLASSID ).GetByteSequence() );
sal_Int64 nHandle = xTunnel->getSomething( aSeq );
if (!nHandle)
return nullptr;
return reinterpret_cast< SfxObjectShell* >(sal::static_int_cast< sal_IntPtr >( nHandle ));
}
catch (const Exception&)
{
}
return nullptr;
}
void SfxObjectShell::SetInitialized_Impl( const bool i_fromInitNew )
{
pImpl->bInitialized = true;
if (utl::ConfigManager::IsAvoidConfig())
return;
if ( i_fromInitNew )
{
SetActivateEvent_Impl( SFX_EVENT_CREATEDOC );
SfxGetpApp()->NotifyEvent( SfxEventHint( SFX_EVENT_DOCCREATED, GlobalEventConfig::GetEventName(GlobalEventId::DOCCREATED), this ) );
}
else
{
SfxGetpApp()->NotifyEvent( SfxEventHint( SFX_EVENT_LOADFINISHED, GlobalEventConfig::GetEventName(GlobalEventId::LOADFINISHED), this ) );
}
}
bool SfxObjectShell::IsChangeRecording() const
{
// currently this function needs to be overwritten by Writer and Calc only
SAL_WARN( "sfx", "function not implemented" );
return false;
}
bool SfxObjectShell::HasChangeRecordProtection() const
{
// currently this function needs to be overwritten by Writer and Calc only
SAL_WARN( "sfx", "function not implemented" );
return false;
}
void SfxObjectShell::SetChangeRecording( bool /*bActivate*/ )
{
// currently this function needs to be overwritten by Writer and Calc only
SAL_WARN( "sfx", "function not implemented" );
}
void SfxObjectShell::SetProtectionPassword( const OUString & /*rPassword*/ )
{
// currently this function needs to be overwritten by Writer and Calc only
SAL_WARN( "sfx", "function not implemented" );
}
bool SfxObjectShell::GetProtectionHash( /*out*/ css::uno::Sequence< sal_Int8 > & /*rPasswordHash*/ )
{
// currently this function needs to be overwritten by Writer and Calc only
SAL_WARN( "sfx", "function not implemented" );
return false;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|