git.maemo.org Git - situare/blob - src/situareservice/situareservice.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5       Henri Lampela - henri.lampela@ixonos.com
   6
   7    Situare is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as published by the Free Software Foundation.
  10
  11    Situare is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Situare; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  19    USA.
  20 */
  21
  22
  23 #ifndef SITUARESERVICE_H
  24 #define SITUARESERVICE_H
  25
  26 #include <QObject>
  27
  28 #include "../user/user.h"
  29 #include "imagefetcher.h"
  30
  31 class NetworkAccessManager;
  32 class QNetworkReply;
  33 class QNetworkRequest;
  34 class GeoCoordinate;
  35 class QUrl;
  36
  37 /**
  38 * @brief SituareService class for communicating with Situare server
  39 *
  40 * @author Henri Lampela
  41 * @class SituareService situareservice.h "situareservice/situareservice.h"
  42 */
  43 class SituareService : public QObject
  44 {
  45     Q_OBJECT
  46
  47 public:
  48
  49     /**
  50     * @brief Default constructor
  51     *
  52     * @param parent instance of parent
  53     */
  54     SituareService(QObject *parent = 0);
  55
  56     /**
  57     * @brief Destructor
  58     *
  59     */
  60     ~SituareService();
  61
  62 /*******************************************************************************
  63  * MEMBER FUNCTIONS AND SLOTS
  64  ******************************************************************************/
  65
  66     /**
  67     * @brief Retrieves location user and friends information from Situare server
  68     *
  69     */
  70     void fetchLocations();
  71
  72     /**
  73     * @brief Translates coordinates to street address via Situare server
  74     *
  75     * @param coordinates coordinates to be translated
  76     */
  77     void reverseGeo(const GeoCoordinate &coordinates);
  78
  79     /**
  80     * @brief Updates location to the Situare server
  81     *
  82     * @param coordinates current cordinates
  83     * @param status message
  84     * @param publish publish location on Facebook wall
  85     */
  86     void updateLocation(const GeoCoordinate &coordinates, const QString &status, const bool &publish);
  87
  88 public slots:
  89
  90     /**
  91     * @brief Public slot, to clear user data
  92     *
  93     */
  94     void clearUserData();
  95
  96     /**
  97     * @brief Public slot, which indicates when http request has been completed
  98     *
  99     * @param reply storage for http reply
 100     */
 101     void requestFinished(QNetworkReply *reply);
 102
 103     /**
 104       * @brief Update session data
 105       *
 106       * @param session New session data
 107       */
 108     void updateSession(const QString &session);
 109
 110 private:
 111
 112     /**
 113     * @brief Requests ImageFetcher if user/friend has a profile image
 114     *        uses members: m_user and m_friendsList
 115     *
 116     * @param imageUrlList list of image urls
 117     */
 118     void addProfileImages(const QList<QUrl> &imageUrlList);
 119
 120     /**
 121       * @brief Append access_token and other session data to the reques url
 122       *
 123       * @param[in,out] requestUrl Request URL with other request parameters and ending to &
 124       */
 125     void appendAccessToken(QString &requestUrl);
 126
 127     /**
 128       * @brief Convert coordinate value in degrees (double) to string with enough precision
 129       *
 130       * @param degrees Coordinate value in degrees
 131       * @returns Coordinate value as string
 132       */
 133     QString degreesToString(double degrees);
 134
 135     /**
 136     * @brief Forms a http cookie
 137     *
 138     * @param apiKeyValue application key
 139     * @param expiresValue session expire date&time from Facebook
 140     * @param userValue user id from Facebook
 141     * @param sessionKeyValue session key from Facebook
 142     * @param sessionSecretValue session secret from Facebook
 143     * @param signatureValue md5 generated signature
 144     * @param localeValue used locale
 145     * @return QString formed cookie
 146     */
 147     QString formCookie(const QString &apiKeyValue, QString expiresValue, QString userValue,
 148                        QString sessionKeyValue, QString sessionSecretValue,
 149                        const QString &signatureValue, const QString &localeValue);
 150
 151     /**
 152     * @brief Forms a http url
 153     *
 154     * @param baseUrl Server url
 155     * @param phpScript Server script
 156     * @param urlParameters optional parameters for url
 157     * @return QUrl formed url
 158     */
 159     QUrl formUrl(const QString &baseUrl, const QString &phpScript,
 160                  QString urlParameters = QString());
 161
 162     /**
 163     * @brief Forms url parameters
 164     *
 165     * @param coordinates current coordinates
 166     * @param status optional status message
 167     * @param publish optional publish location on Facebook wall
 168     * @return QString
 169     */
 170     QString formUrlParameters(const GeoCoordinate &coordinates, QString status = QString(),
 171                               bool publish = false);
 172
 173     /**
 174     * @brief Parses user and friend data from JSON string
 175     *
 176     * @param jsonReply JSON string
 177     */
 178     void parseUserData(const QByteArray &jsonReply);
 179
 180     /**
 181     * @brief Sends http request
 182     *
 183     * @param url destination
 184     * @param cookieType type of the cookie
 185     * @param cookie http cookie
 186     */
 187     void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
 188
 189     /**
 190       * @brief Build and send request
 191       *
 192       * Appends script pathname and parameters to the server base URL. Access token is appended and
 193       * the request sent if the access token is available, otherwise the request is queued.
 194       *
 195       * @param script Requested script pathname
 196       * @param parameters Hash containing parameter key/value pairs.
 197       */
 198     void buildRequest(const QString &script, const QHash<QString,QString> &parameters);
 199
 200     /**
 201       * @brief Send request
 202       *
 203       * @param requestUrl Request URL containing also all parameters
 204       */
 205     void sendRequest(const QString &requestUrl);
 206
 207 private slots:
 208     /**
 209     * @brief Slot for received images
 210     *
 211     * @param url Image url
 212     * @param image Received image
 213     */
 214     void imageReceived(const QUrl &url, const QPixmap &image);
 215
 216 /*******************************************************************************
 217  * SIGNALS
 218  ******************************************************************************/
 219
 220 signals:
 221
 222     /**
 223     * @brief Signals error
 224     *
 225     * @param context error context
 226     * @param error error code
 227     */
 228     void error(const int context, const int error);
 229
 230     /**
 231     * @brief Signal for image fetching
 232     *
 233     * @param url Image url
 234     */
 235     void fetchImage(const QUrl &url);
 236
 237     /**
 238     * @brief Signals when user's/friend's image is downloaded
 239     *
 240     * @param user Instance of user/friend
 241     */
 242     void imageReady(User *user);
 243
 244     /**
 245     * @brief Signals when address data is retrieved
 246     *
 247     * @param address Street address
 248     */
 249     void reverseGeoReady(const QString &address);
 250
 251     /**
 252     * @brief Signals when updateLocation request finished successfully
 253     *
 254     */
 255     void updateWasSuccessful();
 256
 257     /**
 258     * @brief Signals when user data is retrieved
 259     *
 260     * @param user instance of user
 261     * @param friendList list of friends
 262     */
 263     void userDataChanged(User *user, QList<User *> &friendList);
 264
 265 /*******************************************************************************
 266  * DATA MEMBERS
 267  ******************************************************************************/
 268
 269 private:
 270
 271     bool m_defaultImage;    ///< Indicates if some of the friends/user doesn't have a image
 272
 273     QList<QNetworkReply *> m_currentRequests;       ///< List of current http requests
 274     QList<QString> m_requestsWaitingAccessToken;    ///< Requests waiting for access_token
 275     QList<User *> m_friendsList;                    ///< List of friends(User)
 276
 277     QString m_session;                          ///< Session data
 278
 279     NetworkAccessManager *m_networkManager;     ///< Pointer to QNetworkAccessManager
 280
 281     ImageFetcher *m_imageFetcher;               ///< Instance of the image fetcher
 282     User *m_user;                               ///< Pointer to User
 283 };
 284
 285 #endif // SITUARESERVICE_H