PluginLoader.cc 103 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33 34 35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36 37
*                                                                            *
*   $Revision$                                                       *
38
*   $LastChangedBy$                                         *
Jan Möbius's avatar
Jan Möbius committed
39 40
*   $Date$                     *
*                                                                            *
41
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61




//=============================================================================
//
//  CLASS Core - IMPLEMENTATION of the Plugin Loading
//
//=============================================================================


//== INCLUDES =================================================================

// -------------------- mview
#include "Core.hh"

#include <QMenuBar>
#include <QToolBox>
#include <QMessageBox>
#include <QApplication>
Jan Möbius's avatar
Jan Möbius committed
62
#include <QScrollArea>
Jan Möbius's avatar
 
Jan Möbius committed
63 64 65 66 67 68 69 70 71

#include <QPluginLoader>
#include "OpenFlipper/BasePlugin/BaseInterface.hh"
#include "OpenFlipper/BasePlugin/KeyInterface.hh"
#include "OpenFlipper/BasePlugin/BackupInterface.hh"
#include "OpenFlipper/BasePlugin/LoggingInterface.hh"
#include "OpenFlipper/BasePlugin/MouseInterface.hh"
#include "OpenFlipper/BasePlugin/PickingInterface.hh"
#include "OpenFlipper/BasePlugin/ToolboxInterface.hh"
Dirk Wilden's avatar
Dirk Wilden committed
72
#include "OpenFlipper/BasePlugin/OptionsInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
73 74
#include "OpenFlipper/BasePlugin/ToolbarInterface.hh"
#include "OpenFlipper/BasePlugin/TextureInterface.hh"
Jan Möbius's avatar
Jan Möbius committed
75
#include "OpenFlipper/BasePlugin/RenderInterface.hh"
76
#include "OpenFlipper/BasePlugin/PostProcessorInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
77 78
#include "OpenFlipper/BasePlugin/MenuInterface.hh"
#include "OpenFlipper/BasePlugin/ContextMenuInterface.hh"
79
#include "OpenFlipper/BasePlugin/ProcessInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
80
#include "OpenFlipper/BasePlugin/ViewInterface.hh"
Jan Möbius's avatar
Jan Möbius committed
81
#include "OpenFlipper/BasePlugin/ViewModeInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
82 83 84 85 86 87
#include "OpenFlipper/BasePlugin/LoadSaveInterface.hh"
#include "OpenFlipper/BasePlugin/StatusbarInterface.hh"
#include "OpenFlipper/BasePlugin/INIInterface.hh"
#include "OpenFlipper/BasePlugin/FileInterface.hh"
#include "OpenFlipper/BasePlugin/RPCInterface.hh"
#include "OpenFlipper/BasePlugin/ScriptInterface.hh"
88
#include "OpenFlipper/BasePlugin/SecurityInterface.hh"
89
#include "OpenFlipper/BasePlugin/SelectionInterface.hh"
90
#include "OpenFlipper/BasePlugin/TypeInterface.hh"
91
#include "OpenFlipper/BasePlugin/PluginConnectionInterface.hh"
Jan Möbius's avatar
 
Jan Möbius committed
92

93
#include "OpenFlipper/common/RendererInfo.hh"
94

Jan Möbius's avatar
 
Jan Möbius committed
95 96 97 98 99 100 101 102
#include "OpenFlipper/INIFile/INIFile.hh"

#include "OpenFlipper/common/GlobalOptions.hh"

#include <QMessageBox>
#include <QtScript/QScriptValueIterator>

#include <ACG/QtWidgets/QtFileDialog.hh>
Dirk Wilden's avatar
Dirk Wilden committed
103
#include "OpenFlipper/widgets/PluginDialog/PluginDialog.hh"
Jan Möbius's avatar
 
Jan Möbius committed
104

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
#include <deque>
#include <limits>

/**
 * The number of plugins to load simultaneously.
 *
 * FIXME: This number should not be constant but be
 * determined from the number of processor cores.
 */
static const int PRELOAD_THREADS_COUNT = 8;

class PreloadAggregator {
    public:
        PreloadAggregator() : expectedLoaders_(0) {}

        /**
         * Intended to be called by a PreloadThread
         * before count subsequent calls to loaderReady().
         * May be called multiple times in which case
         * the counts accumulate.
         *
         * @param count The number of times the calling
         * PreloadThread intents to call loaderReady().
         */
        void expectLoaders(int count) {
            QMutexLocker loadersLock(&loadersMutex_);
            expectedLoaders_ += count;
        }

        /**
         * Intended to be called by a PreloadThread.
         *
         * Transfers ownership of the supplied loader
         * to the PreloadAggregator.
         */
        void loaderReady(QPluginLoader *loader) {
            QMutexLocker loadersLock(&loadersMutex_);
            loaders_.push_back(loader);
            --expectedLoaders_;
            pluginAvailable_.wakeOne();
        }

        /**
         * If there are still loaders expected, block
         * until the next loader becomes available and return
         * it.
         *
         * Ownership of the returned object is transferred
         * to the caller. (I.e. the caller has to delete it.)
         *
         * @return Null if there are no more loaders expected.
         * The next loader, otherwise.
         */
        QPluginLoader *waitForNextLoader() {
            QMutexLocker loadersLock(&loadersMutex_);
            if (loaders_.empty()) {
                if (expectedLoaders_ > 0) {
                    pluginAvailable_.wait(&loadersMutex_);
                } else {
                    return 0;
                }
            }

            /*
             * At this point, it is guaranteed that
             * loaders_.size() > 0.
             */
            QPluginLoader *result = loaders_.front();
            loaders_.pop_front();
            return result;
        }

    protected:
        std::deque<QPluginLoader *> loaders_;
        QWaitCondition pluginAvailable_;
        QMutex loadersMutex_;

        int expectedLoaders_;
};

Jan Möbius's avatar
Jan Möbius committed
185 186 187 188 189 190 191
class PreloadThread : public QThread
{
  public: 
    
    /** \brief Preload thread constructor
    *
    * This constructor initializes the preloading thread.
Jan Möbius's avatar
Jan Möbius committed
192 193
    *
    * @param aggregator aggregator managing the different threads
Jan Möbius's avatar
Jan Möbius committed
194
    */
195
    PreloadThread(PreloadAggregator *aggregator) : aggregator_(aggregator) {
Jan Möbius's avatar
Jan Möbius committed
196 197 198 199
    }
  
  public:
    
200 201 202 203 204 205
    void addFilename(const QString &filename) {
        QMutexLocker filenamesLock(&filenamesMutex_);
        filenames_.push_back(filename);
        aggregator_->expectLoaders(1);
    }

Jan Möbius's avatar
Jan Möbius committed
206 207 208 209 210
    /** \brief preload function
    *
    * This function is used in the thread to preload a plugin. The name is given in the constructor.
    */
    void run() {
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
      for (;;) {
          QString fileName;
          {
              /*
               * Just to be on the safe side, we protect
               * filenames_. (addFilename() could be called from
               * a different thread.)
               */
              QMutexLocker filenamesLock(&filenamesMutex_);
              if (filenames_.empty()) break;
              fileName = filenames_.front();
              filenames_.pop_front();
          }

          QPluginLoader *loader = new QPluginLoader;
          loader->setFileName(fileName);
          loader->load();
          aggregator_->loaderReady(loader);
      }
Jan Möbius's avatar
Jan Möbius committed
230 231 232
    }
    
  private:
233 234 235
    std::deque<QString> filenames_;
    QMutex filenamesMutex_;
    PreloadAggregator *aggregator_;
Jan Möbius's avatar
Jan Möbius committed
236 237
};

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
/**
 * @brief Defines the order in which plugins have to be loaded.
 *
 * First load all type Plugins to register the dataTypes to the core
 * Than load the file plugins to load objects
 * Next is textureControl to control texture based properties
 * Then load everything else.
 */
