kworship/bible/biblegateway/KwBibleManagerBibleGateway.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 KwBibleManagerBibleGateway.cpp
  22  * @brief A bible manager for BibleGateway.com.
  23  * @author James Hogan <james@albanarts.com>
  24  */
  25
  26 #include "KwBibleManagerBibleGateway.h"
  27 #include "KwBibleModuleBibleGateway.h"
  28
  29 #include <KIO/NetAccess>
  30 #include <KMessageBox>
  31 #include <KGenericFactory>
  32
  33 #include <QFile>
  34 #include <QDomDocument>
  35 #include <QDomElement>
  36 #include <QDomNodeList>
  37
  38 KW_REGISTER_BIBLE_MANAGER(KwBibleManagerBibleGateway)
  39
  40 K_EXPORT_COMPONENT_FACTORY( kworship_bible_biblegateway, KGenericFactory<KwBibleManagerBibleGateway>("kworship_bible_biblegateway") )
  41
  42 /*
  43  * Constructors + destructor
  44  */
  45
  46 /// Default constructor.
  47 KwBibleManagerBibleGateway::KwBibleManagerBibleGateway(QObject* parent, const QStringList& params)
  48 : KwBibleManager(parent, params)
  49 , m_cached(false)
  50 , m_languages()
  51 , m_versionsById()
  52 , m_versionsByName()
  53 , m_versionsByLanguage()
  54 {
  55   registerManager();
  56 }
  57
  58 /// Destructor.
  59 KwBibleManagerBibleGateway::~KwBibleManagerBibleGateway()
  60 {
  61   foreach (Version* version, m_versionsById)
  62   {
  63     delete version->module;
  64     delete version;
  65   }
  66 }
  67
  68 /*
  69  * Main interface
  70  */
  71
  72 QString KwBibleManagerBibleGateway::name() const
  73 {
  74   return "BibleGateway.com";
  75 }
  76
  77 bool KwBibleManagerBibleGateway::isRemote() const
  78 {
  79   return true;
  80 }
  81
  82 KwBibleModule* KwBibleManagerBibleGateway::module(const QString& name)
  83 {
  84   QHash<QString, Version*>::iterator it = m_versionsByName.find(name);
  85   Version* version = 0;
  86   // Does the module with this name exist?
  87   if (it != m_versionsByName.end())
  88   {
  89     version = *it;
  90   }
  91   // Otherwise perhaps its a language
  92   else
  93   {
  94     int langId = m_languages.indexOf(name);
  95     if (-1 != langId)
  96     {
  97       // Just get the first module of this language
  98       const QList<int>& moduleIds = m_versionsByLanguage[langId];
  99       if (!moduleIds.isEmpty())
 100       {
 101         int id = moduleIds.first();
 102         version = m_versionsById[id];
 103       }
 104     }
 105   }
 106   if (0 != version)
 107   {
 108     if (0 == version->module)
 109     {
 110       version->module = new KwBibleModuleBibleGateway(version->id);
 111     }
 112     return version->module;
 113   }
 114   else
 115   {
 116     return 0;
 117   }
 118 }
 119
 120 QStringList KwBibleManagerBibleGateway::moduleNames()
 121 {
 122   ensureCached();
 123   return m_versionsByName.keys();
 124 }
 125
 126 QStringList KwBibleManagerBibleGateway::moduleNamesInLanguage(const QString& lang)
 127 {
 128   ensureCached();
 129   int languageId = m_languages.indexOf(lang);
 130   QStringList names;
 131   if (languageId >= 0)
 132   {
 133     const QList<int>& moduleIds = m_versionsByLanguage[languageId];
 134     foreach (int id, moduleIds)
 135     {
 136       names << m_versionsById[id]->name;
 137     }
 138   }
 139   return names;
 140 }
 141
 142 QStringList KwBibleManagerBibleGateway::languages()
 143 {
 144   ensureCached();
 145   return m_languages;
 146 }
 147
 148 /*
 149  * Private functions
 150  */
 151
 152 /// Ensure the version information is cached.
 153 void KwBibleManagerBibleGateway::ensureCached()
 154 {
 155   if (!m_cached)
 156   {
 157     QString tmpFile;
 158     if (KIO::NetAccess::download(KUrl("http://www.biblegateway.com/"), tmpFile, 0))
 159     {
 160       QFile file(tmpFile);
 161       if (file.open(QFile::ReadOnly | QFile::Text))
 162       {
 163         QByteArray rawPage = file.readAll();
 164         file.close();
 165         /// @todo Convert to use KDE DOM as its a bit more flexible of invalid XML
 166         QString page = QString::fromUtf8(rawPage);
 167         QRegExp rx("<select\\s+name=\"qs_version\">.*</select>");
 168         if (-1 != rx.indexIn(page))
 169         {
 170           QDomDocument dom;
 171           if (dom.setContent(rx.cap(), false))
 172           {
 173             // Go through all the options (languages and versions)
 174             int langId = -1;
 175             QList<int>* langMods = 0;
 176             QDomNodeList options = dom.elementsByTagName("option");
 177             for (int i = 0; i < options.count(); ++i)
 178             {
 179               QDomElement el = options.at(i).toElement();
 180               if (!el.isNull())
 181               {
 182                 // Its either a language (with class="lang") or a version
 183                 QString className = el.attribute("class");
 184                 QString text = el.text();
 185                 if (className == "lang")
 186                 {
 187                   m_languages << text;
 188                   ++langId;
 189                   langMods = &m_versionsByLanguage[langId];
 190                 }
 191                 else if (langId >= 0)
 192                 {
 193                   bool ok;
 194                   int versionId = el.attribute("value").toInt(&ok);
 195                   if (ok)
 196                   {
 197                     // Ensure there is none with this id already
 198                     QHash<int, Version*>::const_iterator it = m_versionsById.constFind(versionId);
 199                     if (it == m_versionsById.constEnd())
 200                     {
 201                       Version* version = new Version;
 202                       version->name = text;
 203                       version->id = versionId;
 204                       version->module = 0;
 205                       m_versionsById[versionId] = version;
 206                       m_versionsByName[text] = version;
 207                       *langMods << versionId;
 208                     }
 209                   }
 210                 }
 211               }
 212             }
 213             m_cached = true;
 214           }
 215         }
 216       }
 217
 218       KIO::NetAccess::removeTempFile(tmpFile);
 219     }
 220     else
 221     {
 222       KMessageBox::error(0, KIO::NetAccess::lastErrorString());
 223     }
 224   }
 225 }
 226
 227 /// Clear all modules.
 228 void KwBibleManagerBibleGateway::clear()
 229 {
 230   if (m_cached)
 231   {
 232     foreach (Version* version, m_versionsById)
 233     {
 234       delete version->module;
 235       delete version;
 236     }
 237     m_cached = false;
 238     m_languages.clear();
 239     m_versionsById.clear();
 240     m_versionsByName.clear();
 241     m_versionsByLanguage.clear();
 242   }
 243 }
 244