reportdesign/source/core/api/ReportEngineJFree.cxx

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