class PluginInitializationOrder {
    public:
        int getTypeOrdinal(const QString &name) const {
            const QString basename = QFileInfo(name).baseName();
            if (basename.contains("Plugin-Type"))
                return 0;
            else if (basename.contains("Plugin-File"))
                return 1;
            else if (basename.contains("TextureControl"))
                return 2;
            else
                return 3;

        }
        bool operator() (const QString &a, const QString &b) const {
            const int typeA = getTypeOrdinal(a);
            const int typeB = getTypeOrdinal(b);
            if (typeA != typeB) { return typeA < typeB; }
            return a < b;
        }

        bool operator() (const QPluginLoader *a, const QPluginLoader *b) const {
            return operator() (a->fileName(), b->fileName());
        }
};
Jan Möbius's avatar
Jan Möbius committed
271

Jan Möbius's avatar
 
Jan Möbius committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
//== IMPLEMENTATION ==========================================================


bool Core::checkSlot(QObject* _plugin , const char* _slotSignature) {
  const QMetaObject* meta = _plugin->metaObject();
  int id = meta->indexOfSlot( QMetaObject::normalizedSignature( _slotSignature ) );
  return ( id != -1 );
}

bool Core::checkSignal(QObject* _plugin , const char* _signalSignature) {
  const QMetaObject* meta = _plugin->metaObject();
  int id = meta->indexOfSignal( QMetaObject::normalizedSignature( _signalSignature ) );
  return ( id != -1 );
}

 /** Load plugins from dir Plugins. The plugin information gets stored, toolbox and menu entries are created and the required signals and slots are connected.
  */
void Core::loadPlugins()
{
Jan Möbius's avatar
Jan Möbius committed
291 292 293
  
  QString licenseTexts = "";
  
Dirk Wilden's avatar
Dirk Wilden committed
294
  //try to load plugins from new location
295
  QDir tempDir = QDir(OpenFlipper::Options::pluginDir());
Dirk Wilden's avatar
Dirk Wilden committed
296

297
  // Possible Plugin extensions
Jan Möbius's avatar
Jan Möbius committed
298 299 300
  // Windows gets DLLs
  // Mac and Linux use so
  // We don't use the dylib extension on Mac at the moment.
301 302 303
  QStringList filter;
  if ( OpenFlipper::Options::isWindows() )
    filter << "*.dll";
Jan Möbius's avatar
Jan Möbius committed
304
  else 
305 306
    filter << "*.so";
  
Jan Möbius's avatar
 
Jan Möbius committed
307
  // Get all files in the Plugin dir
308
  QStringList pluginlist = tempDir.entryList(filter,QDir::Files);
Dirk Wilden's avatar
Dirk Wilden committed
309

310 311
  // Convert local file path to absolute path
  for (int i=0; i < pluginlist.size(); i++) {
312
     pluginlist[i] = tempDir.absoluteFilePath(pluginlist[i]);
Jan Möbius's avatar
 
Jan Möbius committed
313 314
  }

315
  // get all Plugin Names which will not be loaded
316
  QStringList dontLoadPlugins = OpenFlipperSettings().value("PluginControl/DontLoadNames", QStringList()).toStringList();
317 318 319 320 321 322
  
  // Output info about additional plugins
  for ( int i = 0 ; i < dontLoadPlugins.size(); ++i) 
    emit log(LOGOUT,tr("dontLoadPlugins Plugin from ini file: %1").arg( dontLoadPlugins[i] ) );
  
  // get all Plugins which should be loaded in addition to the standard plugins 
323
  QStringList additionalPlugins = OpenFlipperSettings().value("PluginControl/AdditionalPlugins", QStringList()).toStringList();
324 325
  
  // Output info about additional plugins
Jan Möbius's avatar
Jan Möbius committed
326
  for ( int i = 0 ; i < additionalPlugins.size(); ++i) {
327
    emit log(LOGOUT,tr("Additional Plugin from file: %1").arg( additionalPlugins[i] ) );
Jan Möbius's avatar
Jan Möbius committed
328
  }
329 330 331
  
  // Prepend the additional Plugins to the plugin list
  pluginlist = additionalPlugins << pluginlist;
332 333 334 335 336 337

  /*
   * Note: This call is not necessary, anymore. Initialization order
   * is determined later.
   */
  std::sort(pluginlist.begin(), pluginlist.end(), PluginInitializationOrder());
Jan Möbius's avatar
 
Jan Möbius committed
338

339 340
  for ( int i = 0 ; i < dontLoadPlugins.size(); ++i )
    emit log(LOGWARN,tr("Skipping Plugins :\t %1").arg( dontLoadPlugins[i] ) );
Jan Möbius's avatar
 
Jan Möbius committed
341

342
  emit log(LOGOUT,"================================================================================");
Jan Möbius's avatar
 
Jan Möbius committed
343

Jan Möbius's avatar
Jan Möbius committed
344 345 346 347
  QTime time;
  
  time.start();
  
348 349 350 351 352 353 354 355 356 357
  PreloadAggregator preloadAggregator;
  std::vector< PreloadThread* > loaderThreads(PRELOAD_THREADS_COUNT);

  /*
   * Initialize loaderThreads.
   */
  for (std::vector< PreloadThread* >::iterator it = loaderThreads.begin();
          it != loaderThreads.end(); ++it) {
      *it = new PreloadThread(&preloadAggregator);
  }
Jan Möbius's avatar
Jan Möbius committed
358
  
359 360 361 362
  /*
   * Distribute plugins onto loader threads in a round robin fashion.
   * (only load them in seperate thread. Instance will be created in main thread)
   */
Jan Möbius's avatar
 
Jan Möbius committed
363
  for ( int i = 0 ; i < pluginlist.size() ; ++i) {
364 365 366 367 368 369 370 371 372
    loaderThreads[i % loaderThreads.size()]->addFilename(pluginlist[i]);
  }

  /*
   * Start plugin preloading.
   */
  for (std::vector< PreloadThread* >::iterator it = loaderThreads.begin();
          it != loaderThreads.end(); ++it) {
      (*it)->start();
Jan Möbius's avatar
Jan Möbius committed
373 374
  }
  
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
  /*
   * Wait for the plugins to get preloaded
   */
  std::vector<QPluginLoader*> loadedPlugins;
  loadedPlugins.reserve(pluginlist.size());

  for (QPluginLoader *loader = preloadAggregator.waitForNextLoader(); loader != 0;
          loader = preloadAggregator.waitForNextLoader()) {

      loadedPlugins.push_back(loader);

      if ( OpenFlipper::Options::gui() && OpenFlipperSettings().value("Core/Gui/splash",true).toBool() ) {
        splashMessage_ = tr("Loading Plugin %1/%2").arg(loadedPlugins.size()).arg(pluginlist.size()) ;
        splash_->showMessage( splashMessage_ , Qt::AlignBottom | Qt::AlignLeft , Qt::white);
      }
Jan Möbius's avatar
 
Jan Möbius committed
390 391
  }

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
  /*
   * Finalize PreloadThreads.
   */
  for (std::vector< PreloadThread* >::iterator it = loaderThreads.begin();
          it != loaderThreads.end(); ++it) {
      (*it)->wait();
      delete *it;
  }

  /*
   * Initialize preloaded plugins in the correct order.
   */
  std::sort(loadedPlugins.begin(), loadedPlugins.end(), PluginInitializationOrder());
  for (std::vector<QPluginLoader*>::iterator it = loadedPlugins.begin();
          it != loadedPlugins.end(); ++it) {

      if ( OpenFlipper::Options::gui() && OpenFlipperSettings().value("Core/Gui/splash",true).toBool() ) {
        splashMessage_ = tr("Initializing Plugin %1/%2")
                .arg(std::distance(loadedPlugins.begin(), it) + 1)
                .arg(loadedPlugins.size());
        splash_->showMessage( splashMessage_ , Qt::AlignBottom | Qt::AlignLeft , Qt::white);
      }

      if ((*it)->instance() != 0 ) {
        QString pluginLicenseText  = "";
        loadPlugin((*it)->fileName(),true,pluginLicenseText, (*it)->instance());
        licenseTexts += pluginLicenseText;
      } else {
        emit log(LOGERR,tr("Unable to load Plugin :\t %1").arg( (*it)->fileName() ) );
        emit log(LOGERR,tr("Error was : ") + (*it)->errorString() );
        emit log(LOGOUT,"================================================================================");
      }
      delete *it;
  }

  emit log(LOGINFO, tr("Total time needed to load plugins was %1 ms.").arg(time.elapsed()));

Jan Möbius's avatar
 
Jan Möbius committed
429
  splashMessage_ = "";
Jan Möbius's avatar
Jan Möbius committed
430 431
  
  if ( licenseTexts != "" ) {
Jan Möbius's avatar
Jan Möbius committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
    if ( OpenFlipper::Options::gui() ) {
      
      // split for each license block
      QStringList licenseBlocks = licenseTexts.split("==");

      // Cleanup lists to get only the ones containing valid plugins.
      for ( QStringList::iterator it = licenseBlocks.begin(); it != licenseBlocks.end() ; ++it )
        if ( ! it->contains("PluginName") ) {
          licenseBlocks.erase(it);
          it = licenseBlocks.begin();
        }
      
      // sort by the contact mails
      QMap< QString , QString > contacts;
      
      for ( QStringList::iterator it = licenseBlocks.begin(); it != licenseBlocks.end() ; ++it ) {
        QStringList lines = it->split("\n");
        
        lines = lines.filter ( "Contact mail", Qt::CaseInsensitive );
        
        // Corect one found:
        if (lines.size() == 1)  {
          QString mail = lines[0].section(":",-1).simplified();
          QString list = contacts.take(mail);
          list.append(*it);
          contacts.insert(mail,list);
        } else {
          emit log(LOGWARN,tr("Can't extract mail contact from license request"));
        }
          
      }
      
      for ( QMap<QString , QString>::iterator it = contacts.begin() ; it != contacts.end() ; ++it ) {
        
        QStringList request = it.value().split("\n");
        
        // Cleanup lists to get only the relevant part
        for ( QStringList::iterator lit = request.begin(); lit != request.end() ; ++lit ) {
          
          if ( lit->contains("Message:")  ) {
            *lit = lit->section(":",-1).simplified();
          }
          
          if ( lit->contains("Contact mail:")  ) {
            *lit = lit->section(":",-1).simplified();
          }
478
           
Jan Möbius's avatar
Jan Möbius committed
479
        }
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496

        QDialog licenseBox;
          
        QTextEdit *edit = new QTextEdit(&licenseBox);
        edit->setText(request.join("\n"));

        QLabel* mailLabel = new QLabel(&licenseBox);
        mailLabel->setText(tr("The text has been copied to your clipboard. Open in Mail program?"));

        QPushButton* noButton = new QPushButton(&licenseBox);
        noButton->setText(tr("No"));
        connect( noButton, SIGNAL(clicked ()), &licenseBox, SLOT(reject()) );

        QPushButton* yesButton = new QPushButton(&licenseBox);
        yesButton->setText(tr("Yes"));
        connect( yesButton, SIGNAL(clicked ()), &licenseBox, SLOT(accept()) );

Jan Möbius's avatar
Jan Möbius committed
497 498 499 500 501 502
        QGridLayout *layout = new QGridLayout;
        layout->addWidget(edit,0,0,1,2);
        layout->addWidget(mailLabel,1,0,1,2);
        layout->addWidget(noButton,2,0);
        layout->addWidget(yesButton,2,1);
        licenseBox.setLayout(layout);
503 504 505 506 507 508

        licenseBox.resize(500,500);
        licenseBox.setModal(true);
        licenseBox.setWindowTitle(tr("Plugin License check failed, issuer is: %1").arg( it.key() ));  
        int userAnswer =licenseBox.exec();

Jan Möbius's avatar
Jan Möbius committed
509
        // set a text to the Clipboard
510
        QClipboard *cb = QApplication::clipboard();
Jan Möbius's avatar
Jan Möbius committed
511
        cb->setText(request.join("\n"));
Jan Möbius's avatar
Jan Möbius committed
512

513
        if ( userAnswer == 1 ) {
514 515 516 517 518 519 520
           QString url = "mailto:" + it.key();
           url += "?subject=License Request&body=";
#ifdef WIN32
           url += request.join(";;");
#else
           url += request.join("\n");
#endif
Jan Möbius's avatar
Jan Möbius committed
521

522 523 524
           QUrl encodedURL(url, QUrl::TolerantMode);
           QDesktopServices::openUrl(encodedURL);
        }
Jan Möbius's avatar
Jan Möbius committed
525 526 527 528 529 530
        
      }

      
    } else {
      emit log(LOGWARN,tr("Plugin License check failed: "));
Jan Möbius's avatar
Jan Möbius committed
531 532 533
      std::cerr << licenseTexts.toStdString() << std::endl;
    }
  } 
Jan Möbius's avatar
 
Jan Möbius committed
534 535 536

  emit pluginsInitialized();

Jan Möbius's avatar
Jan Möbius committed
537
  emit log(LOGOUT,tr("Loaded %n Plugin(s)","",plugins_.size()) );
Jan Möbius's avatar
 
Jan Möbius committed
538 539 540 541 542 543 544 545 546
}

/** @brief slot for loading Plugins
 */
void Core::slotLoadPlugin(){

  if ( OpenFlipper::Options::nogui() )
    return;

547
  // Setup filters for possible plugin extensions
Jan Möbius's avatar
Jan Möbius committed
548 549 550
  // Windows gets DLLs
  // Mac and Linux use so
  // We don't use the dylib extension on Mac at the moment.
Jan Möbius's avatar
Jan Möbius committed
551
  QString filter;
Jan Möbius's avatar
 
Jan Möbius committed
552 553
  if ( OpenFlipper::Options::isWindows() )
    filter = "Plugins (*.dll)";
Jan Möbius's avatar
Jan Möbius committed
554
  else 
Jan Möbius's avatar
 
Jan Möbius committed
555 556
    filter = "Plugins (*.so)";

557
  // Ask the user to select the file to load
558
  QString filename = ACG::getOpenFileName(coreWidget_,tr("Load Plugin"),filter, OpenFlipperSettings().value("Core/CurrentDir").toString() );
Jan Möbius's avatar
 
Jan Möbius committed
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

  if (filename.isEmpty())
    return;

  // get the plugin name
  // and check if Plugin is in the dontLoad List
  QPluginLoader loader( filename );
  QObject *plugin = loader.instance();
  QString name;

  // Check if a plugin has been loaded
  if (plugin) {
    // Check if it is a BasePlugin
    BaseInterface* basePlugin = qobject_cast< BaseInterface * >(plugin);
    if ( basePlugin ) {
      name = basePlugin->name();
    }else
      return;
  }else
    return;

580
  // Ask if the plugin is on the block list
581
  QStringList dontLoadPlugins = OpenFlipperSettings().value("PluginControl/DontLoadNames", QStringList()).toStringList();
582
  if (dontLoadPlugins.contains(name)){
Jan Möbius's avatar
 
Jan Möbius committed
583 584
      int ret = QMessageBox::question(0, tr("Plugin Loading Prevention"),
                   tr("OpenFlipper is currently configured to prevent loading this plugin.\n"
585
                      "Do you want to enable this plugin permanently?"),
Jan Möbius's avatar
 
Jan Möbius committed
586 587
                   QMessageBox::Yes | QMessageBox::No,
                   QMessageBox::Yes);
588 589 590 591 592
      if (ret == QMessageBox::Yes) {
        dontLoadPlugins.removeAll(name);
        OpenFlipperSettings().setValue("PluginControl/DontLoadNames",dontLoadPlugins);
      } else
         return;
Jan Möbius's avatar
 
Jan Möbius committed
593
  }
594 595
  
  // check if the plugin is not on the additional plugin list
596
  QStringList additionalPlugins = OpenFlipperSettings().value("PluginControl/AdditionalPlugins", QStringList()).toStringList();
597 598 599 600 601 602 603 604 605 606 607 608
  if (!additionalPlugins.contains(name)){
    int ret = QMessageBox::question(0, tr("Plugin Loading ..."),
                                       tr("Should OpenFlipper load this plugin on next startup?"),
                                    QMessageBox::Yes | QMessageBox::No,
                                    QMessageBox::Yes);
    if (ret == QMessageBox::Yes) {
      additionalPlugins << filename;
      std::cerr << "Added: " << filename.toStdString() << std::endl;
      OpenFlipperSettings().setValue("PluginControl/AdditionalPlugins",additionalPlugins);
    }
  }
  
Jan Möbius's avatar
Jan Möbius committed
609 610 611 612
  QString licenseText = "";
  loadPlugin(filename,false,licenseText);
  
  if ( licenseText != "" ) {
Jan Möbius's avatar
Jan Möbius committed
613
    if ( OpenFlipper::Options::gui() ) {
Jan Möbius's avatar
Jan Möbius committed
614
      QMessageBox::warning ( 0, tr("Plugin License check failed"),  licenseText );
Jan Möbius's avatar
Jan Möbius committed
615 616 617 618
      
      std::cerr << "OpenURL: " << std::endl;
      QDesktopServices::openUrl(QUrl(tr("mailto:contact@openflipper.com?subject=License Request&body=%1").arg(licenseText), QUrl::TolerantMode));
    } else {
Jan Möbius's avatar
Jan Möbius committed
619 620 621
      std::cerr << "Plugin License check failed" << std::endl;
      std::cerr << licenseText.toStdString() << std::endl;
    }
622
  }
Jan Möbius's avatar
 
Jan Möbius committed
623 624
}

Dirk Wilden's avatar
Dirk Wilden committed
625
/** @brief slot for showing loaded Plugins
Jan Möbius's avatar
 
Jan Möbius committed
626
 */
Dirk Wilden's avatar
Dirk Wilden committed
627
void Core::slotShowPlugins(){
Jan Möbius's avatar
 
Jan Möbius committed
628

Dirk Wilden's avatar
Dirk Wilden committed
629 630 631 632 633 634
  if ( OpenFlipper::Options::gui() ){

    int ret = 0;

    while (ret == 0){

Jan Möbius's avatar
Jan Möbius committed
635
      PluginDialog* dialog = new PluginDialog(plugins_, coreWidget_);
Jan Möbius's avatar
 
Jan Möbius committed
636

Dirk Wilden's avatar
Dirk Wilden committed
637 638 639 640 641 642 643 644 645 646
      //connect signals
      connect(dialog, SIGNAL(unloadPlugin(QString)), this, SLOT(unloadPlugin(QString)));
      connect(dialog, SIGNAL( loadPlugin() ), this, SLOT( slotLoadPlugin() ));

      //if a plugin was deleted/loaded the dialog returns 0 and it needs to be loaded again
      ret = dialog->exec();

      delete dialog;
    }
  }
Jan Möbius's avatar
 
Jan Möbius committed
647 648 649 650 651 652
}

/** @brief Unload a Plugin with given name (slot)
 *  @param name plugin name
 */
