workspace/plasma/dataengines/weather/weatherengine.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Shawn Starr <shawn.starr@rogers.com>            *
   3  *   Copyright (C) 2009 by Aaron Seigo <aseigo@kde.org>                    *
   4  *                                                                         *
   5  *   This program 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  *   This program 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 this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA          *
  19  ***************************************************************************/
  20
  21 #include "weatherengine.h"
  22 #include <KServiceTypeTrader>
  23 #include <KDateTime>
  24 #include <KLocale>
  25
  26 #include <Plasma/DataEngineManager>
  27
  28 #include "ions/ion.h"
  29
  30 class WeatherEngine::Private
  31 {
  32 public:
  33     /**
  34      * Get instance of a loaded ion.
  35      * @returns a IonInterface instance of a loaded plugin.
  36      */
  37     IonInterface* ionForSource(const QString& name) {
  38         int offset = name.indexOf('|');
  39
  40         if (offset < 1) {
  41             return NULL;
  42         }
  43
  44         QString ionName = name.left(offset);
  45         return qobject_cast<IonInterface *>(Plasma::DataEngineManager::self()->engine(ionName));
  46     }
  47
  48     /**
  49      * Get plugin name from datasource.
  50      * @returns The plugin name given a datasource.
  51      */
  52     QString ionNameForSource(const QString& source) {
  53         int offset = source.indexOf('|');
  54         if (offset < 1) {
  55             return QString();
  56         }
  57
  58         return QString(source.left(offset));
  59     }
  60
  61     KDateTime m_localTime;
  62     QStringList m_ions;
  63 };
  64
  65 /**
  66  * Loads an ion plugin given a plugin name found via KService.
  67  */
  68 Plasma::DataEngine *WeatherEngine::loadIon(const QString& plugName)
  69 {
  70     KPluginInfo foundPlugin;
  71
  72     foreach (const KPluginInfo &info, Plasma::DataEngineManager::listEngineInfo("weatherengine")) {
  73         if (info.pluginName() == plugName) {
  74             foundPlugin = info;
  75             break;
  76         }
  77     }
  78
  79     if (!foundPlugin.isValid()) {
  80         return NULL;
  81     }
  82
  83     // Load the Ion plugin, store it into a QMap to handle multiple ions.
  84     Plasma::DataEngine *ion = Plasma::DataEngineManager::self()->loadEngine(foundPlugin.pluginName());
  85     ion->setObjectName(plugName);
  86     connect(ion, SIGNAL(sourceAdded(QString)), this, SLOT(newIonSource(QString)));
  87
  88     /* Set system related properties for the ion
  89      * timezone is displaying the time/date in UTC or user's local time
  90      * unit is setting the weather units used, Celsius/Fahrenheit, Kilopascals/Inches of Mercury, etc
  91      */
  92
  93     ion->setProperty("timezone", d->m_localTime.isUtc());
  94     ion->setProperty("unit", KGlobal::locale()->measureSystem());
  95     d->m_ions << plugName;
  96
  97     return ion;
  98 }
  99
 100 /**
 101  * Unload an Ion plugin given a Ion plugin name.
 102  */
 103 void WeatherEngine::unloadIon(const QString &name)
 104 {
 105     Plasma::DataEngineManager::self()->unloadEngine(name);
 106     d->m_ions.removeOne(name);
 107 }
 108
 109 void WeatherEngine::init()
 110 {
 111     // Get the list of available plugins but don't load them
 112     foreach(const KPluginInfo &info, Plasma::DataEngineManager::listEngineInfo("weatherengine")) {
 113         setData("ions", info.pluginName(),
 114                 QString("%1|%2").arg(info.property("Name").toString()).arg(info.pluginName()));
 115     }
 116 }
 117
 118 /**
 119  * SLOT: Get data from a new source
 120  */
 121 void WeatherEngine::newIonSource(const QString& source)
 122 {
 123     IonInterface *ion = qobject_cast<IonInterface*>(sender());
 124
 125     kDebug() << "New Ion Source" << source;
 126     if (!ion) {
 127         return;
 128     }
 129
 130     ion->connectSource(source, this);
 131 }
 132
 133 /**
 134  * SLOT: Remove the datasource from the ion and unload plugin if needed
 135  */
 136 void WeatherEngine::removeIonSource(const QString& source)
 137 {
 138     IonInterface *ion = d->ionForSource(source);
 139     if (ion) {
 140         ion->removeSource(source);
 141         // If plugin has no more sources let's unload the plugin
 142         if (ion->isEmpty()) {
 143             kDebug() << "No more Sources found for this plugin let's unload it!";
 144             unloadIon(d->ionNameForSource(source));
 145         }
 146     }
 147 }
 148
 149 /**
 150  * SLOT: Push out new data to applet
 151  */
 152 void WeatherEngine::dataUpdated(const QString& source, Plasma::DataEngine::Data data)
 153 {
 154     kDebug() << "data updated" << source;
 155     setData(source, data);
 156 }
 157
 158 // Constructor
 159 WeatherEngine::WeatherEngine(QObject *parent, const QVariantList& args)
 160         :  Plasma::DataEngine(parent, args), d(new Private())
 161 {
 162     Q_UNUSED(args)
 163
 164     // Set any local properties for Ion to use
 165     d->m_localTime = KDateTime::currentDateTime(KDateTime::LocalZone);
 166
 167     // Globally notify all plugins to remove their sources (and unload plugin)
 168     connect(this, SIGNAL(sourceRemoved(QString)), this, SLOT(removeIonSource(QString)));
 169 }
 170
 171 // Destructor
 172 WeatherEngine::~WeatherEngine()
 173 {
 174     // Cleanup all private data.
 175     foreach (const QString &ion, d->m_ions) {
 176         Plasma::DataEngineManager::self()->unloadEngine(ion);
 177     }
 178
 179     delete d;
 180 }
 181
 182 /**
 183  * SLOT: Set up each Ion for the first time and get any data
 184  */
 185 bool WeatherEngine::sourceRequestEvent(const QString &source)
 186 {
 187     kDebug() << "sourceRequestEvent()" << source;
 188     Plasma::DataEngine *ion = d->ionForSource(source);
 189
 190     if (!ion) {
 191         kDebug() << "sourceRequestEvent(): No Ion Found, load it up!";
 192         ion = loadIon(d->ionNameForSource(source));
 193         if (!ion) {
 194             return false;
 195         }
 196     }
 197
 198     QByteArray str = source.toLocal8Bit();
 199
 200     ion->connectSource(source, this);
 201     if (!containerForSource(source)) {
 202         // it is an async reply, we need to set up the data anyways
 203         kDebug() << "no item?";
 204         setData(source, Data());
 205     }
 206     return true;
 207 }
 208
 209 /**
 210  * SLOT: update the Applet with new data from all ions loaded.
 211  */
 212 bool WeatherEngine::updateSourceEvent(const QString& source)
 213 {
 214     IonInterface *ion = d->ionForSource(source);
 215
 216     QByteArray str = source.toLocal8Bit();
 217
 218     kDebug() << "updateSourceEvent()";
 219     if (!ion) {
 220         return false;
 221     }
 222
 223     ion->setProperty("timezone", d->m_localTime.isUtc());
 224     ion->setProperty("unit", KGlobal::locale()->measureSystem());
 225
 226     if (ion->updateSourceEvent(source)) {
 227         return true;
 228     } else {
 229         return false;
 230     }
 231 }
 232
 233 #include "weatherengine.moc"