workspace/plasma/dataengines/weather/ions/ion_envcan.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Shawn Starr <shawn.starr@rogers.com>            *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA          *
  18  ***************************************************************************/
  19
  20 /* Ion for Environment Canada XML data */
  21
  22 #ifndef _ION_ENVCAN_H_
  23 #define _ION_ENVCAN_H_
  24
  25 #include <QtXml/QXmlStreamReader>
  26 #include <QtCore/QStringList>
  27 #include <QDebug>
  28 #include <kurl.h>
  29 #include <kio/job.h>
  30 #include <kio/scheduler.h>
  31 #include <kdemacros.h>
  32 #include <plasma/dataengine.h>
  33 #include "ion.h"
  34 #include "formulas.h"
  35
  36 class WeatherData
  37 {
  38
  39 public:
  40     // Warning info, can have more than one, especially in Canada, eh? :)
  41     struct WarningInfo {
  42         QString url;
  43         QString type;
  44         QString priority;
  45         QString description;
  46         QString timestamp;
  47     };
  48
  49     // Five day forecast
  50     struct ForecastInfo {
  51         QString forecastPeriod;
  52         QString forecastSummary;
  53         QString shortForecast;
  54
  55         QString forecastTempHigh;
  56         QString forecastTempLow;
  57         QString popPrecent;
  58         QString windForecast;
  59
  60         QString precipForecast;
  61         QString precipType;
  62         QString precipTotalExpected;
  63         int forecastHumidity;
  64     };
  65
  66     QString countryName;
  67     QString longTerritoryName;
  68     QString shortTerritoryName;
  69     QString cityName;
  70     QString regionName;
  71     QString stationID;
  72
  73     // Current observation information.
  74     QString obsTimestamp;
  75     QString condition;
  76     QString temperature;
  77     QString dewpoint;
  78
  79     // In winter windchill, in summer, humidex
  80     QString comforttemp;
  81
  82     float pressure;
  83     QString pressureTendency;
  84
  85     float visibility;
  86     QString humidity;
  87
  88     QString windSpeed;
  89     QString windGust;
  90     QString windDirection;
  91
  92     QVector <WeatherData::WarningInfo *> warnings;
  93
  94     QString normalHigh;
  95     QString normalLow;
  96
  97     QString forecastTimestamp;
  98
  99     QString UVIndex;
 100     QString UVRating;
 101
 102     // 5 day Forecast
 103     QVector <WeatherData::ForecastInfo *> forecasts;
 104
 105     // Historical data from previous day.
 106     QString prevHigh;
 107     QString prevLow;
 108     QString prevPrecipType;
 109     QString prevPrecipTotal;
 110
 111     // Almanac info
 112     QString sunriseTimestamp;
 113     QString sunsetTimestamp;
 114     QString moonriseTimestamp;
 115     QString moonsetTimestamp;
 116
 117     // Historical Records
 118     float recordHigh;
 119     float recordLow;
 120     float recordRain;
 121     float recordSnow;
 122 };
 123
 124 class KDE_EXPORT EnvCanadaIon : public IonInterface
 125 {
 126     Q_OBJECT
 127
 128 public:
 129     EnvCanadaIon(QObject *parent, const QVariantList &args);
 130     ~EnvCanadaIon();
 131     void init();  // Setup the city location, fetching the correct URL name.
 132     bool updateIonSource(const QString& source); // Sync data source with Applet
 133
 134     bool metricUnit(void);
 135     bool timezone(void);
 136     void setMeasureUnit(const QString& unit);
 137     void setTimezoneFormat(const QString& tz);
 138
 139     void updateWeather(const QString& source);
 140
 141     static const int MAX_WARNINGS = 4;
 142
 143 protected slots:
 144     void setup_slotDataArrived(KIO::Job *, const QByteArray &);
 145     void setup_slotJobFinished(KJob *);
 146
 147     void slotDataArrived(KIO::Job *, const QByteArray &);
 148     void slotJobFinished(KJob *);
 149
 150 private:
 151     /* Environment Canada Methods - Internal for Ion */
 152
 153     // Place information
 154     QString country(const QString& source);
 155     QString territory(const QString& source);
 156     QString city(const QString& source);
 157     QString region(const QString& source);
 158     QString station(const QString& source);
 159
 160     // Current Conditions Weather info
 161     QString observationTime(const QString& source);
 162     QMap<QString, QString> warnings(const QString& source);
 163     QString condition(const QString& source);
 164     QMap<QString, QString> temperature(const QString& source);
 165     QString dewpoint(const QString& source);
 166     QString humidity(const QString& source);
 167     QMap<QString, QString> visibility(const QString& source);
 168     QMap<QString, QString> pressure(const QString& source);
 169     QMap<QString, QString> wind(const QString& source);
 170     QMap<QString, QString> regionalTemperatures(const QString& source);
 171     QMap<QString, QString> uvIndex(const QString& source);
 172     QVector<QString> forecasts(const QString& source);
 173     QMap<QString, QString> yesterdayWeather(const QString& source);
 174     QMap<QString, QString> sunriseSet(const QString& source);
 175     QMap<QString, QString> moonriseSet(const QString& source);
 176     QMap<QString, QString> weatherRecords(const QString& source);
 177
 178     // Load and Parse the place XML listing
 179     void getXMLSetup(void);
 180     bool readXMLSetup(void);
 181
 182     // Load and parse the specific place(s)
 183     void getXMLData(const QString& source);
 184     bool readXMLData(const QString& source, QXmlStreamReader& xml);
 185
 186     // Check if place specified is valid or not
 187     QStringList validate(const QString& source) const;
 188
 189     // Catchall for unknown XML tags
 190     void parseUnknownElement(QXmlStreamReader& xml);
 191
 192     // Parse weather XML data
 193     WeatherData parseWeatherSite(WeatherData& data, QXmlStreamReader& xml);
 194     void parseDateTime(WeatherData& data, QXmlStreamReader& xml, WeatherData::WarningInfo* warning = NULL);
 195     void parseLocations(WeatherData& data, QXmlStreamReader& xml);
 196     void parseConditions(WeatherData& data, QXmlStreamReader& xml);
 197     void parseWarnings(WeatherData& data, QXmlStreamReader& xml);
 198     void parseWindInfo(WeatherData& data, QXmlStreamReader& xml);
 199     void parseWeatherForecast(WeatherData& data, QXmlStreamReader& xml);
 200     void parseRegionalNormals(WeatherData& data, QXmlStreamReader& xml);
 201     void parseForecast(WeatherData& data, QXmlStreamReader& xml, WeatherData::ForecastInfo* forecast);
 202     void parseShortForecast(WeatherData::ForecastInfo* forecast, QXmlStreamReader& xml);
 203     void parseForecastTemperatures(WeatherData::ForecastInfo* forecast, QXmlStreamReader& xml);
 204     void parseWindForecast(WeatherData::ForecastInfo* forecast, QXmlStreamReader& xml);
 205     void parsePrecipitationForecast(WeatherData::ForecastInfo* forecast, QXmlStreamReader& xml);
 206     void parsePrecipTotals(WeatherData::ForecastInfo* forecast, QXmlStreamReader& xml);
 207     void parseUVIndex(WeatherData& data, QXmlStreamReader& xml);
 208     void parseYesterdayWeather(WeatherData& data, QXmlStreamReader& xml);
 209     void parseAstronomicals(WeatherData& data, QXmlStreamReader& xml);
 210     void parseWeatherRecords(WeatherData& data, QXmlStreamReader& xml);
 211
 212 private:
 213     class Private;
 214     Private *const d;
 215 };
 216
 217 K_EXPORT_PLASMA_ION(envcan, EnvCanadaIon)
 218
 219 #endif