kworship/bible/KwBiblePlugin.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 KwBiblePlugin.cpp
  22  * @brief Bibles plugin.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwBiblePlugin.h"
  27 #include <KwApplication.h>
  28 #include <kworship.h>
  29 #include <KwDocument.h>
  30
  31 #include "KwBibleManager.h"
  32 #include "KwBibleModule.h"
  33 #include "KwBiblePlaylistItem.h"
  34
  35 #include <KwPlaylistModel.h>
  36
  37 #include <KLocale>
  38 #include <KAction>
  39 #include <KMessageBox>
  40 #include <KGenericFactory>
  41 #include <KServiceTypeTrader>
  42
  43 #include <QMainWindow>
  44 #include <QDockWidget>
  45 #include <QHBoxLayout>
  46 #include <QVBoxLayout>
  47 #include <QComboBox>
  48 #include <QLabel>
  49 #include <QLineEdit>
  50 #include <QTextEdit>
  51 #include <QToolBar>
  52
  53 K_EXPORT_COMPONENT_FACTORY( kworship_bible, KGenericFactory<KwBiblePlugin>("kworship_bible") )
  54
  55 /*
  56  * Constructors + destructor
  57  */
  58
  59 /// Default constructor.
  60 KwBiblePlugin::KwBiblePlugin(QObject* parent, const QStringList& params)
  61 : KwPlugin(parent, "bible",
  62            i18n("Bible"),
  63            i18n("The bible plugin allows for the navigation and display of "
  64                 "bible extracts from various sources."))
  65 , m_managers()
  66 , m_insertIntoPlaylistAction(0)
  67 , m_showNowAction(0)
  68 , m_docker(0)
  69 , m_managerTabs(0)
  70 , m_comboBook(0)
  71 , m_comboChapter(0)
  72 , m_editRange(0)
  73 , m_textPassage(0)
  74 {
  75   Q_UNUSED(params);
  76   setXMLFile("bible/kworship_bibleui.rc");
  77 }
  78
  79 /// Destructor.
  80 KwBiblePlugin::~KwBiblePlugin()
  81 {
  82 }
  83
  84 /*
  85  * Accessors
  86  */
  87
  88 /// Get the current bible passage information.
  89 bool KwBiblePlugin::resolvePassage(KwBibleManager** manager, KwBibleModule** module, KwBibleModule::Key* key, bool* usedSearch) const
  90 {
  91   // Get the current bible manager
  92   int tab = m_managerTabs->currentIndex();
  93   if (tab >= 0 && tab < m_managers.size())
  94   {
  95     const BibleManager& mgr = m_managers[tab];
  96     *manager = mgr.manager;
  97
  98     // Is a bible selected?
  99     int bibleInd = mgr.comboBibles->currentIndex();
 100     QString bible;
 101     KwBibleModule* mod = 0;
 102     if (bibleInd >= 0)
 103     {
 104       QString bible = mgr.comboBibles->itemData(bibleInd).toString();
 105       mod = mgr.manager->module(bible);
 106     }
 107     if (0 != mod)
 108     {
 109       *module = mod;
 110       // Is a book selected?
 111       int bookIndex = m_comboBook->currentIndex();
 112       int chapterIndex = -1;
 113       if (bookIndex >= 0)
 114       {
 115         // Is a chapter selected?
 116         chapterIndex = m_comboChapter->currentIndex()-1;
 117         if (chapterIndex < 0)
 118         {
 119           return false;
 120         }
 121       }
 122
 123       bool valid;
 124       KwBibleModule::Key relativeKey = mod->createKey(bookIndex, chapterIndex);
 125       *key = mod->createKey(relativeKey, m_editRange->text(), &valid);
 126
 127       if (0 != usedSearch)
 128       {
 129         *usedSearch = true;
 130       }
 131       return valid;
 132     }
 133   }
 134   if (0 != usedSearch)
 135   {
 136     *usedSearch = false;
 137   }
 138   return false;
 139 }
 140
 141 /*
 142  * Private slots
 143  */
 144
 145 /// Fired when the connect to bible button is pressed.
 146 void KwBiblePlugin::slotConnect()
 147 {
 148   // Get the current bible manager
 149   int tab = m_managerTabs->currentIndex();
 150   Q_ASSERT(tab >= 0 && tab < m_managers.size());
 151   BibleManager* mgr = &m_managers[tab];
 152
 153   // This will force the connection
 154   fillBiblesList(mgr);
 155 }
 156
 157 /// Fired when the bible is changed.
 158 void KwBiblePlugin::slotBibleChanged()
 159 {
 160   // Get the current bible manager
 161   int tab = m_managerTabs->currentIndex();
 162   if (tab >= 0 && tab < m_managers.size())
 163   {
 164     BibleManager& mgr = m_managers[tab];
 165     bool enabled = mgr.comboBibles->isEnabled();
 166
 167     // Is a bible selected?
 168     int bibleInd = mgr.comboBibles->currentIndex();
 169     QString bible;
 170     KwBibleModule* module = 0;
 171     if (bibleInd >= 0)
 172     {
 173       QString bible = mgr.comboBibles->itemData(bibleInd).toString();
 174       module = mgr.manager->module(bible);
 175     }
 176
 177     // Update the list of books
 178     QString book = m_comboBook->currentText();
 179     int chapter = m_comboChapter->currentIndex()-1;
 180     m_comboBook->clear();
 181     if (0 != module)
 182     {
 183       QStringList bookNames = module->books();
 184       for (int i = 0; i < bookNames.size(); ++i)
 185       {
 186         const QString& bookName = bookNames[i];
 187         m_comboBook->addItem(bookName, QVariant(i));
 188       }
 189       int index = m_comboBook->findText(book);
 190       bool canPreserveBook = (index >= 0);
 191       if (!canPreserveBook && bookNames.size() > 0)
 192       {
 193         index = 0;
 194       }
 195       m_comboBook->setCurrentIndex(index);
 196       if (canPreserveBook && chapter >= 0)
 197       {
 198         // If we can restore book, also restore chapter
 199         m_comboChapter->setCurrentIndex(chapter+1);
 200       }
 201     }
 202     else
 203     {
 204       enabled = false;
 205     }
 206
 207     m_comboBook->setEnabled(enabled);
 208     m_comboChapter->setEnabled(enabled);
 209     m_editRange->setEnabled(enabled);
 210   }
 211 }
 212
 213 /// Fired when the bible book is changed.
 214 void KwBiblePlugin::slotBookChanged()
 215 {
 216   m_comboChapter->clear();
 217   m_comboChapter->addItem(QString(), QVariant(-1));
 218
 219   // Get the current bible manager
 220   int tab = m_managerTabs->currentIndex();
 221   if (tab >= 0 && tab < m_managers.size())
 222   {
 223     BibleManager& mgr = m_managers[tab];
 224
 225     // Is a bible selected?
 226     int bibleInd = mgr.comboBibles->currentIndex();
 227     QString bible;
 228     KwBibleModule* module = 0;
 229     if (bibleInd >= 0)
 230     {
 231       QString bible = mgr.comboBibles->itemData(bibleInd).toString();
 232       module = mgr.manager->module(bible);
 233     }
 234     if (0 != module)
 235     {
 236       // Is a book selected?
 237       int index = m_comboBook->currentIndex();
 238       if (index >= 0)
 239       {
 240         int bookIndex = m_comboBook->itemData(index).toInt();
 241         int numChapters = module->numChapters(bookIndex);
 242         for (int i = 0; i < numChapters; ++i)
 243         {
 244           m_comboChapter->addItem(QString("%1").arg(i+1), QVariant(i));
 245         }
 246       }
 247     }
 248   }
 249   slotVerseRange();
 250 }
 251
 252 /// Fired when the bible text needs to be retrieved.
 253 void KwBiblePlugin::slotVerseRange()
 254 {
 255   KwBibleManager* manager;
 256   KwBibleModule* module;
 257   KwBibleModule::Key key;
 258   bool usedSearch;
 259   bool success = resolvePassage(&manager, &module, &key, &usedSearch);
 260   if (usedSearch)
 261   {
 262     m_comboBook->setCurrentIndex(key.start.book);
 263     m_comboChapter->setCurrentIndex(key.start.chapter+1);
 264
 265     KwBiblePassage passage;
 266     module->fillPassage(key, &passage);
 267     m_textPassage->document()->setHtml(passage.renderedText());
 268
 269     m_insertIntoPlaylistAction->setEnabled(true);
 270     m_showNowAction->setEnabled(true);
 271
 272     // Update color of search box
 273     static QPalette p = m_editRange->palette();
 274     QPalette changedPal = p;
 275     if (!success)
 276     {
 277       changedPal.setColor( QPalette::Normal, QPalette::Base, QColor(255, 127, 127) );
 278     }
 279     m_editRange->setPalette(changedPal);
 280
 281     return;
 282   }
 283   m_textPassage->document()->setPlainText(QString());
 284   m_insertIntoPlaylistAction->setEnabled(false);
 285   m_showNowAction->setEnabled(false);
 286 }
 287
 288 /// Fired by the insert into playlist action.
 289 void KwBiblePlugin::slotInsertIntoPlaylist()
 290 {
 291   KwBibleManager* manager;
 292   KwBibleModule* module;
 293   KwBibleModule::Key key;
 294   bool success = resolvePassage(&manager, &module, &key);
 295
 296   if (success)
 297   {
 298     KwBiblePlaylistItem* item = new KwBiblePlaylistItem();
 299     module->fillPassage(key, &item->passage());
 300     KwPlaylistModel* model = KwApplication::self()->mainWindow()->playlistModel();
 301     model->addItem(QModelIndex(), item);
 302   }
 303 }
 304
 305 /// Fired by the show now action.
 306 void KwBiblePlugin::slotShowNow()
 307 {
 308 }
 309
 310 /*
 311  * Loading and unloading virtual interface
 312  */
 313
 314 #include <QtDebug>
 315 void KwBiblePlugin::_load()
 316 {
 317   // Construct the bible managers and put into a list.
 318   // Have the local bible managers first in the list.
 319   KService::List offers = KServiceTypeTrader::self()->query("KWorship/Bible");
 320   QList<KwBibleManager*> managers;
 321   QList<KwBibleManager*> remoteManagers;
 322   foreach (KService::Ptr service, offers)
 323   {
 324     qDebug() << "  Found KWorship bible backend: " << service->desktopEntryName();
 325     QString err;
 326     KwBibleManager* backend = service->createInstance<KwBibleManager>(this, QVariantList(), &err);
 327     if (backend)
 328     {
 329       qDebug() << "    Loaded successfully";
 330       if (backend->isRemote())
 331       {
 332         remoteManagers += backend;
 333       }
 334       else
 335       {
 336         managers += backend;
 337       }
 338     }
 339     else
 340     {
 341       qDebug() << "    Could not be loaded: " << err;
 342     }
 343   }
 344   managers += remoteManagers;
 345
 346   // Set up the docker
 347   m_docker = new QDockWidget(i18n("Bible"));
 348   m_docker->setObjectName("dockBible");
 349   QWidget* mainDockWidget = new QWidget(/*m_docker*/);
 350   QVBoxLayout* dockLayout = new QVBoxLayout(mainDockWidget);
 351   m_docker->setWidget(mainDockWidget);
 352
 353   // The tab bar of bible managers
 354   m_managerTabs = new QTabWidget(m_docker);
 355   m_managerTabs->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Preferred);
 356   connect(m_managerTabs, SIGNAL(currentChanged(int)),
 357           this, SLOT(slotBibleChanged()));
 358   dockLayout->addWidget(m_managerTabs);
 359
 360   // Bible navigation combo boxes
 361   QWidget* bibleNavigationWidget = new QWidget(mainDockWidget);
 362   QHBoxLayout* bibleNavigationLayout = new QHBoxLayout(bibleNavigationWidget);
 363   dockLayout->addWidget(bibleNavigationWidget);
 364
 365   m_comboBook = new QComboBox(bibleNavigationWidget);
 366   m_comboChapter = new QComboBox(bibleNavigationWidget);
 367   bibleNavigationLayout->addWidget(m_comboBook);
 368   bibleNavigationLayout->addWidget(m_comboChapter);
 369
 370   // Verse range text box and label
 371   QWidget* verseRangeWidget = new QWidget(mainDockWidget);
 372   QHBoxLayout* verseRangeLayout = new QHBoxLayout(verseRangeWidget);
 373   dockLayout->addWidget(verseRangeWidget);
 374
 375   QLabel* labelRange = new QLabel(i18n("&Verses"), verseRangeWidget);
 376   m_editRange = new QLineEdit(verseRangeWidget);
 377   labelRange->setBuddy(m_editRange);
 378   verseRangeLayout->addWidget(labelRange);
 379   verseRangeLayout->addWidget(m_editRange);
 380
 381   m_textPassage = new QTextEdit(mainDockWidget);
 382   m_textPassage->setTextInteractionFlags(Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard);
 383   dockLayout->addWidget(m_textPassage);
 384
 385   // Toolbar
 386   QToolBar* bibleToolBar = new QToolBar("bibleToolBar");
 387   bibleToolBar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 388   dockLayout->addWidget(bibleToolBar);
 389
 390   m_insertIntoPlaylistAction = new KAction(KIcon("player_playlist"), i18n("Insert Into Playlist"), bibleToolBar);
 391   m_insertIntoPlaylistAction->setEnabled(false);
 392   connect(m_insertIntoPlaylistAction, SIGNAL(triggered(bool)),
 393           this, SLOT(slotInsertIntoPlaylist()));
 394   bibleToolBar->addAction(m_insertIntoPlaylistAction);
 395
 396   m_showNowAction = new KAction(KIcon("player_playlist"), i18n("Show Now"), bibleToolBar);
 397   m_showNowAction->setEnabled(false);
 398   connect(m_showNowAction, SIGNAL(triggered(bool)),
 399           this, SLOT(slotShowNow()));
 400   bibleToolBar->addAction(m_showNowAction);
 401
 402   // Fill out tabs and manager data
 403   foreach (KwBibleManager* manager, managers)
 404   {
 405     QString name = manager->name();
 406     BibleManager mgr;
 407     mgr.manager = manager;
 408
 409     QWidget* tabWidget = new QWidget();
 410     QHBoxLayout* layout = new QHBoxLayout(tabWidget);
 411
 412     mgr.comboBibles = new QComboBox();
 413     connect(mgr.comboBibles, SIGNAL(currentIndexChanged(int)),
 414             this, SLOT(slotBibleChanged()));
 415
 416     // Only fill the module list if the manager is local
 417     // Otherwise we should wait until the user requests it
 418     if (manager->isRemote())
 419     {
 420       mgr.comboBibles->setEnabled(false);
 421
 422       mgr.toolBar = new QToolBar();
 423       KAction* connectToBible = new KAction(KIcon("network-connect"), i18n("Connect to %1", name), mgr.toolBar);
 424       connect(connectToBible, SIGNAL(triggered(bool)),
 425               this, SLOT(slotConnect()));
 426       mgr.toolBar->addAction(connectToBible);
 427       layout->addWidget(mgr.toolBar);
 428
 429       // Toolbar should be as small as possible
 430       QSizePolicy policy;
 431
 432       policy = mgr.toolBar->sizePolicy();
 433       policy.setHorizontalStretch(1);
 434       mgr.toolBar->setSizePolicy(policy);
 435
 436       policy = mgr.comboBibles->sizePolicy();
 437       policy.setHorizontalStretch(10);
 438       mgr.comboBibles->setSizePolicy(policy);
 439     }
 440     else
 441     {
 442       mgr.toolBar = 0;
 443       fillBiblesList(&mgr);
 444     }
 445
 446     layout->addWidget(mgr.comboBibles);
 447
 448     m_managerTabs->addTab(tabWidget, name);
 449     m_managers.push_back(mgr);
 450   }
 451   // Ensure widgets are apropriately modified
 452   connect(m_comboBook, SIGNAL(currentIndexChanged(int)),
 453           this, SLOT(slotBookChanged()));
 454   connect(m_comboChapter, SIGNAL(currentIndexChanged(int)),
 455           this, SLOT(slotVerseRange()));
 456   connect(m_editRange, SIGNAL(textChanged(const QString&)),
 457           this, SLOT(slotVerseRange()));
 458
 459   KwApplication::self()->mainWindow()->addDockWidget(Qt::LeftDockWidgetArea, m_docker);
 460
 461   slotBibleChanged();
 462 }
 463
 464 void KwBiblePlugin::_unload()
 465 {
 466   // Clean up the bible managers.
 467   /// @todo IMPLEMENT!!!
 468   for (int i = 0; i < m_managers.size(); ++i)
 469   {
 470     BibleManager& mgr = m_managers[i];
 471     delete mgr.manager;
 472     mgr.manager = 0;
 473   }
 474   delete m_docker;
 475 }
 476
 477 /*
 478  * Private functions
 479  */
 480
 481 /// Fill up the bibles list for a manager.
 482 void KwBiblePlugin::fillBiblesList(BibleManager* mgr)
 483 {
 484   bool ok;
 485   QStringList languages = mgr->manager->languages(&ok);
 486   mgr->comboBibles->setEnabled(false);
 487   mgr->comboBibles->clear();
 488   mgr->comboBibles->addItem(i18n("-- select a translation --"));
 489   foreach (QString language, languages)
 490   {
 491     QStringList modules = mgr->manager->moduleNamesInLanguage(language);
 492     if (!modules.isEmpty())
 493     {
 494       mgr->comboBibles->addItem(language, QVariant(modules.first()));
 495       foreach (QString module, modules)
 496       {
 497         mgr->comboBibles->addItem("    " + module, QVariant(module));
 498       }
 499     }
 500   }
 501   // re-enable or clear
 502   if (ok && mgr->comboBibles->count() > 1) {
 503     mgr->comboBibles->setEnabled(true);
 504   }
 505   else {
 506     mgr->comboBibles->clear();
 507   }
 508 }
 509