unipresent/openoffice.org/UpOoBackend.cpp

   1 /***************************************************************************
   2  *   This file is part of KWorship.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   KWorship is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   KWorship is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with KWorship.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 /**
  21  * @file UpOoBackend.cpp
  22  * @brief OpenOffice.org presentation manager.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "UpOoBackend.h"
  27 #include "UpOoBridge.h"
  28 #include "UpOoPresentation.h"
  29
  30 #include "compiler.h"
  31
  32 #include <KRun>
  33 #include <KShell>
  34 #include <KLocale>
  35 #include <KGenericFactory>
  36
  37 #include <QThread>
  38
  39 #include <osl/file.hxx>
  40 #include <osl/process.h>
  41 #include <com/sun/star/beans/XPropertySet.hpp>
  42 #include <com/sun/star/container/XEnumeration.hpp>
  43 #include <com/sun/star/container/XEnumerationAccess.hpp>
  44 #include <com/sun/star/document/XDocumentEventBroadcaster.hpp>
  45 #include <com/sun/star/document/XDocumentEventListener.hpp>
  46 #include <com/sun/star/frame/XComponentLoader.hpp>
  47 #include <com/sun/star/frame/XDesktop.hpp>
  48 #include <com/sun/star/lang/XMultiComponentFactory.hpp>
  49 #include <com/sun/star/presentation/XPresentationSupplier.hpp>
  50 #include <com/sun/star/uno/XComponentContext.hpp>
  51 #include <cppuhelper/implbase1.hxx>
  52
  53 using namespace com::sun::star::beans;
  54 using namespace com::sun::star::container;
  55 using namespace com::sun::star::document;
  56 using namespace com::sun::star::frame;
  57 using namespace com::sun::star::lang;
  58 using namespace com::sun::star::presentation;
  59 using namespace com::sun::star::uno;
  60 using namespace com::sun::star;
  61 using namespace rtl;
  62
  63 K_EXPORT_COMPONENT_FACTORY( unipresent_openoffice, KGenericFactory<UpOoBackend>("unipresent_openoffice") )
  64
  65 /*
  66  * Types
  67  */
  68
  69 class UpOoBackend::DocumentEventListener : public ::cppu::WeakImplHelper1<XDocumentEventListener>
  70 {
  71   public:
  72     /*
  73      * Constructors + destructor
  74      */
  75
  76     /// Primary constructor.
  77     DocumentEventListener(UpOoBackend* backend, const Reference<XDocumentEventBroadcaster>& broadcaster)
  78     : m_backend(backend)
  79     , m_broadcaster(broadcaster)
  80     {
  81       kdDebug() << __PRETTY_FUNCTION__;
  82     }
  83
  84     /// Virtual destructor.
  85     ~DocumentEventListener()
  86     {
  87       kdDebug() << __PRETTY_FUNCTION__;
  88       if (m_broadcaster.is())
  89       {
  90         Reference<XDocumentEventListener> xRefListener = static_cast<XDocumentEventListener*>(this);
  91         m_broadcaster->removeDocumentEventListener(xRefListener);
  92       }
  93     }
  94
  95     /*
  96      * Virtual functions
  97      */
  98
  99     /// Main document event handler.
 100     virtual void SAL_CALL documentEventOccured(const DocumentEvent& event)
 101       throw(RuntimeException)
 102     {
 103       // Only handle new documents
 104       // NOTE: OnCreate and OnLoadFinished can be used before the presentation is made visible
 105       //       OnNew and OnLoad are only after the presentation is made visible
 106       if (event.EventName.equalsAscii("OnNew") ||
 107           event.EventName.equalsAscii("OnLoad"))
 108       {
 109         // Specifically, only presentations
 110         Reference<XPresentationSupplier> presentationDoc(event.Source, UNO_QUERY);
 111         if (presentationDoc.is())
 112         {
 113           UpOoPresentation* newPresentation = new UpOoPresentation(presentationDoc.get(), m_backend);
 114           m_backend->m_presentations.push_back(newPresentation);
 115           emit m_backend->loadedPresentation(newPresentation);
 116         }
 117       }
 118     }
 119
 120     /// Handle disposing.
 121     virtual void SAL_CALL disposing(const lang::EventObject& event)
 122       throw(RuntimeException)
 123     {
 124       kdDebug() << __PRETTY_FUNCTION__ << &event;
 125       /// @todo check this behaviour is correct, is it the broadcaster that is being disposed of?
 126       m_broadcaster = 0;
 127     }
 128
 129   private:
 130     /*
 131      * Variables
 132      */
 133
 134     /// Backend object.
 135     UpOoBackend* m_backend;
 136
 137     /// Broadcaster that this listener is registered with.
 138     Reference<XDocumentEventBroadcaster> m_broadcaster;
 139 };
 140
 141 /*
 142  * Constructors + destructor
 143  */
 144
 145 /// Primary constructor.
 146 UpOoBackend::UpOoBackend(QObject* parent, const QStringList& params)
 147 : UpBackend(parent, params)
 148 , m_bridge(0)
 149 , m_globalDocumentEventListener()
 150 , m_presentations()
 151 {
 152   updatePresentations();
 153 }
 154
 155 /// Destructor.
 156 UpOoBackend::~UpOoBackend()
 157 {
 158   delete m_bridge;
 159 }
 160
 161 /*
 162  * General meta information
 163  */
 164
 165 QString UpOoBackend::id() const
 166 {
 167   return "OpenOffice.org";
 168 }
 169
 170 QString UpOoBackend::name() const
 171 {
 172   return i18n("OpenOffice.org");
 173 }
 174
 175 QString UpOoBackend::description() const
 176 {
 177   return i18n("Controls a running OpenOffice.org presentation");
 178 }
 179
 180 QStringList UpOoBackend::mimeTypes() const
 181 {
 182   /// @todo Find mime types from open office if possible
 183   return QStringList()
 184     << "application/vnd.oasis.opendocument.presentation"
 185     ;
 186 }
 187
 188 QIcon UpOoBackend::icon() const
 189 {
 190   return QIcon();
 191 }
 192
 193 /*
 194  * Activation
 195  */
 196
 197 bool UpOoBackend::isActive()
 198 {
 199   /// @todo Gently try again
 200   return (0 != m_bridge);
 201 }
 202
 203 bool UpOoBackend::activate()
 204 {
 205   int tries = 0;
 206   while (0 == m_bridge)
 207   {
 208     m_bridge = new UpOoBridge();
 209     if (m_bridge->isValid())
 210     {
 211       activated();
 212
 213       updatePresentations();
 214       return true;
 215     }
 216     else
 217     {
 218       delete m_bridge;
 219       m_bridge = 0;
 220
 221       ++tries;
 222       if (tries == 1)
 223       {
 224         // First try : start OpenOffice.org
 225         bool starting = KRun::runCommand("openoffice.org " + KShell::quoteArg("-accept=socket,host=localhost,port=2083;urp;StarOffice.ServiceManager"), 0);
 226         if (!starting)
 227         {
 228           return false;
 229         }
 230       }
 231       else if (tries > 10)
 232       {
 233         // Second try + : give up
 234         return false;
 235       }
 236       /// @todo PORT
 237       usleep(500000);
 238     }
 239   }
 240
 241   return (0 != m_bridge);
 242 }
 243
 244 void UpOoBackend::deactivate()
 245 {
 246   if (0 != m_bridge)
 247   {
 248     delete m_bridge;
 249     m_bridge = 0;
 250     deactivated();
 251   }
 252 }
 253
 254 /*
 255  * Presentation management
 256  */
 257
 258 QList<UpPresentation*> UpOoBackend::presentations()
 259 {
 260   return m_presentations;
 261 }
 262
 263 bool UpOoBackend::openPresentation(const QUrl& url)
 264 {
 265   OUString urlString = OUString::createFromAscii(url.toString().toAscii());
 266
 267   if (activate())
 268   {
 269     Reference<XPropertySet> propertySet(m_bridge->serviceManager(), UNO_QUERY);
 270     Reference<XComponentContext> componentContext;
 271     propertySet->getPropertyValue(OUString::createFromAscii("DefaultContext")) >>= componentContext;
 272     Reference<XMultiComponentFactory> componentFactoryServer = componentContext->getServiceManager();
 273
 274     Reference<XComponentLoader> componentLoader(componentFactoryServer->createInstanceWithContext(OUString::createFromAscii("com.sun.star.frame.Desktop"), componentContext), UNO_QUERY);
 275
 276     Reference<XComponent> newComponent = componentLoader->loadComponentFromURL(urlString, OUString::createFromAscii("_blank"), 0, Sequence< ::com::sun::star::beans::PropertyValue>() );
 277
 278     return true;
 279   }
 280   else
 281   {
 282     return false;
 283   }
 284 }
 285
 286 /*
 287  * Other interfaces
 288  */
 289
 290 /// Update the list of presentations
 291 void UpOoBackend::updatePresentations()
 292 {
 293   if (0 == m_bridge)
 294   {
 295     m_bridge = new UpOoBridge();
 296     if (!m_bridge->isValid())
 297     {
 298       delete m_bridge;
 299       m_bridge = 0;
 300     }
 301   }
 302
 303   if (0 != m_bridge && m_presentations.isEmpty())
 304   {
 305     // Find open documents.
 306     Reference<XPropertySet> propertySet(m_bridge->serviceManager(), UNO_QUERY);
 307     Reference<XComponentContext> componentContext;
 308     propertySet->getPropertyValue(OUString::createFromAscii("DefaultContext")) >>= componentContext;
 309     Reference<XMultiComponentFactory> componentFactoryServer = componentContext->getServiceManager();
 310
 311     Reference<XDesktop> desktop(componentFactoryServer->createInstanceWithContext(OUString::createFromAscii("com.sun.star.frame.Desktop"), componentContext), UNO_QUERY);
 312     Reference<XEnumeration> documents = desktop->getComponents()->createEnumeration();
 313
 314     while (documents->hasMoreElements())
 315     {
 316       Reference<XPresentationSupplier> presentationSupplier;
 317       documents->nextElement() >>= presentationSupplier;
 318       if (0 != presentationSupplier.get())
 319       {
 320         m_presentations.push_back(new UpOoPresentation(presentationSupplier.get(), this));
 321       }
 322     }
 323
 324     // Add listener to global document events
 325     Reference<XDocumentEventBroadcaster> broadcaster(componentFactoryServer->createInstanceWithContext(OUString::createFromAscii("com.sun.star.frame.GlobalEventBroadcaster"), componentContext), UNO_QUERY);
 326     m_globalDocumentEventListener = new DocumentEventListener(this, broadcaster);
 327     Reference<XDocumentEventListener> xRefListener = static_cast<XDocumentEventListener*>(m_globalDocumentEventListener.get());
 328     broadcaster->addDocumentEventListener(xRefListener);
 329   }
 330 }
 331