reportdesign/source/core/api/ReportEngineJFree.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 #include <com/sun/star/beans/PropertyValue.hpp>
  20 #include "ReportEngineJFree.hxx"
  21 #include <comphelper/enumhelper.hxx>
  22 #include <comphelper/documentconstants.hxx>
  23 #include <comphelper/storagehelper.hxx>
  24 #include <connectivity/dbtools.hxx>
  25 #include <comphelper/sequence.hxx>
  26 #include <comphelper/mimeconfighelper.hxx>
  27 #include <comphelper/property.hxx>
  28 #include <comphelper/string.hxx>
  29 #include <com/sun/star/beans/PropertyAttribute.hpp>
  30 #include <com/sun/star/beans/NamedValue.hpp>
  31 #include <com/sun/star/frame/Desktop.hpp>
  32 #include <com/sun/star/frame/XComponentLoader.hpp>
  33 #include <com/sun/star/frame/FrameSearchFlag.hpp>
  34 #include <com/sun/star/embed/XTransactedObject.hpp>
  35 #include <com/sun/star/sdb/XCompletedExecution.hpp>
  36 #include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.hpp>
  37 #include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
  38 #include <com/sun/star/sdb/CommandType.hpp>
  39
  40 #include <com/sun/star/task/XInteractionHandler.hpp>
  41 #include <com/sun/star/task/XJob.hpp>
  42
  43 #include <tools/debug.hxx>
  44 #include <unotools/useroptions.hxx>
  45 #include <unotools/tempfile.hxx>
  46 #include <unotools/sharedunocomponent.hxx>
  47
  48 #include "Tools.hxx"
  49 #include "corestrings.hrc"
  50 #include "core_resource.hrc"
  51 #include "core_resource.hxx"
  52
  53 #include <connectivity/CommonTools.hxx>
  54 #include <rtl/ustrbuf.hxx>
  55 #include <sfx2/docfilt.hxx>
  56 // =============================================================================
  57 namespace reportdesign
  58 {
  59 // =============================================================================
  60     using namespace com::sun::star;
  61     using namespace comphelper;
  62
  63 DBG_NAME( rpt_OReportEngineJFree )
  64 // -----------------------------------------------------------------------------
  65 OReportEngineJFree::OReportEngineJFree( const uno::Reference< uno::XComponentContext >& context)
  66 :ReportEngineBase(m_aMutex)
  67 ,ReportEnginePropertySet(context,static_cast< Implements >(IMPLEMENTS_PROPERTY_SET),uno::Sequence< OUString >())
  68 ,m_xContext(context)
  69 ,m_nMaxRows(0)
  70 {
  71     DBG_CTOR( rpt_OReportEngineJFree,NULL);
  72 }
  73 // -----------------------------------------------------------------------------
  74 // TODO: VirtualFunctionFinder: This is virtual function!
  75 //
  76 OReportEngineJFree::~OReportEngineJFree()
  77 {
  78     DBG_DTOR( rpt_OReportEngineJFree,NULL);
  79 }
  80 //--------------------------------------------------------------------------
  81 IMPLEMENT_FORWARD_XINTERFACE2(OReportEngineJFree,ReportEngineBase,ReportEnginePropertySet)
  82 // -----------------------------------------------------------------------------
  83 void SAL_CALL OReportEngineJFree::dispose() throw(uno::RuntimeException)
  84 {
  85     ReportEnginePropertySet::dispose();
  86     cppu::WeakComponentImplHelperBase::dispose();
  87     m_xActiveConnection.clear();
  88 }
  89 // -----------------------------------------------------------------------------
  90 OUString OReportEngineJFree::getImplementationName_Static(  ) throw(uno::RuntimeException)
  91 {
  92     return OUString("com.sun.star.comp.report.OReportEngineJFree");
  93 }
  94
  95 //--------------------------------------------------------------------------
  96 OUString SAL_CALL OReportEngineJFree::getImplementationName(  ) throw(uno::RuntimeException)
  97 {
  98     return getImplementationName_Static();
  99 }
 100 //--------------------------------------------------------------------------
 101 uno::Sequence< OUString > OReportEngineJFree::getSupportedServiceNames_Static(  ) throw(uno::RuntimeException)
 102 {
 103     uno::Sequence< OUString > aServices(1);
 104     aServices.getArray()[0] = OUString("com.sun.star.report.ReportEngine");
 105
 106     return aServices;
 107 }
 108 //------------------------------------------------------------------------------
 109 uno::Reference< uno::XInterface > OReportEngineJFree::create(uno::Reference< uno::XComponentContext > const & xContext)
 110 {
 111     return *(new OReportEngineJFree(xContext));
 112 }
 113
 114 //--------------------------------------------------------------------------
 115 uno::Sequence< OUString > SAL_CALL OReportEngineJFree::getSupportedServiceNames(  ) throw(uno::RuntimeException)
 116 {
 117     return getSupportedServiceNames_Static();
 118 }
 119 //------------------------------------------------------------------------------
 120 sal_Bool SAL_CALL OReportEngineJFree::supportsService(const OUString& ServiceName) throw( uno::RuntimeException )
 121 {
 122     return ::comphelper::existsValue(ServiceName,getSupportedServiceNames_Static());
 123 }
 124 // -----------------------------------------------------------------------------
 125 // XReportEngine
 126     // Attributes
 127 uno::Reference< report::XReportDefinition > SAL_CALL OReportEngineJFree::getReportDefinition() throw (uno::RuntimeException)
 128 {
 129     ::osl::MutexGuard aGuard(m_aMutex);
 130     return m_xReport;
 131 }
 132 // -----------------------------------------------------------------------------
 133 void SAL_CALL OReportEngineJFree::setReportDefinition( const uno::Reference< report::XReportDefinition >& _report ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 134 {
 135     if ( !_report.is() )
 136         throw lang::IllegalArgumentException();
 137     BoundListeners l;
 138     {
 139         ::osl::MutexGuard aGuard(m_aMutex);
 140         if ( m_xReport != _report )
 141         {
 142             prepareSet(PROPERTY_REPORTDEFINITION, uno::makeAny(m_xReport), uno::makeAny(_report), &l);
 143             m_xReport = _report;
 144         }
 145     }
 146     l.notify();
 147 }
 148 // -----------------------------------------------------------------------------
 149 uno::Reference< task::XStatusIndicator > SAL_CALL OReportEngineJFree::getStatusIndicator() throw (uno::RuntimeException)
 150 {
 151     ::osl::MutexGuard aGuard(m_aMutex);
 152     return m_StatusIndicator;
 153 }
 154 // -----------------------------------------------------------------------------
 155 void SAL_CALL OReportEngineJFree::setStatusIndicator( const uno::Reference< task::XStatusIndicator >& _statusindicator ) throw (uno::RuntimeException)
 156 {
 157     set(PROPERTY_STATUSINDICATOR,_statusindicator,m_StatusIndicator);
 158 }
 159 // -----------------------------------------------------------------------------
 160 OUString OReportEngineJFree::getNewOutputName()
 161 {
 162     OUString sOutputName;
 163     {
 164         ::osl::MutexGuard aGuard(m_aMutex);
 165         ::connectivity::checkDisposed(ReportEngineBase::rBHelper.bDisposed);
 166         if ( !m_xReport.is() || !m_xActiveConnection.is() )
 167             throw lang::IllegalArgumentException();
 168
 169         static const OUString s_sMediaType("MediaType");
 170         try
 171         {
 172             MimeConfigurationHelper aConfighelper(m_xContext);
 173             const OUString sMimeType = m_xReport->getMimeType();
 174             const SfxFilter* pFilter = SfxFilter::GetDefaultFilter( aConfighelper.GetDocServiceNameFromMediaType(sMimeType) );
 175             String sExt;
 176             if ( pFilter )
 177                 sExt = ::comphelper::string::stripStart(pFilter->GetDefaultExtension(), '*');
 178             else
 179                 sExt = OUString(".rpt");
 180
 181             uno::Reference< embed::XStorage > xTemp = OStorageHelper::GetTemporaryStorage(/*sFileTemp,embed::ElementModes::WRITE | embed::ElementModes::TRUNCATE,*/ m_xContext);
 182             utl::DisposableComponent aTemp(xTemp);
 183             uno::Sequence< beans::PropertyValue > aEmpty;
 184             uno::Reference< beans::XPropertySet> xStorageProp(xTemp,uno::UNO_QUERY);
 185             if ( xStorageProp.is() )
 186             {
 187                 xStorageProp->setPropertyValue( s_sMediaType, uno::makeAny(sMimeType));
 188             }
 189             m_xReport->storeToStorage(xTemp,aEmpty); // store to temp file because it may contain information which isn't in the database yet.
 190
 191             uno::Sequence< beans::NamedValue > aConvertedProperties(8);
 192             sal_Int32 nPos = 0;
 193             aConvertedProperties[nPos].Name = OUString("InputStorage");
 194             aConvertedProperties[nPos++].Value <<= xTemp;
 195             aConvertedProperties[nPos].Name = OUString("OutputStorage");
 196
 197             OUString sFileURL;
 198             String sName = m_xReport->getCaption();
 199             if ( !sName.Len() )
 200                 sName = m_xReport->getName();
 201             {
 202                 ::utl::TempFile aTestFile(sName,sal_False,&sExt);
 203                 if ( !aTestFile.IsValid() )
 204                 {
 205                     sName = RPT_RESSTRING(RID_STR_REPORT,m_xContext->getServiceManager());
 206                     ::utl::TempFile aFile(sName,sal_False,&sExt);
 207                     sFileURL = aFile.GetURL();
 208                 }
 209                 else
 210                     sFileURL = aTestFile.GetURL();
 211             }
 212
 213             uno::Reference< embed::XStorage > xOut = OStorageHelper::GetStorageFromURL(sFileURL,embed::ElementModes::WRITE | embed::ElementModes::TRUNCATE, m_xContext);
 214             utl::DisposableComponent aOut(xOut);
 215             xStorageProp.set(xOut,uno::UNO_QUERY);
 216             if ( xStorageProp.is() )
 217             {
 218                 xStorageProp->setPropertyValue( s_sMediaType, uno::makeAny(sMimeType));
 219             }
 220
 221             aConvertedProperties[nPos++].Value <<= xOut;
 222
 223             aConvertedProperties[nPos].Name = PROPERTY_REPORTDEFINITION;
 224             aConvertedProperties[nPos++].Value <<= m_xReport;
 225
 226             aConvertedProperties[nPos].Name = PROPERTY_ACTIVECONNECTION;
 227             aConvertedProperties[nPos++].Value <<= m_xActiveConnection;
 228
 229             aConvertedProperties[nPos].Name = PROPERTY_MAXROWS;
 230             aConvertedProperties[nPos++].Value <<= m_nMaxRows;
 231
 232             // some meta data
 233             SvtUserOptions aUserOpts;
 234             OUStringBuffer sAuthor(aUserOpts.GetFirstName());
 235             sAuthor.appendAscii(" ");
 236             sAuthor.append(aUserOpts.GetLastName());
 237             static const OUString s_sAuthor("Author");
 238             aConvertedProperties[nPos].Name = s_sAuthor;
 239             aConvertedProperties[nPos++].Value <<= sAuthor.makeStringAndClear();
 240
 241             static const OUString s_sTitle("Title");
 242             aConvertedProperties[nPos].Name = s_sTitle;
 243             aConvertedProperties[nPos++].Value <<= m_xReport->getCaption();
 244
 245             // create job factory and initialize
 246             const OUString sReportEngineServiceName = ::dbtools::getDefaultReportEngineServiceName(m_xContext);
 247             uno::Reference<task::XJob> xJob(m_xContext->getServiceManager()->createInstanceWithContext(sReportEngineServiceName,m_xContext),uno::UNO_QUERY_THROW);
 248             if ( !m_xReport->getCommand().isEmpty() )
 249             {
 250                 xJob->execute(aConvertedProperties);
 251                 if ( xStorageProp.is() )
 252                 {
 253                     sOutputName = sFileURL;
 254                 }
 255             }
 256
 257             uno::Reference<embed::XTransactedObject> xTransact(xOut,uno::UNO_QUERY);
 258             if ( !sOutputName.isEmpty() && xTransact.is() )
 259                 xTransact->commit();
 260
 261             if ( sOutputName.isEmpty() )
 262                 throw lang::IllegalArgumentException();
 263         }
 264         catch(const uno::Exception& e)
 265         {
 266             (void)e; // helper to know what e contains
 267             throw;
 268         }
 269     }
 270     return sOutputName;
 271 }
 272 // -----------------------------------------------------------------------------
 273 // Methods
 274 uno::Reference< frame::XModel > SAL_CALL OReportEngineJFree::createDocumentModel( ) throw (lang::DisposedException, lang::IllegalArgumentException, uno::Exception, uno::RuntimeException)
 275 {
 276     return createDocumentAlive(NULL,true);
 277 }
 278 // -----------------------------------------------------------------------------
 279 uno::Reference< frame::XModel > SAL_CALL OReportEngineJFree::createDocumentAlive( const uno::Reference< frame::XFrame >& _frame ) throw (lang::DisposedException, lang::IllegalArgumentException, uno::Exception, uno::RuntimeException)
 280 {
 281     return createDocumentAlive(_frame,false);
 282 }
 283 // -----------------------------------------------------------------------------
 284 uno::Reference< frame::XModel > SAL_CALL OReportEngineJFree::createDocumentAlive( const uno::Reference< frame::XFrame >& _frame,bool _bHidden ) throw (lang::DisposedException, lang::IllegalArgumentException, uno::Exception, uno::RuntimeException)
 285 {
 286     uno::Reference< frame::XModel > xModel;
 287     OUString sOutputName = getNewOutputName(); // starts implicite the report generator
 288     if ( !sOutputName.isEmpty() )
 289     {
 290         ::osl::MutexGuard aGuard(m_aMutex);
 291         ::connectivity::checkDisposed(ReportEngineBase::rBHelper.bDisposed);
 292         uno::Reference<frame::XComponentLoader> xFrameLoad(_frame,uno::UNO_QUERY);
 293         if ( !xFrameLoad.is() )
 294         {
 295             // if there is no frame given, find the right
 296             xFrameLoad.set( frame::Desktop::create(m_xContext), uno::UNO_QUERY);
 297             OUString sTarget("_blank");
 298             sal_Int32 nFrameSearchFlag = frame::FrameSearchFlag::TASKS | frame::FrameSearchFlag::CREATE;
 299             uno::Reference< frame::XFrame> xFrame = uno::Reference< frame::XFrame>(xFrameLoad,uno::UNO_QUERY)->findFrame(sTarget,nFrameSearchFlag);
 300             xFrameLoad.set( xFrame,uno::UNO_QUERY);
 301         }
 302
 303         if ( xFrameLoad.is() )
 304         {
 305             uno::Sequence < beans::PropertyValue > aArgs( _bHidden ? 3 : 2 );
 306             sal_Int32 nLen = 0;
 307             aArgs[nLen].Name = OUString("AsTemplate");
 308             aArgs[nLen++].Value <<= sal_False;
 309
 310             aArgs[nLen].Name = OUString("ReadOnly");
 311             aArgs[nLen++].Value <<= sal_True;
 312
 313             if ( _bHidden )
 314             {
 315                 aArgs[nLen].Name = OUString("Hidden");
 316                 aArgs[nLen++].Value <<= sal_True;
 317             }
 318
 319             uno::Reference< lang::XMultiServiceFactory > xFac(m_xContext->getServiceManager(),uno::UNO_QUERY);
 320             xModel.set( xFrameLoad->loadComponentFromURL(
 321                 sOutputName,
 322                 OUString(), // empty frame name
 323                 0,
 324                 aArgs
 325                 ),uno::UNO_QUERY);
 326         }
 327     }
 328     return xModel;
 329 }
 330 // -----------------------------------------------------------------------------
 331 util::URL SAL_CALL OReportEngineJFree::createDocument( ) throw (lang::DisposedException, lang::IllegalArgumentException, uno::Exception, uno::RuntimeException)
 332 {
 333     util::URL aRet;
 334     uno::Reference< frame::XModel > xModel = createDocumentModel();
 335     if ( xModel.is() )
 336     {
 337         ::osl::MutexGuard aGuard(m_aMutex);
 338         ::connectivity::checkDisposed(ReportEngineBase::rBHelper.bDisposed);
 339     }
 340     return aRet;
 341 }
 342 // -----------------------------------------------------------------------------
 343 void SAL_CALL OReportEngineJFree::interrupt(  ) throw (lang::DisposedException, uno::Exception, uno::RuntimeException)
 344 {
 345     {
 346         ::osl::MutexGuard aGuard(m_aMutex);
 347         ::connectivity::checkDisposed(ReportEngineBase::rBHelper.bDisposed);
 348     }
 349 }
 350 // -----------------------------------------------------------------------------
 351 uno::Reference< beans::XPropertySetInfo > SAL_CALL OReportEngineJFree::getPropertySetInfo(  ) throw(uno::RuntimeException)
 352 {
 353     return ReportEnginePropertySet::getPropertySetInfo();
 354 }
 355 // -------------------------------------------------------------------------
 356 void SAL_CALL OReportEngineJFree::setPropertyValue( const OUString& aPropertyName, const uno::Any& aValue ) throw (beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException, lang::WrappedTargetException, uno::RuntimeException)
 357 {
 358     ReportEnginePropertySet::setPropertyValue( aPropertyName, aValue );
 359 }
 360 // -----------------------------------------------------------------------------
 361 uno::Any SAL_CALL OReportEngineJFree::getPropertyValue( const OUString& PropertyName ) throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 362 {
 363     return ReportEnginePropertySet::getPropertyValue( PropertyName);
 364 }
 365 // -----------------------------------------------------------------------------
 366 void SAL_CALL OReportEngineJFree::addPropertyChangeListener( const OUString& aPropertyName, const uno::Reference< beans::XPropertyChangeListener >& xListener ) throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 367 {
 368     ReportEnginePropertySet::addPropertyChangeListener( aPropertyName, xListener );
 369 }
 370 // -----------------------------------------------------------------------------
 371 void SAL_CALL OReportEngineJFree::removePropertyChangeListener( const OUString& aPropertyName, const uno::Reference< beans::XPropertyChangeListener >& aListener ) throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 372 {
 373     ReportEnginePropertySet::removePropertyChangeListener( aPropertyName, aListener );
 374 }
 375 // -----------------------------------------------------------------------------
 376 void SAL_CALL OReportEngineJFree::addVetoableChangeListener( const OUString& PropertyName, const uno::Reference< beans::XVetoableChangeListener >& aListener ) throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 377 {
 378     ReportEnginePropertySet::addVetoableChangeListener( PropertyName, aListener );
 379 }
 380 // -----------------------------------------------------------------------------
 381 void SAL_CALL OReportEngineJFree::removeVetoableChangeListener( const OUString& PropertyName, const uno::Reference< beans::XVetoableChangeListener >& aListener ) throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
 382 {
 383     ReportEnginePropertySet::removeVetoableChangeListener( PropertyName, aListener );
 384 }
 385 // -----------------------------------------------------------------------------
 386 uno::Reference< sdbc::XConnection > SAL_CALL OReportEngineJFree::getActiveConnection() throw (uno::RuntimeException)
 387 {
 388     return m_xActiveConnection;
 389 }
 390 // -----------------------------------------------------------------------------
 391 void SAL_CALL OReportEngineJFree::setActiveConnection( const uno::Reference< sdbc::XConnection >& _activeconnection ) throw (lang::IllegalArgumentException, uno::RuntimeException)
 392 {
 393     if ( !_activeconnection.is() )
 394         throw lang::IllegalArgumentException();
 395     set(PROPERTY_ACTIVECONNECTION,_activeconnection,m_xActiveConnection);
 396 }
 397 // -----------------------------------------------------------------------------
 398 ::sal_Int32 SAL_CALL OReportEngineJFree::getMaxRows() throw (uno::RuntimeException)
 399 {
 400     ::osl::MutexGuard aGuard(m_aMutex);
 401     return m_nMaxRows;
 402 }
 403 // -----------------------------------------------------------------------------
 404 void SAL_CALL OReportEngineJFree::setMaxRows( ::sal_Int32 _MaxRows ) throw (uno::RuntimeException)
 405 {
 406     set(PROPERTY_MAXROWS,_MaxRows,m_nMaxRows);
 407 }
 408 // =============================================================================
 409 } // namespace reportdesign
 410 // =============================================================================
 411
 412 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */