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