extensions/source/propctrlr/submissionhandler.cxx

   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 #include <sal/config.h>
  21
  22 #include "submissionhandler.hxx"
  23 #include "formmetadata.hxx"
  24 #include "formstrings.hxx"
  25 #include "handlerhelper.hxx"
  26
  27 #include <com/sun/star/form/FormButtonType.hpp>
  28 #include <com/sun/star/form/submission/XSubmissionSupplier.hpp>
  29 #include <com/sun/star/inspection/XObjectInspectorUI.hpp>
  30 #include <com/sun/star/lang/NullPointerException.hpp>
  31 #include <tools/debug.hxx>
  32 #include <comphelper/diagnose_ex.hxx>
  33
  34
  35 namespace pcr
  36 {
  37
  38
  39     using namespace ::comphelper;
  40     using namespace ::com::sun::star;
  41     using namespace ::com::sun::star::uno;
  42     using namespace ::com::sun::star::lang;
  43     using namespace ::com::sun::star::beans;
  44     using namespace ::com::sun::star::script;
  45     using namespace ::com::sun::star::form;
  46     using namespace ::com::sun::star::xforms;
  47     using namespace ::com::sun::star::container;
  48     using namespace ::com::sun::star::inspection;
  49
  50
  51     //= SubmissionHelper
  52
  53
  54     SubmissionHelper::SubmissionHelper( ::osl::Mutex& _rMutex, const Reference< XPropertySet >& _rxIntrospectee, const Reference< frame::XModel >& _rxContextDocument )
  55         :EFormsHelper( _rMutex, _rxIntrospectee, _rxContextDocument )
  56     {
  57         OSL_ENSURE( canTriggerSubmissions( _rxIntrospectee, _rxContextDocument ),
  58             "SubmissionHelper::SubmissionHelper: you should not have instantiated me!" );
  59     }
  60
  61
  62     bool SubmissionHelper::canTriggerSubmissions( const Reference< XPropertySet >& _rxControlModel,
  63         const Reference< frame::XModel >& _rxContextDocument )
  64     {
  65         if ( !EFormsHelper::isEForm( _rxContextDocument ) )
  66             return false;
  67
  68         try
  69         {
  70             Reference< submission::XSubmissionSupplier > xSubmissionSupp( _rxControlModel, UNO_QUERY );
  71             if ( xSubmissionSupp.is() )
  72                 return true;
  73         }
  74         catch( const Exception& )
  75         {
  76             TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionHelper::canTriggerSubmissions" );
  77         }
  78         return false;
  79     }
  80
  81
  82     //= SubmissionPropertyHandler
  83
  84
  85     SubmissionPropertyHandler::SubmissionPropertyHandler( const Reference< XComponentContext >& _rxContext )
  86         :PropertyHandlerComponent( _rxContext )
  87         ,OPropertyChangeListener( m_aMutex )
  88     {
  89     }
  90
  91
  92     SubmissionPropertyHandler::~SubmissionPropertyHandler( )
  93     {
  94         disposeAdapter();
  95     }
  96
  97
  98     OUString SubmissionPropertyHandler::getImplementationName(  )
  99     {
 100         return "com.sun.star.comp.extensions.SubmissionPropertyHandler";
 101     }
 102
 103
 104     Sequence< OUString > SubmissionPropertyHandler::getSupportedServiceNames(  )
 105     {
 106         return { "com.sun.star.form.inspection.SubmissionPropertyHandler" };
 107     }
 108
 109
 110     Any SAL_CALL SubmissionPropertyHandler::getPropertyValue( const OUString& _rPropertyName )
 111     {
 112         ::osl::MutexGuard aGuard( m_aMutex );
 113         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 114
 115         OSL_ENSURE(m_pHelper, "SubmissionPropertyHandler::getPropertyValue: inconsistency!");
 116         // if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
 117
 118         Any aReturn;
 119         try
 120         {
 121             switch ( nPropId )
 122             {
 123             case PROPERTY_ID_SUBMISSION_ID:
 124             {
 125                 Reference< submission::XSubmissionSupplier > xSubmissionSupp( m_xComponent, UNO_QUERY );
 126                 OSL_ENSURE( xSubmissionSupp.is(), "SubmissionPropertyHandler::getPropertyValue: this should never happen ..." );
 127                     // this handler is not intended for components which are no XSubmissionSupplier
 128                 Reference< submission::XSubmission > xSubmission;
 129                 if ( xSubmissionSupp.is() )
 130                     xSubmission = xSubmissionSupp->getSubmission( );
 131                 aReturn <<= xSubmission;
 132             }
 133             break;
 134
 135             case PROPERTY_ID_XFORMS_BUTTONTYPE:
 136             {
 137                 FormButtonType eType = FormButtonType_PUSH;
 138                 OSL_VERIFY( m_xComponent->getPropertyValue( PROPERTY_BUTTONTYPE ) >>= eType );
 139                 if ( ( eType != FormButtonType_PUSH ) && ( eType != FormButtonType_SUBMIT ) )
 140                     eType = FormButtonType_PUSH;
 141                 aReturn <<= eType;
 142             }
 143             break;
 144
 145             default:
 146                 OSL_FAIL( "SubmissionPropertyHandler::getPropertyValue: cannot handle this property!" );
 147                 break;
 148             }
 149         }
 150         catch( const Exception& )
 151         {
 152             TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionPropertyHandler::getPropertyValue" );
 153         }
 154
 155         return aReturn;
 156     }
 157
 158
 159     void SAL_CALL SubmissionPropertyHandler::setPropertyValue( const OUString& _rPropertyName, const Any& _rValue )
 160     {
 161         ::osl::MutexGuard aGuard( m_aMutex );
 162         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 163
 164         OSL_ENSURE(m_pHelper, "SubmissionPropertyHandler::setPropertyValue: inconsistency!");
 165         // if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
 166
 167         try
 168         {
 169             switch ( nPropId )
 170             {
 171             case PROPERTY_ID_SUBMISSION_ID:
 172             {
 173                 Reference< submission::XSubmission > xSubmission;
 174                 OSL_VERIFY( _rValue >>= xSubmission );
 175
 176                 Reference< submission::XSubmissionSupplier > xSubmissionSupp( m_xComponent, UNO_QUERY );
 177                 OSL_ENSURE( xSubmissionSupp.is(), "SubmissionPropertyHandler::setPropertyValue: this should never happen ..." );
 178                     // this handler is not intended for components which are no XSubmissionSupplier
 179                 if ( xSubmissionSupp.is() )
 180                 {
 181                     xSubmissionSupp->setSubmission( xSubmission );
 182                     impl_setContextDocumentModified_nothrow();
 183                 }
 184             }
 185             break;
 186
 187             case PROPERTY_ID_XFORMS_BUTTONTYPE:
 188                 m_xComponent->setPropertyValue( PROPERTY_BUTTONTYPE, _rValue );
 189                 break;
 190
 191             default:
 192                 OSL_FAIL( "SubmissionPropertyHandler::setPropertyValue: cannot handle this id!" );
 193             }
 194         }
 195         catch( const Exception& )
 196         {
 197             TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "SubmissionPropertyHandler::setPropertyValue" );
 198         }
 199     }
 200
 201
 202     Sequence< OUString > SAL_CALL SubmissionPropertyHandler::getActuatingProperties( )
 203     {
 204         ::osl::MutexGuard aGuard( m_aMutex );
 205         if (!m_pHelper)
 206             return Sequence< OUString >();
 207
 208         Sequence<OUString> aReturn { PROPERTY_XFORMS_BUTTONTYPE };
 209         return aReturn;
 210     }
 211
 212
 213     Sequence< OUString > SAL_CALL SubmissionPropertyHandler::getSupersededProperties( )
 214     {
 215         ::osl::MutexGuard aGuard( m_aMutex );
 216         if (!m_pHelper)
 217             return Sequence< OUString >();
 218
 219         Sequence< OUString > aReturn{ PROPERTY_TARGET_URL,
 220                                       PROPERTY_TARGET_FRAME,
 221                                       PROPERTY_BUTTONTYPE };
 222         return aReturn;
 223     }
 224
 225
 226     void SubmissionPropertyHandler::onNewComponent()
 227     {
 228         if ( m_xPropChangeMultiplexer.is() )
 229         {
 230             m_xPropChangeMultiplexer->dispose();
 231             m_xPropChangeMultiplexer.clear();
 232         }
 233
 234         PropertyHandlerComponent::onNewComponent();
 235
 236         Reference< frame::XModel > xDocument( impl_getContextDocument_nothrow() );
 237         DBG_ASSERT( xDocument.is(), "SubmissionPropertyHandler::onNewComponent: no document!" );
 238
 239         m_pHelper.reset();
 240
 241         if ( SubmissionHelper::canTriggerSubmissions( m_xComponent, xDocument ) )
 242         {
 243             m_pHelper.reset( new SubmissionHelper( m_aMutex, m_xComponent, xDocument ) );
 244
 245             m_xPropChangeMultiplexer = new OPropertyChangeMultiplexer( this, m_xComponent );
 246             m_xPropChangeMultiplexer->addProperty( PROPERTY_BUTTONTYPE );
 247         }
 248     }
 249
 250
 251     Sequence< Property > SubmissionPropertyHandler::doDescribeSupportedProperties() const
 252     {
 253         std::vector< Property > aProperties;
 254         if (m_pHelper)
 255         {
 256             implAddPropertyDescription( aProperties, PROPERTY_SUBMISSION_ID, cppu::UnoType<submission::XSubmission>::get() );
 257             implAddPropertyDescription( aProperties, PROPERTY_XFORMS_BUTTONTYPE, ::cppu::UnoType<FormButtonType>::get() );
 258         }
 259         if ( aProperties.empty() )
 260             return Sequence< Property >();
 261         return comphelper::containerToSequence(aProperties);
 262     }
 263
 264
 265     LineDescriptor SAL_CALL SubmissionPropertyHandler::describePropertyLine( const OUString& _rPropertyName,
 266         const Reference< XPropertyControlFactory >& _rxControlFactory )
 267     {
 268         ::osl::MutexGuard aGuard( m_aMutex );
 269         if ( !_rxControlFactory.is() )
 270             throw NullPointerException();
 271         if (!m_pHelper)
 272             throw RuntimeException();
 273
 274         std::vector< OUString > aListEntries;
 275         PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
 276         switch ( nPropId )
 277         {
 278         case PROPERTY_ID_SUBMISSION_ID:
 279             m_pHelper->getAllElementUINames(EFormsHelper::Submission, aListEntries, false);
 280             break;
 281
 282         case PROPERTY_ID_XFORMS_BUTTONTYPE:
 283         {
 284             // available options are nearly the same as for the "normal" button type, but only the
 285             // first two options
 286             aListEntries = m_pInfoService->getPropertyEnumRepresentations( PROPERTY_ID_BUTTONTYPE );
 287             aListEntries.resize( 2 );
 288         }
 289         break;
 290
 291         default:
 292             OSL_FAIL( "SubmissionPropertyHandler::describePropertyLine: cannot handle this id!" );
 293             return LineDescriptor();
 294         }
 295
 296         LineDescriptor aDescriptor;
 297         aDescriptor.Control = PropertyHandlerHelper::createListBoxControl( _rxControlFactory, std::move(aListEntries), false, true );
 298         aDescriptor.DisplayName = m_pInfoService->getPropertyTranslation( nPropId );
 299         aDescriptor.Category = "General";
 300         aDescriptor.HelpURL = HelpIdUrl::getHelpURL( m_pInfoService->getPropertyHelpId( nPropId ) );
 301         return aDescriptor;
 302     }
 303
 304
 305     void SAL_CALL SubmissionPropertyHandler::actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const Any& _rNewValue, const Any& /*_rOldValue*/, const Reference< XObjectInspectorUI >& _rxInspectorUI, sal_Bool )
 306     {
 307         if ( !_rxInspectorUI.is() )
 308             throw NullPointerException();
 309
 310         ::osl::MutexGuard aGuard( m_aMutex );
 311         PropertyId nActuatingPropId( impl_getPropertyId_throwRuntime( _rActuatingPropertyName ) );
 312         OSL_PRECOND(m_pHelper,
 313                     "SubmissionPropertyHandler::actuatingPropertyChanged: inconsistency!");
 314         // if we survived impl_getPropertyId_throwRuntime, we should have a helper, since no helper implies no properties
 315
 316         switch ( nActuatingPropId )
 317         {
 318         case PROPERTY_ID_XFORMS_BUTTONTYPE:
 319         {
 320             FormButtonType eType = FormButtonType_PUSH;
 321             OSL_VERIFY( _rNewValue >>= eType );
 322             _rxInspectorUI->enablePropertyUI( PROPERTY_SUBMISSION_ID, eType == FormButtonType_SUBMIT );
 323         }
 324         break;
 325
 326         default:
 327             OSL_FAIL( "SubmissionPropertyHandler::actuatingPropertyChanged: cannot handle this id!" );
 328         }
 329     }
 330
 331
 332     Any SAL_CALL SubmissionPropertyHandler::convertToPropertyValue( const OUString& _rPropertyName, const Any& _rControlValue )
 333     {
 334         ::osl::MutexGuard aGuard( m_aMutex );
 335         Any aPropertyValue;
 336
 337         OSL_ENSURE(
 338             m_pHelper,
 339             "SubmissionPropertyHandler::convertToPropertyValue: we have no SupportedProperties!");
 340         if (!m_pHelper)
 341             return aPropertyValue;
 342
 343         OUString sControlValue;
 344         OSL_VERIFY( _rControlValue >>= sControlValue );
 345
 346         PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
 347         switch ( nPropId )
 348         {
 349         case PROPERTY_ID_SUBMISSION_ID:
 350         {
 351             Reference< XSubmission > xSubmission( m_pHelper->getModelElementFromUIName( EFormsHelper::Submission, sControlValue ), UNO_QUERY );
 352             aPropertyValue <<= xSubmission;
 353         }
 354         break;
 355
 356         case PROPERTY_ID_XFORMS_BUTTONTYPE:
 357         {
 358             ::rtl::Reference< IPropertyEnumRepresentation > aEnumConversion(
 359                 new DefaultEnumRepresentation( *m_pInfoService, ::cppu::UnoType<FormButtonType>::get(), PROPERTY_ID_BUTTONTYPE ) );
 360             // TODO/UNOize: make aEnumConversion a member?
 361             aEnumConversion->getValueFromDescription( sControlValue, aPropertyValue );
 362         }
 363         break;
 364
 365         default:
 366             OSL_FAIL( "SubmissionPropertyHandler::convertToPropertyValue: cannot handle this id!" );
 367         }
 368
 369         return aPropertyValue;
 370     }
 371
 372
 373     Any SAL_CALL SubmissionPropertyHandler::convertToControlValue( const OUString& _rPropertyName, const Any& _rPropertyValue, const Type& _rControlValueType )
 374     {
 375         ::osl::MutexGuard aGuard( m_aMutex );
 376         Any aControlValue;
 377
 378         OSL_ENSURE(
 379             m_pHelper,
 380             "SubmissionPropertyHandler::convertToControlValue: we have no SupportedProperties!");
 381         if (!m_pHelper)
 382             return aControlValue;
 383
 384         OSL_ENSURE( _rControlValueType.getTypeClass() == TypeClass_STRING,
 385             "SubmissionPropertyHandler::convertToControlValue: all our controls should use strings for value exchange!" );
 386
 387         PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
 388         switch ( nPropId )
 389         {
 390         case PROPERTY_ID_SUBMISSION_ID:
 391         {
 392             Reference< XPropertySet > xSubmission( _rPropertyValue, UNO_QUERY );
 393             if ( xSubmission.is() )
 394                 aControlValue <<= EFormsHelper::getModelElementUIName( EFormsHelper::Submission, xSubmission );
 395         }
 396         break;
 397
 398         case PROPERTY_ID_XFORMS_BUTTONTYPE:
 399         {
 400             ::rtl::Reference< IPropertyEnumRepresentation > aEnumConversion(
 401                 new DefaultEnumRepresentation( *m_pInfoService, _rPropertyValue.getValueType(), PROPERTY_ID_BUTTONTYPE ) );
 402             // TODO/UNOize: make aEnumConversion a member?
 403             aControlValue <<= aEnumConversion->getDescriptionForValue( _rPropertyValue );
 404         }
 405         break;
 406
 407         default:
 408             OSL_FAIL( "SubmissionPropertyHandler::convertToControlValue: cannot handle this id!" );
 409         }
 410
 411         return aControlValue;
 412     }
 413
 414
 415     void SubmissionPropertyHandler::_propertyChanged( const PropertyChangeEvent& _rEvent )
 416     {
 417         if ( _rEvent.PropertyName == PROPERTY_BUTTONTYPE )
 418             firePropertyChange( PROPERTY_XFORMS_BUTTONTYPE, PROPERTY_ID_XFORMS_BUTTONTYPE, _rEvent.OldValue, _rEvent.NewValue );
 419     }
 420
 421
 422 } // namespace pcr
 423
 424 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 425 extensions_propctrlr_SubmissionPropertyHandler_get_implementation(
 426     css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
 427 {
 428     return cppu::acquire(new pcr::SubmissionPropertyHandler(context));
 429 }
 430
 431 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */