forked from LibreOffice/core
-
Notifications
You must be signed in to change notification settings - Fork 2
/
doctemplates.cxx
2763 lines (2236 loc) · 95.5 KB
/
doctemplates.cxx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
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
/* -*- 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 <osl/mutex.hxx>
#include <tools/diagnose_ex.h>
#include <tools/urlobj.hxx>
#include <rtl/ustring.hxx>
#include <sal/log.hxx>
#include <vcl/svapp.hxx>
#include <vcl/wrkwin.hxx>
#include <unotools/pathoptions.hxx>
#include <comphelper/processfactory.hxx>
#include <comphelper/propertysequence.hxx>
#include <comphelper/sequenceashashmap.hxx>
#include <comphelper/storagehelper.hxx>
#include <comphelper/string.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <com/sun/star/beans/IllegalTypeException.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/beans/PropertyExistException.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertySetInfo.hpp>
#include <com/sun/star/beans/XPropertyContainer.hpp>
#include <com/sun/star/beans/StringPair.hpp>
#include <com/sun/star/util/theMacroExpander.hpp>
#include <com/sun/star/util/theOfficeInstallationDirectories.hpp>
#include <com/sun/star/configuration/theDefaultProvider.hpp>
#include <com/sun/star/document/XTypeDetection.hpp>
#include <com/sun/star/document/DocumentProperties.hpp>
#include <com/sun/star/io/TempFile.hpp>
#include <com/sun/star/sdbc/XResultSet.hpp>
#include <com/sun/star/sdbc/XRow.hpp>
#include <com/sun/star/ucb/ContentCreationException.hpp>
#include <com/sun/star/ucb/NameClash.hpp>
#include <com/sun/star/ucb/NameClashException.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/ucb/XContentAccess.hpp>
#include <com/sun/star/frame/ModuleManager.hpp>
#include <com/sun/star/uno/Exception.hpp>
#include <com/sun/star/task/InteractionHandler.hpp>
#include <com/sun/star/ucb/XProgressHandler.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/frame/XDocumentTemplates.hpp>
#include <com/sun/star/frame/XStorable.hpp>
#include <com/sun/star/lang/Locale.hpp>
#include <com/sun/star/lang/XLocalizable.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ucb/XContent.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/util/thePathSettings.hpp>
#include <svtools/templatefoldercache.hxx>
#include <unotools/configmgr.hxx>
#include <unotools/ucbhelper.hxx>
#include <i18nlangtag/languagetag.hxx>
#include <ucbhelper/content.hxx>
#include <sfx2/sfxresid.hxx>
#include <sfxurlrelocator.hxx>
#include "doctemplateslocal.hxx"
#include <sfx2/docfac.hxx>
#include <sfx2/strings.hrc>
#include <doctempl.hrc>
#include <memory>
#include <vector>
#define SERVICENAME_TYPEDETECTION "com.sun.star.document.TypeDetection"
#define TEMPLATE_ROOT_URL "vnd.sun.star.hier:/templates"
#define TITLE "Title"
#define IS_FOLDER "IsFolder"
#define IS_DOCUMENT "IsDocument"
#define TARGET_URL "TargetURL"
#define TEMPLATE_VERSION "TemplateComponentVersion"
#define TEMPLATE_VERSION_VALUE "2"
#define TYPE_FOLDER "application/vnd.sun.star.hier-folder"
#define TYPE_LINK "application/vnd.sun.star.hier-link"
#define TYPE_FSYS_FOLDER "application/vnd.sun.staroffice.fsys-folder"
#define TYPE_FSYS_FILE "application/vnd.sun.staroffice.fsys-file"
#define PROPERTY_DIRLIST "DirectoryList"
#define PROPERTY_NEEDSUPDATE "NeedsUpdate"
#define PROPERTY_TYPE "TypeDescription"
#define TARGET_DIR_URL "TargetDirURL"
#define COMMAND_DELETE "delete"
#define STANDARD_FOLDER "standard"
#define C_DELIM ';'
using namespace ::com::sun::star;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::document;
using namespace ::com::sun::star::io;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::sdbc;
using namespace ::com::sun::star::ucb;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::util;
using namespace ::ucbhelper;
using namespace ::comphelper;
using ::std::vector;
namespace {
class WaitWindow_Impl : public WorkWindow
{
tools::Rectangle maRect;
OUString maText;
static constexpr DrawTextFlags gnTextStyle = DrawTextFlags::Center | DrawTextFlags::VCenter | DrawTextFlags::WordBreak | DrawTextFlags::MultiLine;
public:
WaitWindow_Impl();
virtual ~WaitWindow_Impl() override;
virtual void dispose() override;
virtual void Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect) override;
};
#define X_OFFSET 15
#define Y_OFFSET 15
struct NamePair_Impl
{
OUString maShortName;
OUString maLongName;
};
class DocTemplates_EntryData_Impl;
class GroupData_Impl;
typedef vector< std::unique_ptr<GroupData_Impl> > GroupList_Impl;
class TplTaskEnvironment : public ::cppu::WeakImplHelper< ucb::XCommandEnvironment >
{
uno::Reference< task::XInteractionHandler > m_xInteractionHandler;
public:
explicit TplTaskEnvironment( const uno::Reference< task::XInteractionHandler>& rxInteractionHandler )
: m_xInteractionHandler( rxInteractionHandler )
{}
virtual uno::Reference<task::XInteractionHandler> SAL_CALL getInteractionHandler() override
{ return m_xInteractionHandler; }
virtual uno::Reference<ucb::XProgressHandler> SAL_CALL getProgressHandler() override
{ return uno::Reference<ucb::XProgressHandler>(); }
};
class SfxDocTplService_Impl
{
uno::Reference< XComponentContext > mxContext;
uno::Reference< XCommandEnvironment > maCmdEnv;
uno::Reference< XDocumentProperties> m_xDocProps;
uno::Reference< XTypeDetection > mxType;
::osl::Mutex maMutex;
Sequence< OUString > maTemplateDirs;
Sequence< OUString > maInternalTemplateDirs;
OUString maRootURL;
std::vector< std::unique_ptr<NamePair_Impl> > maNames;
lang::Locale maLocale;
Content maRootContent;
bool mbIsInitialized : 1;
bool mbLocaleSet : 1;
SfxURLRelocator_Impl maRelocator;
void init_Impl();
void getDefaultLocale();
void getDirList();
void readFolderList();
bool needsUpdate();
OUString getLongName( const OUString& rShortName );
bool setTitleForURL( const OUString& rURL, const OUString& aTitle );
void getTitleFromURL( const OUString& rURL, OUString& aTitle, OUString& aType, bool& bDocHasTitle );
bool addEntry( Content& rParentFolder,
const OUString& rTitle,
const OUString& rTargetURL,
const OUString& rType );
bool createFolder( const OUString& rNewFolderURL,
bool bCreateParent,
bool bFsysFolder,
Content &rNewFolder );
static bool CreateNewUniqueFolderWithPrefix( const OUString& aPath,
const OUString& aPrefix,
OUString& aNewFolderName,
OUString& aNewFolderURL,
Content& aNewFolder );
static OUString CreateNewUniqueFileWithPrefix( const OUString& aPath,
const OUString& aPrefix,
const OUString& aExt );
std::vector< beans::StringPair > ReadUINamesForTemplateDir_Impl( const OUString& aUserPath );
bool UpdateUINamesForTemplateDir_Impl( const OUString& aUserPath,
const OUString& aGroupName,
const OUString& aNewFolderName );
bool ReplaceUINamesForTemplateDir_Impl( const OUString& aUserPath,
const OUString& aFsysGroupName,
const OUString& aOldGroupName,
const OUString& aNewGroupName );
void RemoveUINamesForTemplateDir_Impl( const OUString& aUserPath,
const OUString& aGroupName );
bool WriteUINamesForTemplateDir_Impl( const OUString& aUserPath,
const std::vector< beans::StringPair >& aUINames );
OUString CreateNewGroupFsys( const OUString& rGroupName, Content& aGroup );
static bool removeContent( Content& rContent );
bool removeContent( const OUString& rContentURL );
bool setProperty( Content& rContent,
const OUString& rPropName,
const Any& rPropValue );
bool getProperty( Content& rContent,
const OUString& rPropName,
Any& rPropValue );
void createFromContent( GroupList_Impl& rList,
Content &rContent,
bool bHierarchy,
bool bWriteableContent );
void addHierGroup( GroupList_Impl& rList,
const OUString& rTitle,
const OUString& rOwnURL );
void addFsysGroup( GroupList_Impl& rList,
const OUString& rTitle,
const OUString& rUITitle,
const OUString& rOwnURL,
bool bWriteableGroup );
void removeFromHierarchy( DocTemplates_EntryData_Impl const *pData );
void addToHierarchy( GroupData_Impl const *pGroup,
DocTemplates_EntryData_Impl const *pData );
void removeFromHierarchy( GroupData_Impl const *pGroup );
void addGroupToHierarchy( GroupData_Impl *pGroup );
void updateData( DocTemplates_EntryData_Impl const *pData );
//See: #i66157# and rhbz#1065807
//return which template dir the rURL is a subpath of
OUString findParentTemplateDir(const OUString& rURL) const;
//See: #i66157# and rhbz#1065807
//return true if rURL is a path (or subpath of) a dir which is not a user path
//which implies neither it or its contents can be removed
bool isInternalTemplateDir(const OUString& rURL) const;
public:
explicit SfxDocTplService_Impl( const uno::Reference< XComponentContext > & xContext );
~SfxDocTplService_Impl();
bool init() { if ( !mbIsInitialized ) init_Impl(); return mbIsInitialized; }
const Content& getContent() const { return maRootContent; }
void setLocale( const lang::Locale & rLocale );
lang::Locale getLocale();
bool storeTemplate( const OUString& rGroupName,
const OUString& rTemplateName,
const uno::Reference< frame::XStorable >& rStorable );
bool addTemplate( const OUString& rGroupName,
const OUString& rTemplateName,
const OUString& rSourceURL );
bool removeTemplate( const OUString& rGroupName,
const OUString& rTemplateName );
bool renameTemplate( const OUString& rGroupName,
const OUString& rOldName,
const OUString& rNewName );
bool addGroup( const OUString& rGroupName );
bool removeGroup( const OUString& rGroupName );
bool renameGroup( const OUString& rOldName,
const OUString& rNewName );
void update();
void doUpdate();
};
class DocTemplates_EntryData_Impl
{
OUString maTitle;
OUString maType;
OUString maTargetURL;
OUString maHierarchyURL;
bool mbInHierarchy : 1;
bool mbInUse : 1;
bool mbUpdateType : 1;
bool mbUpdateLink : 1;
public:
explicit DocTemplates_EntryData_Impl( const OUString& rTitle );
void setInUse() { mbInUse = true; }
void setHierarchy( bool bInHierarchy ) { mbInHierarchy = bInHierarchy; }
void setUpdateLink( bool bUpdateLink ) { mbUpdateLink = bUpdateLink; }
void setUpdateType( bool bUpdateType ) { mbUpdateType = bUpdateType; }
bool getInUse() const { return mbInUse; }
bool getInHierarchy() const { return mbInHierarchy; }
bool getUpdateLink() const { return mbUpdateLink; }
bool getUpdateType() const { return mbUpdateType; }
const OUString& getHierarchyURL() const { return maHierarchyURL; }
const OUString& getTargetURL() const { return maTargetURL; }
const OUString& getTitle() const { return maTitle; }
const OUString& getType() const { return maType; }
void setHierarchyURL( const OUString& rURL ) { maHierarchyURL = rURL; }
void setTargetURL( const OUString& rURL ) { maTargetURL = rURL; }
void setType( const OUString& rType ) { maType = rType; }
};
class GroupData_Impl
{
std::vector< std::unique_ptr<DocTemplates_EntryData_Impl> > maEntries;
OUString maTitle;
OUString maHierarchyURL;
OUString maTargetURL;
bool mbInUse : 1;
bool mbInHierarchy : 1;
public:
explicit GroupData_Impl( const OUString& rTitle );
void setInUse() { mbInUse = true; }
void setHierarchy( bool bInHierarchy ) { mbInHierarchy = bInHierarchy; }
void setHierarchyURL( const OUString& rURL ) { maHierarchyURL = rURL; }
void setTargetURL( const OUString& rURL ) { maTargetURL = rURL; }
bool getInUse() const { return mbInUse; }
bool getInHierarchy() const { return mbInHierarchy; }
const OUString& getHierarchyURL() const { return maHierarchyURL; }
const OUString& getTargetURL() const { return maTargetURL; }
const OUString& getTitle() const { return maTitle; }
DocTemplates_EntryData_Impl* addEntry( const OUString& rTitle,
const OUString& rTargetURL,
const OUString& rType,
const OUString& rHierURL );
size_t count() { return maEntries.size(); }
DocTemplates_EntryData_Impl* getEntry( size_t nPos ) { return maEntries[ nPos ].get(); }
};
// private SfxDocTplService_Impl
void SfxDocTplService_Impl::init_Impl()
{
uno::Reference< uno::XComponentContext > xContext = ::comphelper::getProcessComponentContext();
uno::Reference < task::XInteractionHandler > xInteractionHandler(
task::InteractionHandler::createWithParent(xContext, nullptr), uno::UNO_QUERY_THROW );
maCmdEnv = new TplTaskEnvironment( xInteractionHandler );
::osl::ClearableMutexGuard aGuard( maMutex );
bool bIsInitialized = false;
bool bNeedsUpdate = false;
if ( !mbLocaleSet )
getDefaultLocale();
// convert locale to string
// set maRootContent to the root of the templates hierarchy. Create the
// entry if necessary
maRootURL = ( TEMPLATE_ROOT_URL "/" ) + LanguageTag::convertToBcp47(maLocale);
const OUString aTemplVersPropName( TEMPLATE_VERSION );
const OUString aTemplVers( TEMPLATE_VERSION_VALUE );
if ( Content::create( maRootURL, maCmdEnv, comphelper::getProcessComponentContext(), maRootContent ) )
{
uno::Any aValue;
OUString aPropValue;
if ( getProperty( maRootContent, aTemplVersPropName, aValue )
&& ( aValue >>= aPropValue )
&& aPropValue == aTemplVers )
{
bIsInitialized = true;
}
else
removeContent( maRootContent );
}
if ( !bIsInitialized )
{
if ( createFolder( maRootURL, true, false, maRootContent )
&& setProperty( maRootContent, aTemplVersPropName, uno::makeAny( aTemplVers ) ) )
bIsInitialized = true;
bNeedsUpdate = true;
}
if ( bIsInitialized )
{
try {
m_xDocProps.set(document::DocumentProperties::create(
::comphelper::getProcessComponentContext()));
} catch (uno::RuntimeException const&) {
TOOLS_WARN_EXCEPTION("sfx.doc", "SfxDocTplService_Impl::init_Impl: cannot create DocumentProperties service:");
}
OUString const aService = SERVICENAME_TYPEDETECTION;
mxType.set( mxContext->getServiceManager()->createInstanceWithContext(aService, mxContext), UNO_QUERY );
getDirList();
readFolderList();
if ( bNeedsUpdate )
{
aGuard.clear();
SolarMutexClearableGuard aSolarGuard;
VclPtrInstance< WaitWindow_Impl > pWin;
aSolarGuard.clear();
{
osl::MutexGuard anotherGuard(maMutex);
update();
}
SolarMutexGuard aSecondSolarGuard;
pWin.disposeAndClear();
}
else if ( needsUpdate() )
// the UI should be shown only on the first update
update();
}
else
{
SAL_WARN( "sfx.doc", "init_Impl(): Could not create root" );
}
mbIsInitialized = bIsInitialized;
}
void SfxDocTplService_Impl::getDefaultLocale()
{
if ( !mbLocaleSet )
{
::osl::MutexGuard aGuard( maMutex );
if ( !mbLocaleSet )
{
maLocale = LanguageTag::convertToLocale( utl::ConfigManager::getUILocale(), false);
mbLocaleSet = true;
}
}
}
const char* TEMPLATE_SHORT_NAMES_ARY[] =
{
"standard",
"officorr",
"offimisc",
"personal",
"forms",
"finance",
"educate",
"layout",
"presnt",
"misc",
"labels",
"styles"
};
void SfxDocTplService_Impl::readFolderList()
{
SolarMutexGuard aGuard;
static_assert( SAL_N_ELEMENTS(TEMPLATE_SHORT_NAMES_ARY) == SAL_N_ELEMENTS(TEMPLATE_LONG_NAMES_ARY), "mismatch array lengths" );
const size_t nCount = std::min(SAL_N_ELEMENTS(TEMPLATE_SHORT_NAMES_ARY), SAL_N_ELEMENTS(TEMPLATE_LONG_NAMES_ARY));
for (size_t i = 0; i < nCount; ++i)
{
std::unique_ptr<NamePair_Impl> pPair( new NamePair_Impl );
pPair->maShortName = OUString::createFromAscii(TEMPLATE_SHORT_NAMES_ARY[i]);
pPair->maLongName = SfxResId(TEMPLATE_LONG_NAMES_ARY[i]);
maNames.push_back( std::move(pPair) );
}
}
OUString SfxDocTplService_Impl::getLongName( const OUString& rShortName )
{
OUString aRet;
for (auto const & pPair : maNames)
{
if ( pPair->maShortName == rShortName )
{
aRet = pPair->maLongName;
break;
}
}
if ( aRet.isEmpty() )
aRet = rShortName;
return aRet;
}
void SfxDocTplService_Impl::getDirList()
{
Any aValue;
// Get the template dir list
// TODO/LATER: let use service, register listener
INetURLObject aURL;
OUString aDirs = SvtPathOptions().GetTemplatePath();
sal_Int32 nCount = comphelper::string::getTokenCount(aDirs, C_DELIM);
maTemplateDirs = Sequence< OUString >( nCount );
uno::Reference< util::XMacroExpander > xExpander = util::theMacroExpander::get(mxContext);
const OUString aPrefix(
"vnd.sun.star.expand:" );
sal_Int32 nIdx{ 0 };
for (auto& rTemplateDir : maTemplateDirs)
{
aURL.SetSmartProtocol( INetProtocol::File );
aURL.SetURL( aDirs.getToken( 0, C_DELIM, nIdx ) );
rTemplateDir = aURL.GetMainURL( INetURLObject::DecodeMechanism::NONE );
if ( xExpander.is() )
{
const sal_Int32 nIndex{ rTemplateDir.indexOf( aPrefix ) };
if (nIndex<0)
continue;
rTemplateDir = rTemplateDir.replaceAt(nIndex, aPrefix.getLength(), OUString());
rTemplateDir = xExpander->expandMacros( rTemplateDir );
}
}
aValue <<= maTemplateDirs;
css::uno::Reference< css::util::XPathSettings > xPathSettings =
css::util::thePathSettings::get(mxContext);
// load internal paths
Any aAny = xPathSettings->getPropertyValue( "Template_internal" );
aAny >>= maInternalTemplateDirs;
for (auto& rInternalTemplateDir : maInternalTemplateDirs)
{
//expand vnd.sun.star.expand: and remove "..." from them
//to normalize into the expected url patterns
maRelocator.makeRelocatableURL(rInternalTemplateDir);
maRelocator.makeAbsoluteURL(rInternalTemplateDir);
}
// Store the template dir list
setProperty( maRootContent, PROPERTY_DIRLIST, aValue );
}
bool SfxDocTplService_Impl::needsUpdate()
{
bool bNeedsUpdate = true;
Any aValue;
// Get the template dir list
bool bHasProperty = getProperty( maRootContent, PROPERTY_NEEDSUPDATE, aValue );
if ( bHasProperty )
aValue >>= bNeedsUpdate;
// the old template component also checks this state, but it is initialized from this component
// so if this component was already updated the old component does not need such an update
::svt::TemplateFolderCache aTempCache;
if ( !bNeedsUpdate )
bNeedsUpdate = aTempCache.needsUpdate();
if ( bNeedsUpdate )
aTempCache.storeState();
return bNeedsUpdate;
}
bool SfxDocTplService_Impl::setTitleForURL( const OUString& rURL, const OUString& aTitle )
{
if (m_xDocProps.is())
{
try
{
m_xDocProps->loadFromMedium(rURL, Sequence<PropertyValue>());
m_xDocProps->setTitle(aTitle);
uno::Reference< embed::XStorage > xStorage = ::comphelper::OStorageHelper::GetStorageFromURL(
rURL, embed::ElementModes::READWRITE);
uno::Sequence<beans::PropertyValue> medium( comphelper::InitPropertySequence({
{ "DocumentBaseURL", Any(rURL) },
{ "URL", Any(rURL) }
}));
m_xDocProps->storeToStorage(xStorage, medium);
return true;
}
catch ( Exception& )
{
}
}
return false;
}
void SfxDocTplService_Impl::getTitleFromURL( const OUString& rURL, OUString& aTitle, OUString& aType, bool& bDocHasTitle )
{
bDocHasTitle = false;
if (m_xDocProps.is())
{
try
{
m_xDocProps->loadFromMedium(rURL, Sequence<PropertyValue>());
aTitle = m_xDocProps->getTitle();
}
catch ( Exception& )
{
}
}
if ( aType.isEmpty() && mxType.is() )
{
const OUString aDocType {mxType->queryTypeByURL( rURL )};
if ( !aDocType.isEmpty() )
try
{
uno::Reference< container::XNameAccess > xTypeDetection( mxType, uno::UNO_QUERY_THROW );
SequenceAsHashMap aTypeProps( xTypeDetection->getByName( aDocType ) );
aType = aTypeProps.getUnpackedValueOrDefault(
"MediaType",
OUString() );
}
catch( uno::Exception& )
{}
}
if ( aTitle.isEmpty() )
{
INetURLObject aURL( rURL );
aURL.CutExtension();
aTitle = aURL.getName( INetURLObject::LAST_SEGMENT, true,
INetURLObject::DecodeMechanism::WithCharset );
}
else
bDocHasTitle = true;
}
bool SfxDocTplService_Impl::addEntry( Content& rParentFolder,
const OUString& rTitle,
const OUString& rTargetURL,
const OUString& rType )
{
bool bAddedEntry = false;
INetURLObject aLinkObj( rParentFolder.getURL() );
aLinkObj.insertName( rTitle, false,
INetURLObject::LAST_SEGMENT,
INetURLObject::EncodeMechanism::All );
const OUString aLinkURL {aLinkObj.GetMainURL( INetURLObject::DecodeMechanism::NONE )};
Content aLink;
if ( ! Content::create( aLinkURL, maCmdEnv, comphelper::getProcessComponentContext(), aLink ) )
{
Sequence< OUString > aNames(3);
aNames[0] = TITLE;
aNames[1] = IS_FOLDER;
aNames[2] = TARGET_URL;
Sequence< Any > aValues(3);
aValues[0] <<= rTitle;
aValues[1] <<= false;
aValues[2] <<= rTargetURL;
try
{
rParentFolder.insertNewContent( TYPE_LINK, aNames, aValues, aLink );
setProperty( aLink, PROPERTY_TYPE, makeAny( rType ) );
bAddedEntry = true;
}
catch( Exception& )
{}
}
return bAddedEntry;
}
bool SfxDocTplService_Impl::createFolder( const OUString& rNewFolderURL,
bool bCreateParent,
bool bFsysFolder,
Content &rNewFolder )
{
Content aParent;
bool bCreatedFolder = false;
INetURLObject aParentURL( rNewFolderURL );
const OUString aFolderName {aParentURL.getName( INetURLObject::LAST_SEGMENT, true,
INetURLObject::DecodeMechanism::WithCharset )};
// compute the parent folder url from the new folder url
// and remove the final slash, because Content::create doesn't
// like it
aParentURL.removeSegment();
if ( aParentURL.getSegmentCount() >= 1 )
aParentURL.removeFinalSlash();
// if the parent exists, we can continue with the creation of the
// new folder, we have to create the parent otherwise ( as long as
// bCreateParent is set to true )
if ( Content::create( aParentURL.GetMainURL( INetURLObject::DecodeMechanism::NONE ), maCmdEnv, comphelper::getProcessComponentContext(), aParent ) )
{
try
{
Sequence< OUString > aNames(2);
aNames[0] = TITLE;
aNames[1] = IS_FOLDER;
Sequence< Any > aValues(2);
aValues[0] <<= aFolderName;
aValues[1] <<= true;
OUString aType;
if ( bFsysFolder )
aType = TYPE_FSYS_FOLDER;
else
aType = TYPE_FOLDER;
aParent.insertNewContent( aType, aNames, aValues, rNewFolder );
bCreatedFolder = true;
}
catch( Exception const & )
{
TOOLS_WARN_EXCEPTION( "sfx.doc", "createFolder(): Could not create new folder" );
}
}
else if ( bCreateParent )
{
// if the parent doesn't exists and bCreateParent is set to true,
// we try to create the parent and if this was successful, we
// try to create the new folder again ( but this time, we set
// bCreateParent to false to avoid endless recursions )
if ( ( aParentURL.getSegmentCount() >= 1 ) &&
createFolder( aParentURL.GetMainURL( INetURLObject::DecodeMechanism::NONE ), bCreateParent, bFsysFolder, aParent ) )
{
bCreatedFolder = createFolder( rNewFolderURL, false, bFsysFolder, rNewFolder );
}
}
return bCreatedFolder;
}
bool SfxDocTplService_Impl::CreateNewUniqueFolderWithPrefix( const OUString& aPath,
const OUString& aPrefix,
OUString& aNewFolderName,
OUString& aNewFolderURL,
Content& aNewFolder )
{
bool bCreated = false;
INetURLObject aDirPath( aPath );
Content aParent;
uno::Reference< XCommandEnvironment > aQuietEnv;
if ( Content::create( aDirPath.GetMainURL( INetURLObject::DecodeMechanism::NONE ), aQuietEnv, comphelper::getProcessComponentContext(), aParent ) )
{
for ( sal_Int32 nInd = 0; nInd < 32000; nInd++ )
{
OUString aTryName = aPrefix;
if ( nInd )
aTryName += OUString::number( nInd );
try
{
Sequence< OUString > aNames(2);
aNames[0] = TITLE;
aNames[1] = IS_FOLDER;
Sequence< Any > aValues(2);
aValues[0] <<= aTryName;
aValues[1] <<= true;
bCreated = aParent.insertNewContent( TYPE_FSYS_FOLDER, aNames, aValues, aNewFolder );
}
catch( ucb::NameClashException& )
{
// if there is already an element, retry
}
catch( Exception& )
{
INetURLObject aObjPath( aDirPath );
aObjPath.insertName( aTryName, false,
INetURLObject::LAST_SEGMENT,
INetURLObject::EncodeMechanism::All );
// if there is already an element, retry
// if there was another error, do not try any more
if ( !::utl::UCBContentHelper::Exists( aObjPath.GetMainURL( INetURLObject::DecodeMechanism::NONE ) ) )
break;
}
if ( bCreated )
{
aNewFolderName = aTryName;
aNewFolderURL = aNewFolder.get()->getIdentifier()->getContentIdentifier();
break;
}
}
}
return bCreated;
}
OUString SfxDocTplService_Impl::CreateNewUniqueFileWithPrefix( const OUString& aPath,
const OUString& aPrefix,
const OUString& aExt )
{
OUString aNewFileURL;
INetURLObject aDirPath( aPath );
Content aParent;
uno::Reference< XCommandEnvironment > aQuietEnv;
if ( Content::create( aDirPath.GetMainURL( INetURLObject::DecodeMechanism::NONE ), aQuietEnv, comphelper::getProcessComponentContext(), aParent ) )
{
for ( sal_Int32 nInd = 0; nInd < 32000; nInd++ )
{
Content aNewFile;
bool bCreated = false;
OUString aTryName = aPrefix;
if ( nInd )
aTryName += OUString::number( nInd );
if ( aExt.toChar() != '.' )
aTryName += ".";
aTryName += aExt;
try
{
Sequence< OUString > aNames(2);
aNames[0] = TITLE;
aNames[1] = IS_DOCUMENT;
Sequence< Any > aValues(2);
aValues[0] <<= aTryName;
aValues[1] <<= true;
bCreated = aParent.insertNewContent( TYPE_FSYS_FILE, aNames, aValues, aNewFile );
}
catch( ucb::NameClashException& )
{
// if there is already an element, retry
}
catch( Exception& )
{
INetURLObject aObjPath( aPath );
aObjPath.insertName( aTryName, false,
INetURLObject::LAST_SEGMENT,
INetURLObject::EncodeMechanism::All );
// if there is already an element, retry
// if there was another error, do not try any more
if ( !::utl::UCBContentHelper::Exists( aObjPath.GetMainURL( INetURLObject::DecodeMechanism::NONE ) ) )
break;
}
if ( bCreated )
{
aNewFileURL = aNewFile.get()->getIdentifier()->getContentIdentifier();
break;
}
}
}
return aNewFileURL;
}
bool SfxDocTplService_Impl::removeContent( Content& rContent )
{
bool bRemoved = false;
try
{
Any aArg = makeAny( true );
rContent.executeCommand( COMMAND_DELETE, aArg );
bRemoved = true;
}
catch ( RuntimeException& ) {}
catch ( Exception& ) {}
return bRemoved;
}
bool SfxDocTplService_Impl::removeContent( const OUString& rContentURL )
{
Content aContent;
if ( Content::create( rContentURL, maCmdEnv, comphelper::getProcessComponentContext(), aContent ) )
return removeContent( aContent );
return false;
}
bool SfxDocTplService_Impl::setProperty( Content& rContent,
const OUString& rPropName,
const Any& rPropValue )
{
bool bPropertySet = false;
// Store the property
try
{
Any aPropValue( rPropValue );
uno::Reference< XPropertySetInfo > aPropInfo = rContent.getProperties();
// check, whether or not the property exists, create it, when not
if ( !aPropInfo.is() || !aPropInfo->hasPropertyByName( rPropName ) )
{
uno::Reference< XPropertyContainer > xProperties( rContent.get(), UNO_QUERY );
if ( xProperties.is() )
{
try
{
xProperties->addProperty( rPropName, PropertyAttribute::MAYBEVOID, rPropValue );
}
catch( PropertyExistException& ) {}
catch( IllegalTypeException& ) {
SAL_WARN( "sfx.doc", "IllegalTypeException" );
}
catch( IllegalArgumentException& ) {
SAL_WARN( "sfx.doc", "IllegalArgumentException" );
}
}
}
// To ensure a reloctable office installation, the path to the
// office installation directory must never be stored directly.
if ( SfxURLRelocator_Impl::propertyCanContainOfficeDir( rPropName ) )
{
OUString aValue;
if ( rPropValue >>= aValue )
{
maRelocator.makeRelocatableURL( aValue );
aPropValue <<= aValue;
}
else
{
Sequence< OUString > aValues;
if ( rPropValue >>= aValues )
{
for ( auto& rValue : aValues )
{
maRelocator.makeRelocatableURL( rValue );
}
aPropValue <<= aValues;
}
else
{
OSL_FAIL( "Unsupported property value type" );
}
}
}