void Core::unloadPlugin(QString name){
Jan Möbius's avatar
Jan Möbius committed
653 654 655 656
  for (uint i=0; i < plugins_.size(); i++)
    if (plugins_[i].rpcName == name){
      if ( checkSlot( plugins_[i].plugin , "exit()" ) )
        QMetaObject::invokeMethod(plugins_[i].plugin, "exit",  Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
657 658 659 660

      //remove toolbox widget
      QString name_nospace = name;
      name_nospace.remove(" ");
Jan Möbius's avatar
Jan Möbius committed
661 662
      if ( coreWidget_->viewModes_[0]->visibleToolboxes.contains(name_nospace) )
        coreWidget_->viewModes_[0]->visibleToolboxes.removeAt(coreWidget_->viewModes_[0]->visibleToolboxes.indexOf(name_nospace));
Jan Möbius's avatar
Jan Möbius committed
663 664 665 666
      for ( uint j = 0 ; j < plugins_[i].toolboxWidgets.size() ; ++j )
        if (plugins_[i].toolboxWidgets[j].second ){
          plugins_[i].toolboxWidgets[j].second->setVisible(false);
          delete plugins_[i].toolboxWidgets[j].second;
Dirk Wilden's avatar
Dirk Wilden committed
667

Jan Möbius's avatar
Jan Möbius committed
668 669
          if( plugins_[i].toolboxIcons[j] != 0 )
            delete plugins_[i].toolboxIcons[j];
670
        }
Jan Möbius's avatar
 
Jan Möbius committed
671

Jan Möbius's avatar
Jan Möbius committed
672
      plugins_.erase(plugins_.begin() + i);
Jan Möbius's avatar
 
Jan Möbius committed
673

Jan Möbius's avatar
Jan Möbius committed
674
      emit log(LOGOUT,tr("Unloaded Plugin :\t\t %1").arg( name) );
Jan Möbius's avatar
 
Jan Möbius committed
675 676 677 678

      return;
    }

Jan Möbius's avatar
Jan Möbius committed
679
    log(LOGERR, tr("Unable to unload plugin '%1' (plugin wasn't found)").arg(name));
Jan Möbius's avatar
 
Jan Möbius committed
680 681 682 683 684
}

/** @brief Load a Plugin with given filename
 *  @param filename complete path + filename of the plugin
 *  @param silent if 'true': user isn't asked what to do if a plugin is already loaded
Jan Möbius's avatar
Jan Möbius committed
685
 *  @param _licenseErrors String will be epty when no license issues occured, otherwise it contains the required information for obtaining a license
Jan Möbius's avatar
Jan Möbius committed
686
 *  @param _plugin You can provide a preloaded plugin here. If this is 0 the filename will be used to load the plugin.
Jan Möbius's avatar
 
Jan Möbius committed
687
 */
Jan Möbius's avatar
Jan Möbius committed
688
void Core::loadPlugin(QString filename, bool silent, QString& _licenseErrors, QObject* _plugin){
Jan Möbius's avatar
 
Jan Möbius committed
689

Jan Möbius's avatar
Jan Möbius committed
690 691
  _licenseErrors = "";
  
Jan Möbius's avatar
 
Jan Möbius committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705
  // Only load .dll under windows
  if ( OpenFlipper::Options::isWindows() ) {
    QString dllname = filename;
    if ( ! dllname.endsWith( ".dll" ) )
      return;
  }

  // Only load .so under linux
  if ( OpenFlipper::Options::isLinux() ) {
    QString soname = filename;
    if ( ! soname.endsWith( ".so" ) )
      return;
  }

Jan Möbius's avatar
Jan Möbius committed
706 707
  // This will be the reference to our plugin
  QObject *plugin = 0;
Jan Möbius's avatar
 
Jan Möbius committed
708

Jan Möbius's avatar
Jan Möbius committed
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
  // Try to open the file if we did not get a plugin,
  // Otherwise use the supplied plugin pointer
  if ( _plugin == 0 ) {
    QPluginLoader loader( filename );
    plugin = loader.instance();  
    
    if ( !plugin) {
      emit log(LOGERR,tr("Unable to load Plugin :\t %1").arg( filename ) );
      emit log(LOGERR,tr("Error was : ") + loader.errorString() );
      emit log(LOGOUT,"================================================================================");       
    }
    
  } else {
      plugin = _plugin;
  }
  
Jan Möbius's avatar
 
Jan Möbius committed
725
  // Check if a plugin has been loaded
Jan Möbius's avatar
Jan Möbius committed
726 727
  PluginInfo info;
  QString supported;
Jan Möbius's avatar
 
Jan Möbius committed
728

Jan Möbius's avatar
Jan Möbius committed
729
  emit log(LOGOUT,tr("Location : \t %1").arg(filename) );
Jan Möbius's avatar
Jan Möbius committed
730 731 732 733 734
  
  // Check if it is a BasePlugin
  BaseInterface* basePlugin = qobject_cast< BaseInterface * >(plugin);
  if ( basePlugin ) {
    emit log(LOGOUT,tr("Found Plugin : \t %1").arg(basePlugin->name()) );
Jan Möbius's avatar
 
Jan Möbius committed
735

Jan Möbius's avatar
Jan Möbius committed
736 737 738 739
    if ( OpenFlipper::Options::gui() && OpenFlipperSettings().value("Core/Gui/splash",true).toBool() ) {
      splashMessage_ = splashMessage_ + " " + basePlugin->name() ;
      splash_->showMessage( splashMessage_ , Qt::AlignBottom | Qt::AlignLeft , Qt::white);
    }
Jan Möbius's avatar
 
Jan Möbius committed
740

Jan Möbius's avatar
Jan Möbius committed
741
    //Check if plugin is already loaded
Jan Möbius's avatar
Jan Möbius committed
742
    for (uint k=0; k < plugins_.size(); k++){
Jan Möbius's avatar
Jan Möbius committed
743 744 745 746

        QString name_nospace =  basePlugin->name();
        name_nospace.remove(" ");

Jan Möbius's avatar
Jan Möbius committed
747
        if (plugins_[k].name == name_nospace){
Jan Möbius's avatar
Jan Möbius committed
748
          if (silent || OpenFlipper::Options::nogui() ){ //dont load the plugin
Jan Möbius's avatar
Jan Möbius committed
749
            emit log(LOGWARN, tr("\t\t\t Already loaded from %1").arg( plugins_[k].path) );
Jan Möbius's avatar
Jan Möbius committed
750 751 752 753 754 755 756
            emit log(LOGOUT,"================================================================================");
            return;
        }else{ //ask the user
          int ret = QMessageBox::question(coreWidget_,
                                          tr("Plugin already loaded"),
                                          tr("A Plugin with the same name was already loaded from %1.\n" 
                                              "You can only load the new plugin if you unload the existing one first.\n\n"
Jan Möbius's avatar
Jan Möbius committed
757
                                              "Do you want to unload the existing plugin first?").arg( plugins_[k].path),
Jan Möbius's avatar
Jan Möbius committed
758 759
                                          QMessageBox::Yes|QMessageBox::No, QMessageBox::No);
          if (ret == QMessageBox::Yes)
Jan Möbius's avatar
Jan Möbius committed
760
            unloadPlugin(plugins_[k].name);
Jan Möbius's avatar
Jan Möbius committed
761
          else{
Jan Möbius's avatar
Jan Möbius committed
762
            emit log(LOGWARN, tr("\t\t\t Already loaded from %1.").arg( plugins_[k].path));
Jan Möbius's avatar
Jan Möbius committed
763 764
            emit log(LOGOUT,"================================================================================");
            return;
Jan Möbius's avatar
 
Jan Möbius committed
765 766
          }
        }
Dirk Wilden's avatar
Dirk Wilden committed
767
      }
Jan Möbius's avatar
Jan Möbius committed
768
    }
Jan Möbius's avatar
 
Jan Möbius committed
769

770
    QStringList dontLoadPlugins = OpenFlipperSettings().value("PluginControl/DontLoadNames",QStringList()).toStringList();
Jan Möbius's avatar
Jan Möbius committed
771 772 773 774 775 776
    
    if ( dontLoadPlugins.contains(basePlugin->name(), Qt::CaseInsensitive) ) {
      emit log(LOGWARN,tr("OpenFlipper.ini prevented Plugin %1 from being loaded! ").arg( basePlugin->name() ));
      emit log(LOGOUT,"================================================================================");
      return;
    }
Jan Möbius's avatar
 
Jan Möbius committed
777

Jan Möbius's avatar
Jan Möbius committed
778 779 780 781
    //Check if it is a BasePlugin
    SecurityInterface * securePlugin = qobject_cast< SecurityInterface * >(plugin);
    if ( securePlugin ) {
      emit log(LOGINFO,tr("Plugin uses security interface. Trying to authenticate against plugin ..."));
782

Jan Möbius's avatar
Jan Möbius committed
783
      bool success = false;
784 785 786 787 788
      QMetaObject::invokeMethod(plugin,"authenticate", Q_RETURN_ARG( bool , success ) ) ;
      
      QString message = "";
      QMetaObject::invokeMethod(plugin,"licenseError", Q_RETURN_ARG( QString , message ) ) ;
      _licenseErrors = message;
789

Jan Möbius's avatar
Jan Möbius committed
790 791 792 793 794
      if ( success )
        emit log(LOGINFO,tr("... ok. Loading plugin "));
      else {
        emit log(LOGERR,tr("... failed. Plugin access denied."));
        emit log(LOGOUT,"================================================================================");
Jan Möbius's avatar
Jan Möbius committed
795 796
        
        // Abort here, as the plugin will not do anything else until correct authentication.
Jan Möbius's avatar
Jan Möbius committed
797
        return;
798
      }
Jan Möbius's avatar
Jan Möbius committed
799
    }
800 801


Jan Möbius's avatar
Jan Möbius committed
802
    emit log(LOGOUT,tr("Plugin Desciption :\t %1 ").arg( basePlugin->description()) );
803

Jan Möbius's avatar
Jan Möbius committed
804
    supported = "BaseInterface ";
Jan Möbius's avatar
 
Jan Möbius committed
805

Jan Möbius's avatar
Jan Möbius committed
806 807 808 809
    info.name          = basePlugin->name();
    info.description   = basePlugin->description();
    info.plugin        = plugin;
    info.path          = filename;
Jan Möbius's avatar
 
Jan Möbius committed
810

Jan Möbius's avatar
Jan Möbius committed
811 812 813 814
    if ( checkSlot(plugin,"version()") )
      info.version = basePlugin->version();
    else
      info.version = QString::number(-1);
Jan Möbius's avatar
 
Jan Möbius committed
815

Jan Möbius's avatar
Jan Möbius committed
816
    if ( OpenFlipper::Options::nogui() ) {
Jan Möbius's avatar
 
Jan Möbius committed
817

Jan Möbius's avatar
Jan Möbius committed
818 819
      if ( ! checkSlot( plugin , "noguiSupported()" ) ) {
        emit log(LOGWARN,tr("Running in nogui mode which is unsupported by this plugin, skipping") );
820
        emit log(LOGOUT,"================================================================================");
821 822 823
        return;
      }

Jan Möbius's avatar
Jan Möbius committed
824
    }
825 826


Jan Möbius's avatar
Jan Möbius committed
827 828 829 830 831 832
    // Check for baseInterface of old style!
    if ( checkSignal(plugin,"updated_objects(int)") ) {
      log(LOGERR,tr("Plugin Uses old style updated_objects! Convert to updatedObject!"));
      emit log(LOGOUT,"================================================================================");
      return;
    }
833

Jan Möbius's avatar
Jan Möbius committed
834 835 836 837 838
    if ( checkSignal(plugin,"update_view()") ) {
      log(LOGERR,tr("Plugin Uses old style update_view! Convert to updateView!"));
      emit log(LOGOUT,"================================================================================");
      return;
    }
839

Jan Möbius's avatar
Jan Möbius committed
840 841
    if ( checkSignal(plugin,"updateView()") )
      connect(plugin,SIGNAL(updateView()),this,SLOT(updateView()));
Dirk Wilden's avatar
Dirk Wilden committed
842

843

844
    if ( checkSignal(plugin,"updatedObject(int)") && checkSignal(plugin,"updatedObject(int,const UpdateType&)") ){
Dirk Wilden's avatar
Dirk Wilden committed
845
      
Jan Möbius's avatar
Jan Möbius committed
846
      log(LOGERR,tr("Plugin uses deprecated and(!) new updatedObject. Only new updatedObject will be active."));
847
      connect(plugin,SIGNAL(updatedObject(int,const UpdateType&)),this,SLOT(slotObjectUpdated(int,const UpdateType&)), Qt::DirectConnection);
Jan Möbius's avatar
Jan Möbius committed
848 849
      
    } else {
850

Jan Möbius's avatar
Jan Möbius committed
851 852 853
      if ( checkSignal(plugin,"updatedObject(int)") ){
        log(LOGWARN,tr("Plugin uses deprecated updatedObject."));
        connect(plugin,SIGNAL(updatedObject(int)),this,SLOT(slotObjectUpdated(int)), Qt::DirectConnection);
854
      }
Jan Möbius's avatar
Jan Möbius committed
855

856 857
      if ( checkSignal(plugin,"updatedObject(int,const UpdateType&)") )
        connect(plugin,SIGNAL(updatedObject(int,const UpdateType&)),this,SLOT(slotObjectUpdated(int,const UpdateType&)), Qt::DirectConnection);
Jan Möbius's avatar
Jan Möbius committed
858
    }
Jan Möbius's avatar
Jan Möbius committed
859

860
    if ( checkSlot( plugin , "slotObjectUpdated(int)" ) && checkSlot( plugin , "slotObjectUpdated(int,const UpdateType&)" ) ){
Jan Möbius's avatar
Jan Möbius committed
861 862
      
      log(LOGERR,tr("Plugin uses deprecated and(!) new slotObjectUpdated. Only new slotObjectUpdated will be active."));
863
      connect(this,SIGNAL(signalObjectUpdated(int,const UpdateType&)),plugin,SLOT(slotObjectUpdated(int,const UpdateType&)), Qt::DirectConnection);
Jan Möbius's avatar
Jan Möbius committed
864 865
    
    } else {
Jan Möbius's avatar
 
Jan Möbius committed
866

Jan Möbius's avatar
Jan Möbius committed
867 868 869
      if ( checkSlot( plugin , "slotObjectUpdated(int)" ) ){
        log(LOGWARN,tr("Plugin uses deprecated slotObjectUpdated."));
        connect(this,SIGNAL(signalObjectUpdated(int)),plugin,SLOT(slotObjectUpdated(int)), Qt::DirectConnection);
870
      }
871

872 873
      if ( checkSlot( plugin , "slotObjectUpdated(int,const UpdateType&)" ) )
        connect(this,SIGNAL(signalObjectUpdated(int,const UpdateType&)),plugin,SLOT(slotObjectUpdated(int,const UpdateType&)), Qt::DirectConnection);
Jan Möbius's avatar
Jan Möbius committed
874 875 876 877 878 879 880 881 882 883
    }

    if ( checkSignal(plugin,"objectPropertiesChanged(int)")) {
      emit log (LOGERR,tr("Signal objectPropertiesChanged(int) is deprecated. " ));
      emit log (LOGERR,tr("The signal will be automatically emitted by the object that has been changed and the core will deliver it to the plugins!. "));
      emit log (LOGERR,tr("Please remove this signal from your plugins!. "));
    }
    
    if ( checkSlot( plugin , "slotViewChanged()" ) )
      connect(this,SIGNAL(pluginViewChanged()),plugin,SLOT(slotViewChanged()), Qt::DirectConnection);
884

885 886 887
    if ( checkSlot( plugin , "slotSceneDrawn()" ) )
      connect(this,SIGNAL(pluginSceneDrawn()),plugin,SLOT(slotSceneDrawn()), Qt::DirectConnection);

888 889 890
    if ( checkSlot( plugin , "slotDrawModeChanged(int)" ) )
          connect(coreWidget_,SIGNAL(drawModeChanged(int)),plugin,SLOT(slotDrawModeChanged(int)), Qt::DirectConnection);

Jan Möbius's avatar
Jan Möbius committed
891 892
    if ( checkSlot(plugin,"slotObjectPropertiesChanged(int)"))
      connect(this,SIGNAL(objectPropertiesChanged(int)),plugin,SLOT(slotObjectPropertiesChanged(int)), Qt::DirectConnection);
893

Jan Möbius's avatar
Jan Möbius committed
894 895
    if ( checkSignal(plugin,"visibilityChanged()" ) )
      emit log (LOGERR,tr("Signal visibilityChanged() now requires objectid or -1 as argument " ));
Jan Möbius's avatar
 
Jan Möbius committed
896

Jan Möbius's avatar
Jan Möbius committed
897 898 899 900 901 902 903 904 905
    if ( checkSignal(plugin,"visibilityChanged(int)") ) {
      emit log (LOGERR,tr("Signal visibilityChanged(int) is deprecated! " ));
      emit log (LOGERR,tr("If an object changes its visibility, it will call the required functions automatically." ));
      emit log (LOGERR,tr("If you change a scenegraph node, call nodeVisibilityChanged(int). See docu of this function for details." ));
    }
    
    if ( checkSignal(plugin,"nodeVisibilityChanged(int)") )
      connect(plugin,SIGNAL(nodeVisibilityChanged(int)),this,SLOT(slotVisibilityChanged(int)), Qt::DirectConnection);
    
906

Jan Möbius's avatar
Jan Möbius committed
907 908
    if ( checkSlot(plugin,"slotVisibilityChanged(int)") )
      connect(this,SIGNAL(visibilityChanged(int)),plugin,SLOT(slotVisibilityChanged(int)), Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
909

Jan Möbius's avatar
Jan Möbius committed
910 911
    if ( checkSignal(plugin,"activeObjectChanged()" ) )
      emit log (LOGERR,tr("Signal activeObjectChanged() is now objectSelectionChanged( int _objectId ) ") );
912

Jan Möbius's avatar
Jan Möbius committed
913 914
    if ( checkSlot(plugin,"slotActiveObjectChanged()" ) )
      emit log (LOGERR,tr("Slot slotActiveObjectChanged() is now slotObjectSelectionChanged( int _objectId ) ") );
Jan Möbius's avatar
 
Jan Möbius committed
915

Jan Möbius's avatar
Jan Möbius committed
916 917
    if ( checkSlot(plugin,"slotAllCleared()") )
      connect(this,SIGNAL(allCleared()),plugin,SLOT(slotAllCleared()));
Jan Möbius's avatar
 
Jan Möbius committed
918

919

Jan Möbius's avatar
Jan Möbius committed
920 921 922
    if ( checkSignal(plugin,"objectSelectionChanged(int)") ) {
      emit log (LOGERR,tr("Signal objectSelectionChanged(in) is deprecated!") );
      emit log (LOGERR,tr("If the selection for an object is changed, the core will emit the required signals itself!") );
Jan Möbius's avatar
 
Jan Möbius committed
923 924
    }

Jan Möbius's avatar
Jan Möbius committed
925 926
    if ( checkSlot( plugin , "slotObjectSelectionChanged(int)" ) )
      connect(this,SIGNAL(objectSelectionChanged(int)),plugin,SLOT(slotObjectSelectionChanged(int) ), Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
927 928


Jan Möbius's avatar
Jan Möbius committed
929 930
    if ( checkSlot( plugin , "pluginsInitialized()" ) )
      connect(this,SIGNAL(pluginsInitialized()),plugin,SLOT(pluginsInitialized()), Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
931

Jan Möbius's avatar
Jan Möbius committed
932 933 934
    if ( checkSignal(plugin,"setSlotDescription(QString,QString,QStringList,QStringList)") )
      connect(plugin, SIGNAL(setSlotDescription(QString,QString,QStringList,QStringList)),
              this,   SLOT(slotSetSlotDescription(QString,QString,QStringList,QStringList)) );
935

Jan Möbius's avatar
Jan Möbius committed
936
    // =============================================
937
    // Function allowing switching of renderers from other plugins
Jan Möbius's avatar
Jan Möbius committed
938
    // =============================================
939 940 941 942
    if ( checkSignal(plugin,"setRenderer(unsigned int,QString)" ) ) {
      connect(plugin,SIGNAL(setRenderer(unsigned int,QString)),this,SLOT(slotSetRenderer(unsigned int,QString)));
    }

Jan Möbius's avatar
Jan Möbius committed
943 944 945 946 947
    if ( checkSignal(plugin,"getCurrentRenderer(unsigned int,QString&)" ) ) {
      connect(plugin,SIGNAL(getCurrentRenderer(unsigned int,QString&)),this,SLOT(slotGetCurrentRenderer(unsigned int,QString&)), Qt::DirectConnection);
    }


Jan Möbius's avatar
Jan Möbius committed
948
  }
Jan Möbius's avatar
 
Jan Möbius committed
949

Jan Möbius's avatar
Jan Möbius committed
950 951 952 953
  //Check if the plugin supports Logging
  LoggingInterface* logPlugin = qobject_cast< LoggingInterface * >(plugin);
  if ( logPlugin ) {
    supported = supported + "Logging ";
Dirk Wilden's avatar
Dirk Wilden committed
954

Jan Möbius's avatar
Jan Möbius committed
955 956 957 958 959
    // Create intermediate logger class which will mangle the output
    PluginLogger* newlog = new PluginLogger(info.name);
    loggers_.push_back(newlog);
    connect(plugin,SIGNAL(log(Logtype, QString )),newlog,SLOT(slotLog(Logtype, QString )),Qt::DirectConnection);
    connect(plugin,SIGNAL(log(QString )),newlog,SLOT(slotLog(QString )),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
960

Jan Möbius's avatar
Jan Möbius committed
961 962 963
    // Connect it to the core widget logger
    if ( OpenFlipper::Options::gui() )
      connect(newlog,SIGNAL(log(Logtype, QString )),coreWidget_,SLOT(slotLog(Logtype, QString )),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
964

Jan Möbius's avatar
Jan Möbius committed
965 966
    // connection to console logger
    connect(newlog,SIGNAL(log(Logtype, QString )),this,SLOT(slotLog(Logtype, QString )),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
967

Jan Möbius's avatar
Jan Möbius committed
968 969
    // connection to file logger
    connect(newlog,SIGNAL(log(Logtype, QString )),this,SLOT(slotLogToFile(Logtype, QString )),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
970

Jan Möbius's avatar
Jan Möbius committed
971 972 973 974
    // connection to external plugin logger
    if ( checkSlot(plugin,"logOutput(Logtype,QString)") )
      connect(this,SIGNAL(externalLog(Logtype,QString)), plugin, SLOT(logOutput(Logtype,QString)) ) ;
  }
Jan Möbius's avatar
 
Jan Möbius committed
975

Jan Möbius's avatar
Jan Möbius committed
976 977 978 979 980 981 982 983 984 985 986 987
  //Check if the plugin supports Menubar-Interface
  MenuInterface* menubarPlugin = qobject_cast< MenuInterface * >(plugin);
  if ( menubarPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "Menubar ";

    if ( checkSignal(plugin,"addMenubarAction(QAction*,QString)") )
      connect(plugin      , SIGNAL(addMenubarAction(QAction*,QString)),
              coreWidget_ , SLOT(slotAddMenubarAction(QAction*,QString)),Qt::DirectConnection);
    if ( checkSignal(plugin,"getMenubarMenu (QString,QMenu*&,bool)") )
      connect(plugin      , SIGNAL(getMenubarMenu (QString,QMenu*&,bool)),
              coreWidget_ , SLOT(slotGetMenubarMenu (QString,QMenu*&,bool)),Qt::DirectConnection);
  }
Jan Möbius's avatar
 
Jan Möbius committed
988

Jan Möbius's avatar
Jan Möbius committed
989 990 991 992
  //Check if the plugin supports ContextMenuInterface
  ContextMenuInterface* contextMenuPlugin = qobject_cast< ContextMenuInterface * >(plugin);
  if ( contextMenuPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "ContextMenu ";
993

Jan Möbius's avatar
Jan Möbius committed
994 995 996
    if ( checkSignal(plugin,"addContextMenuItem(QAction*,ContextMenuType)") )
      connect(plugin      , SIGNAL(addContextMenuItem(QAction*,ContextMenuType)),
              coreWidget_ , SLOT(slotAddContextItem(QAction*,ContextMenuType)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
997

Jan Möbius's avatar
Jan Möbius committed
998 999 1000
    if ( checkSignal(plugin,"addContextMenuItem(QAction*,DataType,ContextMenuType)") )
      connect(plugin      , SIGNAL(addContextMenuItem(QAction*,DataType,ContextMenuType)),
              coreWidget_ , SLOT(slotAddContextItem(QAction*,DataType,ContextMenuType)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1001

Marcel Campen's avatar
Marcel Campen committed
1002 1003 1004 1005
    if ( checkSignal(plugin,"hideContextMenu()") )
          connect(plugin      , SIGNAL(hideContextMenu()),
                  coreWidget_ , SLOT(slotHideContextMenu()),Qt::DirectConnection);

Jan Möbius's avatar
Jan Möbius committed
1006 1007 1008
    if ( checkSlot(plugin,"slotUpdateContextMenu(int)") )
      connect(coreWidget_ , SIGNAL(updateContextMenu(int)),
              plugin      , SLOT(slotUpdateContextMenu(int)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1009

Jan Möbius's avatar
Jan Möbius committed
1010 1011 1012
    if ( checkSlot(plugin,"slotUpdateContextMenuNode(int)") )
      connect(coreWidget_ , SIGNAL(updateContextMenuNode(int)),
              plugin      , SLOT(slotUpdateContextMenuNode(int)),Qt::DirectConnection);
1013

Jan Möbius's avatar
Jan Möbius committed
1014 1015 1016 1017
    if ( checkSlot(plugin,"slotUpdateContextMenuBackground()") )
      connect(coreWidget_ , SIGNAL(updateContextMenuBackground()),
              plugin      , SLOT(slotUpdateContextMenuBackground()),Qt::DirectConnection);
  }
1018

Jan Möbius's avatar
Jan Möbius committed
1019 1020 1021 1022
  //Check if the plugin supports Toolbox-Interface
  ToolboxInterface* toolboxPlugin = qobject_cast< ToolboxInterface * >(plugin);
  if ( toolboxPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "Toolbox ";
1023

Dirk Wilden's avatar
Dirk Wilden committed
1024

Jan Möbius's avatar
Jan Möbius committed
1025 1026 1027
    if ( checkSignal(plugin, "addToolbox(QString,QWidget*)"))
      connect(plugin, SIGNAL( addToolbox(QString,QWidget*) ),
              this, SLOT( addToolbox(QString,QWidget*) ),Qt::DirectConnection );
Jan Möbius's avatar
 
Jan Möbius committed
1028

Dirk Wilden's avatar
Dirk Wilden committed
1029 1030 1031
    if ( checkSignal(plugin, "addToolbox(QString,QWidget*,QIcon*)"))
      connect(plugin, SIGNAL( addToolbox(QString,QWidget*,QIcon*) ),
              this, SLOT( addToolbox(QString,QWidget*,QIcon*) ),Qt::DirectConnection );
Jan Möbius's avatar
Jan Möbius committed
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  }
  
  //Check if the plugin supports ViewMode-Interface
  ViewModeInterface* viewModePlugin = qobject_cast< ViewModeInterface * >(plugin);
  if ( viewModePlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "ViewMode ";
    
    if ( checkSignal(plugin, "defineViewModeToolboxes(QString,QStringList)"))
      connect(plugin, SIGNAL( defineViewModeToolboxes(QString, QStringList) ),
              coreWidget_, SLOT( slotAddViewModeToolboxes(QString, QStringList) ),Qt::DirectConnection );
              
    if ( checkSignal(plugin, "defineViewModeToolbars(QString,QStringList)"))
      connect(plugin, SIGNAL( defineViewModeToolbars(QString, QStringList) ),
Jan Möbius's avatar
Marlin:  
Jan Möbius committed
1045 1046 1047 1048 1049
              coreWidget_, SLOT( slotAddViewModeToolbars(QString, QStringList) ),Qt::DirectConnection );    
              
    if ( checkSignal(plugin, "defineViewModeContextMenus(QString,QStringList)"))
      connect(plugin, SIGNAL( defineViewModeContextMenus(QString, QStringList) ),
              coreWidget_, SLOT( slotAddViewModeContextMenus(QString, QStringList) ),Qt::DirectConnection );                
Jan Möbius's avatar
Jan Möbius committed
1050 1051 1052
              
    if ( checkSignal(plugin, "defineViewModeIcon(QString,QString)"))
      connect(plugin, SIGNAL( defineViewModeIcon(QString, QString) ),
1053 1054 1055 1056 1057 1058
              coreWidget_, SLOT( slotSetViewModeIcon(QString, QString) ),Qt::DirectConnection );

    if ( checkSignal(plugin, "setViewMode(QString,bool)"))
      connect(plugin,    SIGNAL( setViewMode(QString, bool) ),
              coreWidget_, SLOT( setViewMode(QString, bool) ),Qt::DirectConnection );
  }
Jan Möbius's avatar
Jan Möbius committed
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071

  //Check if the plugin supports Options-Interface
  OptionsInterface* optionsPlugin = qobject_cast< OptionsInterface * >(plugin);
  if ( optionsPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "Options ";

    QWidget* widget = 0;
    if ( optionsPlugin->initializeOptionsWidget( widget ) ) {
          info.optionsWidget = widget;

          if ( checkSlot(plugin,"applyOptions()") )
            connect(coreWidget_ , SIGNAL( applyOptions() ),
                    plugin      , SLOT( applyOptions() ),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1072
    }
Jan Möbius's avatar
Jan Möbius committed
1073
  }
Jan Möbius's avatar
 
Jan Möbius committed
1074

Jan Möbius's avatar
Jan Möbius committed
1075 1076 1077 1078
  //Check if the plugin supports Toolbar-Interface
  ToolbarInterface* toolbarPlugin = qobject_cast< ToolbarInterface * >(plugin);
  if ( toolbarPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "Toolbars ";
Jan Möbius's avatar
 
Jan Möbius committed
1079

Jan Möbius's avatar
Jan Möbius committed
1080 1081 1082
    if ( checkSignal(plugin,"addToolbar(QToolBar*)") )
      connect(plugin,SIGNAL(addToolbar(QToolBar*)),
              coreWidget_,SLOT(slotAddToolbar(QToolBar*)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1083

Jan Möbius's avatar
Jan Möbius committed
1084 1085 1086
    if ( checkSignal(plugin,"removeToolbar(QToolBar*)") )
      connect(plugin,SIGNAL(removeToolbar(QToolBar*)),
              coreWidget_,SLOT(slotRemoveToolbar(QToolBar*)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1087

Jan Möbius's avatar
Jan Möbius committed
1088 1089 1090 1091 1092
    if ( checkSignal(plugin,"getToolBar(QString,QToolBar*&)") )
      connect(plugin,SIGNAL(getToolBar(QString,QToolBar*&)),
              coreWidget_,SLOT(getToolBar(QString,QToolBar*&)),Qt::DirectConnection);
        
  }
Jan Möbius's avatar
 
Jan Möbius committed
1093

Jan Möbius's avatar
Jan Möbius committed
1094 1095 1096 1097
  //Check if the plugin supports StatusBar-Interface
  StatusbarInterface* statusbarPlugin = qobject_cast< StatusbarInterface * >(plugin);
  if ( statusbarPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "StatusBar ";
Jan Möbius's avatar
 
Jan Möbius committed
1098

Jan Möbius's avatar
Jan Möbius committed
1099 1100 1101
    if ( checkSignal(plugin,"showStatusMessage(QString,int)") )
      connect(plugin,SIGNAL(showStatusMessage(QString,int)),
              coreWidget_,SLOT(statusMessage(QString,int)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1102

Dirk Wilden's avatar
Dirk Wilden committed
1103

Jan Möbius's avatar
Jan Möbius committed
1104 1105 1106
    if ( checkSignal(plugin,"setStatus(ApplicationStatus::applicationStatus)") )
      connect(plugin,SIGNAL(setStatus(ApplicationStatus::applicationStatus)),
              coreWidget_,SLOT(setStatus(ApplicationStatus::applicationStatus)),Qt::DirectConnection);
Jan Möbius's avatar
 
Jan Möbius committed
1107

Jan Möbius's avatar
Jan Möbius committed
1108 1109 1110 1111 1112 1113 1114
    if ( checkSignal(plugin,"clearStatusMessage()") )
      connect(plugin,SIGNAL(clearStatusMessage()),
              coreWidget_,SLOT(clearStatusMessage()));
              
    if ( checkSignal(plugin,"addWidgetToStatusbar(QWidget*)") )
      connect(plugin,SIGNAL(addWidgetToStatusbar(QWidget*)), coreWidget_,SLOT(addWidgetToStatusbar(QWidget*)));
  }
Jan Möbius's avatar
 
Jan Möbius committed
1115

Jan Möbius's avatar
Jan Möbius committed
1116 1117 1118 1119
  //Check if the plugin supports Key-Interface
  KeyInterface* keyPlugin = qobject_cast< KeyInterface * >(plugin);
  if ( keyPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "KeyboardEvents ";
Jan Möbius's avatar
 
Jan Möbius committed
1120

Jan Möbius's avatar
Jan Möbius committed
1121 1122 1123 1124
    if ( checkSignal(plugin,"registerKey(int,Qt::KeyboardModifiers,QString,bool)") )
      connect(plugin,SIGNAL( registerKey(int, Qt::KeyboardModifiers, QString, bool) ),
              coreWidget_,SLOT(slotRegisterKey(int, Qt::KeyboardModifiers, QString, bool)) );
  }
Jan Möbius's avatar
 
Jan Möbius committed
1125

Jan Möbius's avatar
Jan Möbius committed
1126 1127 1128 1129
  //Check if the plugin supports Mouse-Interface
  MouseInterface* mousePlugin = qobject_cast< MouseInterface * >(plugin);
  if ( mousePlugin && OpenFlipper::Options::gui()  ) {
    supported = supported + "MouseEvents ";
Jan Möbius's avatar
 
Jan Möbius committed
1130

Jan Möbius's avatar
Jan Möbius committed
1131 1132 1133
    if ( checkSlot( plugin , "slotMouseWheelEvent(QWheelEvent*,const std::string&)" ) )
      connect(this   , SIGNAL(PluginWheelEvent(QWheelEvent * , const std::string & )),
              plugin , SLOT(slotMouseWheelEvent(QWheelEvent* , const std::string & )));
Jan Möbius's avatar
 
Jan Möbius committed
1134

Jan Möbius's avatar
Jan Möbius committed
1135 1136 1137
    if ( checkSlot( plugin , "slotMouseEvent(QMouseEvent*)" ) )
      connect(this   , SIGNAL(PluginMouseEvent(QMouseEvent*)),
              plugin , SLOT(slotMouseEvent(QMouseEvent*)));
Jan Möbius's avatar
 
Jan Möbius committed
1138

Jan Möbius's avatar
Mike:  
Jan Möbius committed
1139 1140 1141
    if ( checkSlot( plugin , "slotMouseEventLight(QMouseEvent*)" ) )
      connect(this   , SIGNAL(PluginMouseEventLight(QMouseEvent*)),
              plugin , SLOT(slotMouseEventLight(QMouseEvent*)));
Jan Möbius's avatar
 
Jan Möbius committed
1142

Jan Möbius's avatar
Jan Möbius committed
1143
  }
Jan Möbius's avatar
 
Jan Möbius committed
1144

1145 1146 1147 1148 1149 1150 1151 1152 1153
  //Check if the plugin supports InformationInterface
  InformationInterface* infoPlugin = qobject_cast< InformationInterface * >(plugin);
  if ( infoPlugin && OpenFlipper::Options::gui()  ) {
    supported = supported + "TypeInformation ";

    DataType dtype = infoPlugin->supportedDataTypes();
    supportedInfoTypes().insert(std::pair<InformationInterface*,DataType>(infoPlugin,dtype));
  }

Jan Möbius's avatar
Jan Möbius committed
1154 1155 1156 1157
  //Check if the plugin supports Picking-Interface
  PickingInterface* pickPlugin = qobject_cast< PickingInterface * >(plugin);
  if ( pickPlugin && OpenFlipper::Options::gui() ) {
    supported = supported + "Picking ";
1158

Jan Möbius's avatar
Jan Möbius committed
1159 1160 1161
    if ( checkSlot( plugin , "slotPickModeChanged(const std::string&)" ) )
      connect(coreWidget_,SIGNAL(signalPickModeChanged (const std::string &)),
              plugin,SLOT(slotPickModeChanged( const std::string &)));