vcs.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 #include "../facebookservice/facebookcredentials.h"
  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 (true/false)
  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 facebook credentials are ready
  98     *
  99     * @param credentials New credentials
 100     */
 101     void credentialsReady(const FacebookCredentials &credentials);
 102
 103     /**
 104     * @brief Public slot, which indicates when http request has been completed
 105     *
 106     * @param reply storage for http reply
 107     */
 108     void requestFinished(QNetworkReply *reply);
 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 Forms a http cookie
 122     *
 123     * @param apiKeyValue application key
 124     * @param expiresValue session expire date&time from Facebook
 125     * @param userValue user id from Facebook
 126     * @param sessionKeyValue session key from Facebook
 127     * @param sessionSecretValue session secret from Facebook
 128     * @param signatureValue md5 generated signature
 129     * @param localeValue used locale
 130     * @return QString formed cookie
 131     */
 132     QString formCookie(const QString &apiKeyValue, QString expiresValue, QString userValue,
 133                        QString sessionKeyValue, QString sessionSecretValue,
 134                        const QString &signatureValue, const QString &localeValue);
 135
 136     /**
 137     * @brief Forms a http url
 138     *
 139     * @param baseUrl Server url
 140     * @param phpScript Server script
 141     * @param urlParameters optional parameters for url
 142     * @return QUrl formed url
 143     */
 144     QUrl formUrl(const QString &baseUrl, const QString &phpScript,
 145                  QString urlParameters = QString());
 146
 147     /**
 148     * @brief Forms url parameters
 149     *
 150     * @param coordinates current coordinates
 151     * @param status optional status message
 152     * @param publish optional publish location on Facebook wall (true/false)
 153     * @return QString
 154     */
 155     QString formUrlParameters(const GeoCoordinate &coordinates, QString status = QString(),
 156                               QString publish = QString());
 157
 158     /**
 159     * @brief Parses user and friend data from JSON string
 160     *
 161     * @param jsonReply JSON string
 162     */
 163     void parseUserData(const QByteArray &jsonReply);
 164
 165     /**
 166     * @brief Sends http request
 167     *
 168     * @param url destination
 169     * @param cookieType type of the cookie
 170     * @param cookie http cookie
 171     */
 172     void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
 173
 174 private slots:
 175
 176     /**
 177     * @brief Slot for received images
 178     *
 179     * @param url Image url
 180     * @param image Received image
 181     */
 182     void imageReceived(const QUrl &url, const QPixmap &image);
 183
 184 /*******************************************************************************
 185  * SIGNALS
 186  ******************************************************************************/
 187
 188 signals:
 189
 190     /**
 191     * @brief Signals error
 192     *
 193     * @param context error context
 194     * @param error error code
 195     */
 196     void error(const int context, const int error);
 197
 198     /**
 199     * @brief Signal for image fetching
 200     *
 201     * @param url Image url
 202     */
 203     void fetchImage(const QUrl &url);
 204
 205     /**
 206     * @brief Signals when user's/friend's image is downloaded
 207     *
 208     * @param user Instance of user/friend
 209     */
 210     void imageReady(User *user);
 211
 212     /**
 213     * @brief Signals when address data is retrieved
 214     *
 215     * @param address Street address
 216     */
 217     void reverseGeoReady(const QString &address);
 218
 219     /**
 220     * @brief Signals when updateLocation request finished successfully
 221     *
 222     */
 223     void updateWasSuccessful();
 224
 225     /**
 226     * @brief Signals when user data is retrieved
 227     *
 228     * @param user instance of user
 229     * @param friendList list of friends
 230     */
 231     void userDataChanged(User *user, QList<User *> &friendList);
 232
 233 /*******************************************************************************
 234  * DATA MEMBERS
 235  ******************************************************************************/
 236
 237 private:
 238
 239     bool m_defaultImage;    ///< Indicates if some of the friends/user doesn't have a image
 240
 241     QList<QNetworkReply *> m_currentRequests;   ///< List of current http requests
 242     QList<User *> m_friendsList;                ///< List of friends(User)
 243
 244     NetworkAccessManager *m_networkManager;    ///< Pointer to QNetworkAccessManager
 245
 246     FacebookCredentials m_credentials;          ///< handle for FacebookCredentials
 247     ImageFetcher *m_imageFetcher;               ///< Instance of the image fetcher
 248     User *m_user;                               ///< Pointer to User
 249 };
 250
 251 #endif // SITUARESERVICE_H