?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
tdf#130857 qt weld: Support "Java Start Parameters" dialog
[LibreOffice.git] / xmlhelp / source / cxxhelp / provider / content.cxx
blob5b1c1794186e62c9a579722e0321659299c8444f
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 /**************************************************************************
21 TODO
22 **************************************************************************
23
24 *************************************************************************/
25 #include <com/sun/star/beans/PropertyValue.hpp>
26 #include <com/sun/star/sdbc/XRow.hpp>
27 #include <com/sun/star/ucb/OpenCommandArgument2.hpp>
28 #include <com/sun/star/ucb/UnsupportedCommandException.hpp>
29 #include <com/sun/star/ucb/XCommandInfo.hpp>
30 #include <com/sun/star/io/XActiveDataSink.hpp>
31 #include <com/sun/star/io/XOutputStream.hpp>
32 #include <com/sun/star/lang/IllegalAccessException.hpp>
33 #include <com/sun/star/ucb/UnsupportedDataSinkException.hpp>
34 #include <com/sun/star/io/XActiveDataStreamer.hpp>
35 #include <ucbhelper/propertyvalueset.hxx>
36 #include <ucbhelper/cancelcommandexecution.hxx>
37 #include <ucbhelper/macros.hxx>
38 #include <utility>
39 #include "content.hxx"
40 #include "provider.hxx"
41 #include "resultset.hxx"
42 #include "databases.hxx"
43 #include "resultsetfactory.hxx"
44 #include "resultsetbase.hxx"
45 #include "resultsetforroot.hxx"
46 #include "resultsetforquery.hxx"
47
48 using namespace com::sun::star;
49 using namespace chelp;
50
51 // Content Implementation.
52
53 Content::Content( const uno::Reference< uno::XComponentContext >& rxContext,
54 ::ucbhelper::ContentProviderImplHelper* pProvider,
55 const uno::Reference< ucb::XContentIdentifier >&
56 Identifier,
57 Databases* pDatabases )
58 : ContentImplHelper( rxContext, pProvider, Identifier ),
59 m_aURLParameter( Identifier->getContentIdentifier(),pDatabases ),
60 m_pDatabases( pDatabases ) // not owner
61 {
62 }
63
64 // virtual
65 Content::~Content()
66 {
67 }
68
69 // virtual
70 uno::Any SAL_CALL Content::queryInterface( const uno::Type & rType )
71 {
72 uno::Any aRet;
73 return aRet.hasValue() ? aRet : ContentImplHelper::queryInterface( rType );
74 }
75
76 // XTypeProvider methods.
77
78 XTYPEPROVIDER_COMMON_IMPL( Content );
79
80 // virtual
81 uno::Sequence< uno::Type > SAL_CALL Content::getTypes()
82 {
83 static cppu::OTypeCollection ourTypeCollection(
84 CPPU_TYPE_REF( lang::XTypeProvider ),
85 CPPU_TYPE_REF( lang::XServiceInfo ),
86 CPPU_TYPE_REF( lang::XComponent ),
87 CPPU_TYPE_REF( ucb::XContent ),
88 CPPU_TYPE_REF( ucb::XCommandProcessor ),
89 CPPU_TYPE_REF( beans::XPropertiesChangeNotifier ),
90 CPPU_TYPE_REF( ucb::XCommandInfoChangeNotifier ),
91 CPPU_TYPE_REF( beans::XPropertyContainer ),
92 CPPU_TYPE_REF( beans::XPropertySetInfoChangeNotifier ),
93 CPPU_TYPE_REF( container::XChild ) );
94
95 return ourTypeCollection.getTypes();
96 }
97
98 // XServiceInfo methods.
99
100 // virtual
101 OUString SAL_CALL Content::getImplementationName()
102 {
103 return u"CHelpContent"_ustr;
104 }
105
106 // virtual
107 uno::Sequence< OUString > SAL_CALL Content::getSupportedServiceNames()
108 {
109 return { u"com.sun.star.ucb.CHelpContent"_ustr };
110 }
111
112 // XContent methods.
113
114 // virtual
115 OUString SAL_CALL Content::getContentType()
116 {
117 return MYUCP_CONTENT_TYPE;
118 }
119
120 // XCommandProcessor methods.
121
122 //virtual
123 void SAL_CALL Content::abort( sal_Int32 /*CommandId*/ )
124 {
125 }
126
127 namespace {
128
129 class ResultSetForRootFactory
130 : public ResultSetFactory
131 {
132 private:
133
134 uno::Reference< uno::XComponentContext > m_xContext;
135 uno::Reference< ucb::XContentProvider > m_xProvider;
136 uno::Sequence< beans::Property > m_seq;
137 URLParameter m_aURLParameter;
138 Databases* m_pDatabases;
139
140 public:
141
142 ResultSetForRootFactory(
143 uno::Reference< uno::XComponentContext > xContext,
144 uno::Reference< ucb::XContentProvider > xProvider,
145 const uno::Sequence< beans::Property >& seq,
146 const URLParameter& rURLParameter,
147 Databases* pDatabases )
148 : m_xContext(std::move( xContext )),
149 m_xProvider(std::move( xProvider )),
150 m_seq( seq ),
151 m_aURLParameter(rURLParameter),
152 m_pDatabases( pDatabases )
153 {
154 }
155
156 rtl::Reference<ResultSetBase> createResultSet() override
157 {
158 return new ResultSetForRoot( m_xContext,
159 m_xProvider,
160 m_seq,
161 m_aURLParameter,
162 m_pDatabases );
163 }
164 };
165
166 class ResultSetForQueryFactory
167 : public ResultSetFactory
168 {
169 private:
170
171 uno::Reference< uno::XComponentContext > m_xContext;
172 uno::Reference< ucb::XContentProvider > m_xProvider;
173 uno::Sequence< beans::Property > m_seq;
174 URLParameter m_aURLParameter;
175 Databases* m_pDatabases;
176
177 public:
178
179 ResultSetForQueryFactory(
180 uno::Reference< uno::XComponentContext > xContext,
181 uno::Reference< ucb::XContentProvider > xProvider,
182 const uno::Sequence< beans::Property >& seq,
183 const URLParameter& rURLParameter,
184 Databases* pDatabases )
185 : m_xContext(std::move( xContext )),
186 m_xProvider(std::move( xProvider )),
187 m_seq( seq ),
188 m_aURLParameter(rURLParameter),
189 m_pDatabases( pDatabases )
190 {
191 }
192
193 rtl::Reference<ResultSetBase> createResultSet() override
194 {
195 return new ResultSetForQuery( m_xContext,
196 m_xProvider,
197 m_seq,
198 m_aURLParameter,
199 m_pDatabases );
200 }
201 };
202
203 }
204
205 // virtual
206 uno::Any SAL_CALL Content::execute(
207 const ucb::Command& aCommand,
208 sal_Int32,
209 const uno::Reference< ucb::XCommandEnvironment >& Environment )
210 {
211 uno::Any aRet;
212
213 if ( aCommand.Name == "getPropertyValues" )
214 {
215 uno::Sequence< beans::Property > Properties;
216 if ( !( aCommand.Argument >>= Properties ) )
217 {
218 aRet <<= lang::IllegalArgumentException();
219 ucbhelper::cancelCommandExecution(aRet,Environment);
220 }
221
222 aRet <<= getPropertyValues( Properties );
223 }
224 else if ( aCommand.Name == "setPropertyValues" )
225 {
226 uno::Sequence<beans::PropertyValue> propertyValues;
227
228 if( ! ( aCommand.Argument >>= propertyValues ) ) {
229 aRet <<= lang::IllegalArgumentException();
230 ucbhelper::cancelCommandExecution(aRet,Environment);
231 }
232
233 uno::Sequence< uno::Any > ret(propertyValues.getLength());
234 const uno::Sequence< beans::Property > props(getProperties(Environment));
235 // No properties can be set
236 std::transform(std::cbegin(propertyValues), std::cend(propertyValues), ret.getArray(),
237 [&props](const beans::PropertyValue& rPropVal) {
238 if (std::any_of(props.begin(), props.end(),
239 [&rPropVal](const beans::Property& rProp) { return rProp.Name == rPropVal.Name; }))
240 return css::uno::toAny(lang::IllegalAccessException());
241 return css::uno::toAny(beans::UnknownPropertyException());
242 });
243
244 aRet <<= ret;
245 }
246 else if ( aCommand.Name == "getPropertySetInfo" )
247 {
248 // Note: Implemented by base class.
249 aRet <<= getPropertySetInfo( Environment );
250 }
251 else if ( aCommand.Name == "getCommandInfo" )
252 {
253 // Note: Implemented by base class.
254 aRet <<= getCommandInfo( Environment );
255 }
256 else if ( aCommand.Name == "open" )
257 {
258 ucb::OpenCommandArgument2 aOpenCommand;
259 if ( !( aCommand.Argument >>= aOpenCommand ) )
260 {
261 aRet <<= lang::IllegalArgumentException();
262 ucbhelper::cancelCommandExecution(aRet,Environment);
263 }
264
265 uno::Reference< io::XActiveDataSink > xActiveDataSink(
266 aOpenCommand.Sink, uno::UNO_QUERY);
267
268 if(xActiveDataSink.is())
269 m_aURLParameter.open(xActiveDataSink);
270
271 uno::Reference< io::XActiveDataStreamer > xActiveDataStreamer(
272 aOpenCommand.Sink, uno::UNO_QUERY);
273
274 if(xActiveDataStreamer.is()) {
275 aRet <<= ucb::UnsupportedDataSinkException();
276 ucbhelper::cancelCommandExecution(aRet,Environment);
277 }
278
279 uno::Reference< io::XOutputStream > xOutputStream(
280 aOpenCommand.Sink, uno::UNO_QUERY);
281
282 if(xOutputStream.is() )
283 m_aURLParameter.open(xOutputStream);
284
285 if( m_aURLParameter.isRoot() )
286 {
287 uno::Reference< ucb::XDynamicResultSet > xSet
288 = new DynamicResultSet(
289 m_xContext,
290 aOpenCommand,
291 std::make_unique<ResultSetForRootFactory>(
292 m_xContext,
293 m_xProvider.get(),
294 aOpenCommand.Properties,
295 m_aURLParameter,
296 m_pDatabases));
297 aRet <<= xSet;
298 }
299 else if( m_aURLParameter.isQuery() )
300 {
301 uno::Reference< ucb::XDynamicResultSet > xSet
302 = new DynamicResultSet(
303 m_xContext,
304 aOpenCommand,
305 std::make_unique<ResultSetForQueryFactory>(
306 m_xContext,
307 m_xProvider.get(),
308 aOpenCommand.Properties,
309 m_aURLParameter,
310 m_pDatabases ) );
311 aRet <<= xSet;
312 }
313 }
314 else
315 {
316 // Unsupported command
317 aRet <<= ucb::UnsupportedCommandException();
318 ucbhelper::cancelCommandExecution(aRet,Environment);
319 }
320
321 return aRet;
322 }
323
324 uno::Reference< sdbc::XRow > Content::getPropertyValues(
325 const uno::Sequence< beans::Property >& rProperties )
326 {
327 osl::MutexGuard aGuard( m_aMutex );
328
329 rtl::Reference< ::ucbhelper::PropertyValueSet > xRow =
330 new ::ucbhelper::PropertyValueSet( m_xContext );
331
332 for ( const beans::Property& rProp : rProperties )
333 {
334 if ( rProp.Name == "ContentType" )
335 xRow->appendString(
336 rProp,
337 u"application/vnd.sun.star.help"_ustr );
338 else if ( rProp.Name == "Title" )
339 xRow->appendString ( rProp,m_aURLParameter.get_title() );
340 else if ( rProp.Name == "IsReadOnly" )
341 xRow->appendBoolean( rProp,true );
342 else if ( rProp.Name == "IsDocument" )
343 xRow->appendBoolean(
344 rProp,
345 m_aURLParameter.isFile() || m_aURLParameter.isRoot() );
346 else if ( rProp.Name == "IsFolder" )
347 xRow->appendBoolean(
348 rProp,
349 ! m_aURLParameter.isFile() || m_aURLParameter.isRoot() );
350 else if ( rProp.Name == "IsErrorDocument" )
351 xRow->appendBoolean( rProp, m_aURLParameter.isErrorDocument() );
352 else if ( rProp.Name == "MediaType" )
353 if( m_aURLParameter.isActive() )
354 xRow->appendString(
355 rProp,
356 u"text/plain"_ustr );
357 else if( m_aURLParameter.isFile() )
358 xRow->appendString(
359 rProp,u"text/html"_ustr );
360 else if( m_aURLParameter.isRoot() )
361 xRow->appendString(
362 rProp,
363 u"text/css"_ustr );
364 else
365 xRow->appendVoid( rProp );
366 else if( m_aURLParameter.isModule() )
367 if ( rProp.Name == "KeywordList" )
368 {
369 KeywordInfo *inf =
370 m_pDatabases->getKeyword( m_aURLParameter.get_module(),
371 m_aURLParameter.get_language() );
372
373 uno::Any aAny;
374 if( inf )
375 aAny <<= inf->getKeywordList();
376 xRow->appendObject( rProp,aAny );
377 }
378 else if ( rProp.Name == "KeywordRef" )
379 {
380 KeywordInfo *inf =
381 m_pDatabases->getKeyword( m_aURLParameter.get_module(),
382 m_aURLParameter.get_language() );
383
384 uno::Any aAny;
385 if( inf )
386 aAny <<= inf->getIdList();
387 xRow->appendObject( rProp,aAny );
388 }
389 else if ( rProp.Name == "KeywordAnchorForRef" )
390 {
391 KeywordInfo *inf =
392 m_pDatabases->getKeyword( m_aURLParameter.get_module(),
393 m_aURLParameter.get_language() );
394
395 uno::Any aAny;
396 if( inf )
397 aAny <<= inf->getAnchorList();
398 xRow->appendObject( rProp,aAny );
399 }
400 else if ( rProp.Name == "KeywordTitleForRef" )
401 {
402 KeywordInfo *inf =
403 m_pDatabases->getKeyword( m_aURLParameter.get_module(),
404 m_aURLParameter.get_language() );
405
406 uno::Any aAny;
407 if( inf )
408 aAny <<= inf->getTitleList();
409 xRow->appendObject( rProp,aAny );
410 }
411 else if ( rProp.Name == "SearchScopes" )
412 {
413 uno::Sequence< OUString > seq{ u"Heading"_ustr, u"FullText"_ustr };
414 xRow->appendObject( rProp, uno::Any(seq) );
415 }
416 else if ( rProp.Name == "Order" )
417 {
418 StaticModuleInformation *inf =
419 m_pDatabases->getStaticInformationForModule(
420 m_aURLParameter.get_module(),
421 m_aURLParameter.get_language() );
422
423 uno::Any aAny;
424 if( inf )
425 aAny <<= sal_Int32( inf->get_order() );
426 xRow->appendObject( rProp,aAny );
427 }
428 else
429 xRow->appendVoid( rProp );
430 else if( "AnchorName" == rProp.Name &&
431 m_aURLParameter.isFile() )
432 xRow->appendString( rProp,m_aURLParameter.get_tag() );
433 else
434 xRow->appendVoid( rProp );
435 }
436
437 return xRow;
438 }
439
440 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE