?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Version 3.6.0.4, tag libreoffice-3.6.0.4
[LibreOffice.git] / sfx2 / source / doc / docfac.cxx
blobde87ca6db8fcb4baab5a43e1b366f93eba73de31
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*************************************************************************
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 *
8 * OpenOffice.org - a multi-platform office productivity suite
9 *
10 * This file is part of OpenOffice.org.
11 *
12 * OpenOffice.org is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 3
14 * only, as published by the Free Software Foundation.
15 *
16 * OpenOffice.org is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Lesser General Public License version 3 for more details
20 * (a copy is included in the LICENSE file that accompanied this code).
21 *
22 * You should have received a copy of the GNU Lesser General Public License
23 * version 3 along with OpenOffice.org. If not, see
24 * <http://www.openoffice.org/license.html>
25 * for a copy of the LGPLv3 License.
26 *
27 ************************************************************************/
28
29 #include <com/sun/star/registry/MergeConflictException.hpp>
30 #include <com/sun/star/registry/XSimpleRegistry.hpp>
31 #include <com/sun/star/container/XNameAccess.hpp>
32 #include <com/sun/star/ucb/XSimpleFileAccess.hpp>
33 #include <com/sun/star/document/XTypeDetection.hpp>
34 #include <com/sun/star/frame/XLoadable.hpp>
35 #include <com/sun/star/frame/XStorable.hpp>
36 #include <comphelper/processfactory.hxx>
37 #include <unotools/pathoptions.hxx>
38 #include <unotools/moduleoptions.hxx>
39 #include <unotools/ucbstreamhelper.hxx>
40 #include <unotools/localfilehelper.hxx>
41 #include <comphelper/sequenceashashmap.hxx>
42 #include <comphelper/configurationhelper.hxx>
43
44 #include <sfx2/sfx.hrc>
45 #include <sfx2/docfilt.hxx>
46 #include <sfx2/docfac.hxx>
47 #include "sfx2/viewfac.hxx"
48 #include "fltfnc.hxx"
49 #include "arrdecl.hxx"
50 #include <sfx2/app.hxx>
51 #include <sfx2/module.hxx>
52 #include <sfx2/mnumgr.hxx>
53 #include "sfx2/sfxresid.hxx"
54 #include <sfx2/sfxuno.hxx>
55 #include "syspath.hxx"
56 #include <osl/file.hxx>
57 #include <osl/security.hxx>
58 #include "doc.hrc"
59
60 #include <rtl/strbuf.hxx>
61
62 #include <assert.h>
63
64 namespace css = ::com::sun::star;
65 using namespace ::com::sun::star;
66
67 //========================================================================
68
69 DECL_PTRARRAY( SfxViewFactoryArr_Impl, SfxViewFactory*, 2, 2 )
70
71 //========================================================================
72
73 DBG_NAME(SfxObjectFactory)
74
75 //========================================================================
76
77 struct SfxObjectFactory_Impl
78 {
79 SfxViewFactoryArr_Impl aViewFactoryArr;// List of <SfxViewFactory>s
80 SfxFilterArr_Impl aFilterArr; // List of <SFxFilter>n
81 ResId* pNameResId;
82 ::rtl::OUString aServiceName;
83 SfxFilterContainer* pFilterContainer;
84 SfxModule* pModule;
85 sal_uInt16 nImageId;
86 String aStandardTemplate;
87 sal_Bool bTemplateInitialized;
88 SvGlobalName aClassName;
89
90 SfxObjectFactory_Impl() :
91 pNameResId ( NULL ),
92 pFilterContainer ( NULL ),
93 pModule ( NULL ),
94 nImageId ( 0 ),
95 bTemplateInitialized( sal_False )
96 {}
97 };
98
99 //========================================================================
100
101 SfxFilterContainer* SfxObjectFactory::GetFilterContainer( sal_Bool /*bForceLoad*/ ) const
102 {
103 return pImpl->pFilterContainer;
104 }
105
106 //--------------------------------------------------------------------
107
108 SfxObjectFactory::SfxObjectFactory
109 (
110 const SvGlobalName& rName,
111 SfxObjectShellFlags nFlagsP,
112 const char* pName
113 ) : pShortName( pName ),
114 pImpl( new SfxObjectFactory_Impl ),
115 nFlags( nFlagsP )
116 {
117 DBG_CTOR(SfxObjectFactory, 0);
118 pImpl->pFilterContainer = new SfxFilterContainer( String::CreateFromAscii( pName ) );
119
120 String aShortName( String::CreateFromAscii( pShortName ) );
121 aShortName.ToLowerAscii();
122 pImpl->aClassName = rName;
123 if ( aShortName.EqualsAscii( "swriter" ) )
124 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SW );
125 else if ( aShortName.EqualsAscii( "swriter/web" ) )
126 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SWWEB );
127 else if ( aShortName.EqualsAscii( "swriter/globaldocument" ) )
128 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SWGLOB );
129 else if ( aShortName.EqualsAscii( "scalc" ) )
130 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SC );
131 else if ( aShortName.EqualsAscii( "simpress" ) )
132 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SI );
133 else if ( aShortName.EqualsAscii( "sdraw" ) )
134 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_SD );
135 else if ( aShortName.EqualsAscii( "message" ) )
136 pImpl->pNameResId = new SfxResId( STR_DOCTYPENAME_MESSAGE );
137 }
138
139 //--------------------------------------------------------------------
140
141 SfxObjectFactory::~SfxObjectFactory()
142 {
143 DBG_DTOR(SfxObjectFactory, 0);
144
145 const sal_uInt16 nCount = pImpl->aFilterArr.Count();
146 for ( sal_uInt16 i = 0; i < nCount; ++i )
147 delete pImpl->aFilterArr[i];
148 delete pImpl->pNameResId;
149 delete pImpl->pFilterContainer;
150 delete pImpl;
151 }
152
153 //--------------------------------------------------------------------
154
155 void SfxObjectFactory::RegisterViewFactory
156 (
157 SfxViewFactory &rFactory
158 )
159 {
160 #if OSL_DEBUG_LEVEL > 0
161 {
162 const String sViewName( rFactory.GetAPIViewName() );
163 for ( sal_uInt16 i = 0; i < pImpl->aViewFactoryArr.Count(); ++i )
164 {
165 if ( !pImpl->aViewFactoryArr[i]->GetAPIViewName().Equals( sViewName ) )
166 continue;
167 rtl::OStringBuffer aStr(RTL_CONSTASCII_STRINGPARAM(
168 "SfxObjectFactory::RegisterViewFactory: duplicate view name '"));
169 aStr.append(rtl::OUStringToOString(sViewName, RTL_TEXTENCODING_ASCII_US));
170 aStr.append(RTL_CONSTASCII_STRINGPARAM("'!"));
171 OSL_FAIL(aStr.getStr());
172 break;
173 }
174 }
175 #endif
176 sal_uInt16 nPos;
177 for ( nPos = 0;
178 nPos < pImpl->aViewFactoryArr.Count() &&
179 pImpl->aViewFactoryArr[nPos]->GetOrdinal() <= rFactory.GetOrdinal();
180 ++nPos )
181 /* empty loop */;
182 pImpl->aViewFactoryArr.Insert(nPos, &rFactory);
183 }
184
185 //--------------------------------------------------------------------
186
187 sal_uInt16 SfxObjectFactory::GetViewFactoryCount() const
188 {
189 return pImpl->aViewFactoryArr.Count();
190 }
191
192 //--------------------------------------------------------------------
193
194 SfxViewFactory& SfxObjectFactory::GetViewFactory(sal_uInt16 i) const
195 {
196 return *pImpl->aViewFactoryArr[i];
197 }
198
199 //--------------------------------------------------------------------
200
201 SfxModule* SfxObjectFactory::GetModule() const
202 {
203 return pImpl->pModule;
204 }
205
206 void SfxObjectFactory::SetModule_Impl( SfxModule *pMod )
207 {
208 pImpl->pModule = pMod;
209 }
210
211 void SfxObjectFactory::SetSystemTemplate( const String& rServiceName, const String& rTemplateName )
212 {
213 static const int nMaxPathSize = 16000;
214 static ::rtl::OUString SERVICE_FILTER_FACTORY("com.sun.star.document.FilterFactory");
215 static ::rtl::OUString SERVICE_TYPE_DECTECTION("com.sun.star.document.TypeDetection");
216 static ::rtl::OUString SERVICE_SIMPLE_ACCESS("com.sun.star.ucb.SimpleFileAccess");
217
218 static ::rtl::OUString CONF_ROOT("/org.openoffice.Setup");
219 static ::rtl::OUString CONF_PATH = ::rtl::OUString("Office/Factories/" ) + ::rtl::OUString( rServiceName );
220 static ::rtl::OUString PROP_DEF_TEMPL_CHANGED("ooSetupFactorySystemDefaultTemplateChanged");
221 static ::rtl::OUString PROP_ACTUAL_FILTER("ooSetupFactoryActualFilter");
222
223 static ::rtl::OUString DEF_TPL_STR("/soffice.");
224
225 rtl::OUString sURL;
226 String sPath;
227 sal_Unicode aPathBuffer[nMaxPathSize];
228 if ( SystemPath::GetUserTemplateLocation( aPathBuffer, nMaxPathSize ))
229 sPath = String( aPathBuffer );
230 ::utl::LocalFileHelper::ConvertPhysicalNameToURL( sPath, sURL );
231
232 ::rtl::OUString aUserTemplateURL( sURL );
233 if ( !aUserTemplateURL.isEmpty())
234 {
235 try
236 {
237 uno::Reference< lang::XMultiServiceFactory > xFactory = ::comphelper::getProcessServiceFactory();
238 uno::Reference< uno::XInterface > xConfig = ::comphelper::ConfigurationHelper::openConfig(
239 xFactory, CONF_ROOT, ::comphelper::ConfigurationHelper::E_STANDARD );
240
241 ::rtl::OUString aActualFilter;
242 ::comphelper::ConfigurationHelper::readRelativeKey( xConfig, CONF_PATH, PROP_ACTUAL_FILTER ) >>= aActualFilter;
243 sal_Bool bChanged(sal_False);
244 ::comphelper::ConfigurationHelper::readRelativeKey( xConfig, CONF_PATH, PROP_DEF_TEMPL_CHANGED ) >>= bChanged;
245
246 uno::Reference< container::XNameAccess > xFilterFactory(
247 xFactory->createInstance( SERVICE_FILTER_FACTORY ), uno::UNO_QUERY_THROW );
248 uno::Reference< container::XNameAccess > xTypeDetection(
249 xFactory->createInstance( SERVICE_TYPE_DECTECTION ), uno::UNO_QUERY_THROW );
250
251 ::rtl::OUString aActualFilterTypeName;
252 uno::Sequence< beans::PropertyValue > aActuralFilterData;
253 xFilterFactory->getByName( aActualFilter ) >>= aActuralFilterData;
254 for ( sal_Int32 nInd = 0; nInd < aActuralFilterData.getLength(); nInd++ )
255 if ( aActuralFilterData[nInd].Name == "Type" )
256 aActuralFilterData[nInd].Value >>= aActualFilterTypeName;
257 ::comphelper::SequenceAsHashMap aProps1( xTypeDetection->getByName( aActualFilterTypeName ) );
258 uno::Sequence< ::rtl::OUString > aAllExt =
259 aProps1.getUnpackedValueOrDefault( ::rtl::OUString("Extensions"), uno::Sequence< ::rtl::OUString >() );
260 //To-do: check if aAllExt is empty first
261 ::rtl::OUString aExt = aAllExt[0];
262
263 aUserTemplateURL += DEF_TPL_STR;
264 aUserTemplateURL += aExt;
265
266 uno::Reference< ucb::XSimpleFileAccess > xSimpleFileAccess(
267 xFactory->createInstance( SERVICE_SIMPLE_ACCESS ), uno::UNO_QUERY_THROW );
268
269 ::rtl::OUString aBackupURL;
270 ::osl::Security().getConfigDir(aBackupURL);
271 aBackupURL += ::rtl::OUString("/temp");
272
273 if ( !xSimpleFileAccess->exists( aBackupURL ) )
274 xSimpleFileAccess->createFolder( aBackupURL );
275
276 aBackupURL += DEF_TPL_STR;
277 aBackupURL += aExt;
278
279 if ( rTemplateName.Len() != 0 )
280 {
281 if ( xSimpleFileAccess->exists( aUserTemplateURL ) && !bChanged )
282 xSimpleFileAccess->copy( aUserTemplateURL, aBackupURL );
283
284 uno::Reference< document::XTypeDetection > xTypeDetector( xTypeDetection, uno::UNO_QUERY );
285 ::comphelper::SequenceAsHashMap aProps2( xTypeDetection->getByName( xTypeDetector->queryTypeByURL( rTemplateName ) ) );
286 ::rtl::OUString aFilterName =
287 aProps2.getUnpackedValueOrDefault( ::rtl::OUString("PreferredFilter"), ::rtl::OUString() );
288
289 uno::Sequence< beans::PropertyValue > aArgs( 3 );
290 aArgs[0].Name = ::rtl::OUString("FilterName");
291 aArgs[0].Value <<= aFilterName;
292 aArgs[1].Name = ::rtl::OUString("AsTemplate");
293 aArgs[1].Value <<= sal_True;
294 aArgs[2].Name = ::rtl::OUString("URL");
295 aArgs[2].Value <<= ::rtl::OUString( rTemplateName );
296
297 uno::Reference< frame::XLoadable > xLoadable( xFactory->createInstance( ::rtl::OUString( rServiceName ) ), uno::UNO_QUERY );
298 xLoadable->load( aArgs );
299
300 aArgs.realloc( 2 );
301 aArgs[1].Name = ::rtl::OUString("Overwrite");
302 aArgs[1].Value <<= sal_True;
303
304 uno::Reference< frame::XStorable > xStorable( xLoadable, uno::UNO_QUERY );
305 xStorable->storeToURL( aUserTemplateURL, aArgs );
306 ::comphelper::ConfigurationHelper::writeRelativeKey( xConfig, CONF_PATH, PROP_DEF_TEMPL_CHANGED, uno::makeAny( sal_True ));
307 ::comphelper::ConfigurationHelper::flush( xConfig );
308 }
309 else
310 {
311 DBG_ASSERT( bChanged, "invalid ooSetupFactorySystemDefaultTemplateChanged value!" );
312
313 xSimpleFileAccess->copy( aBackupURL, aUserTemplateURL );
314 xSimpleFileAccess->kill( aBackupURL );
315 ::comphelper::ConfigurationHelper::writeRelativeKey( xConfig, CONF_PATH, PROP_DEF_TEMPL_CHANGED, uno::makeAny( sal_False ));
316 ::comphelper::ConfigurationHelper::flush( xConfig );
317 }
318 }
319 catch(const uno::Exception&)
320 {
321 }
322 }
323 }
324
325 void SfxObjectFactory::SetStandardTemplate( const String& rServiceName, const String& rTemplate )
326 {
327 SvtModuleOptions::EFactory eFac = SvtModuleOptions::ClassifyFactoryByServiceName(rServiceName);
328 if (eFac == SvtModuleOptions::E_UNKNOWN_FACTORY)
329 eFac = SvtModuleOptions::ClassifyFactoryByShortName(rServiceName);
330 if (eFac != SvtModuleOptions::E_UNKNOWN_FACTORY)
331 {
332 SetSystemTemplate( rServiceName, rTemplate );
333 SvtModuleOptions().SetFactoryStandardTemplate(eFac, rTemplate);
334 }
335 }
336
337 String SfxObjectFactory::GetStandardTemplate( const String& rServiceName )
338 {
339 SvtModuleOptions::EFactory eFac = SvtModuleOptions::ClassifyFactoryByServiceName(rServiceName);
340 if (eFac == SvtModuleOptions::E_UNKNOWN_FACTORY)
341 eFac = SvtModuleOptions::ClassifyFactoryByShortName(rServiceName);
342
343 String sTemplate;
344 if (eFac != SvtModuleOptions::E_UNKNOWN_FACTORY)
345 sTemplate = SvtModuleOptions().GetFactoryStandardTemplate(eFac);
346
347 return sTemplate;
348 }
349
350 const SfxFilter* SfxObjectFactory::GetTemplateFilter() const
351 {
352 sal_uInt16 nVersion=0;
353 SfxFilterMatcher aMatcher ( String::CreateFromAscii( pShortName ) );
354 SfxFilterMatcherIter aIter( aMatcher );
355 const SfxFilter *pFilter = 0;
356 const SfxFilter *pTemp = aIter.First();
357 while ( pTemp )
358 {
359 if( pTemp->IsOwnFormat() && pTemp->IsOwnTemplateFormat() && ( pTemp->GetVersion() > nVersion ) )
360 {
361 pFilter = pTemp;
362 nVersion = (sal_uInt16) pTemp->GetVersion();
363 }
364
365 pTemp = aIter.Next();
366 }
367
368 return pFilter;
369 }
370
371 void SfxObjectFactory::SetDocumentServiceName( const ::rtl::OUString& rServiceName )
372 {
373 pImpl->aServiceName = rServiceName;
374 }
375
376 const ::rtl::OUString& SfxObjectFactory::GetDocumentServiceName() const
377 {
378 return pImpl->aServiceName;
379 }
380
381 const SvGlobalName& SfxObjectFactory::GetClassId() const
382 {
383 return pImpl->aClassName;
384 }
385
386 String SfxObjectFactory::GetFactoryURL() const
387 {
388 ::rtl::OUStringBuffer aURLComposer;
389 aURLComposer.appendAscii(RTL_CONSTASCII_STRINGPARAM("private:factory/"));
390 aURLComposer.appendAscii(GetShortName());
391 return aURLComposer.makeStringAndClear();
392 }
393
394 String SfxObjectFactory::GetModuleName() const
395 {
396 static ::rtl::OUString SERVICENAME_MODULEMANAGER("com.sun.star.frame.ModuleManager");
397 static ::rtl::OUString PROP_MODULEUINAME ("ooSetupFactoryUIName");
398
399 try
400 {
401 css::uno::Reference< css::lang::XMultiServiceFactory > xSMGR = ::comphelper::getProcessServiceFactory();
402
403 css::uno::Reference< css::container::XNameAccess > xModuleManager(
404 xSMGR->createInstance(SERVICENAME_MODULEMANAGER),
405 css::uno::UNO_QUERY_THROW);
406
407 ::rtl::OUString sDocService(GetDocumentServiceName());
408 ::comphelper::SequenceAsHashMap aPropSet( xModuleManager->getByName(sDocService) );
409 ::rtl::OUString sModuleName = aPropSet.getUnpackedValueOrDefault(PROP_MODULEUINAME, ::rtl::OUString());
410 return String(sModuleName);
411 }
412 catch(const css::uno::RuntimeException&)
413 {
414 throw;
415 }
416 catch(const css::uno::Exception&)
417 {
418 }
419
420 return String();
421 }
422
423
424 sal_uInt16 SfxObjectFactory::GetViewNo_Impl( const sal_uInt16 i_nViewId, const sal_uInt16 i_nFallback ) const
425 {
426 for ( sal_uInt16 curViewNo = 0; curViewNo < GetViewFactoryCount(); ++curViewNo )
427 {
428 const sal_uInt16 curViewId = GetViewFactory( curViewNo ).GetOrdinal();
429 if ( i_nViewId == curViewId )
430 return curViewNo;
431 }
432 return i_nFallback;
433 }
434
435 SfxViewFactory* SfxObjectFactory::GetViewFactoryByViewName( const String& i_rViewName ) const
436 {
437 for ( sal_uInt16 nViewNo = 0;
438 nViewNo < GetViewFactoryCount();
439 ++nViewNo
440 )
441 {
442 SfxViewFactory& rViewFac( GetViewFactory( nViewNo ) );
443 if ( ( rViewFac.GetAPIViewName() == i_rViewName )
444 || ( rViewFac.GetLegacyViewName() == i_rViewName )
445 )
446 return &rViewFac;
447 }
448 return NULL;
449 }
450
451 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE