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 QNetworkAccessManager;
  32 class QNetworkReply;
  33 class QNetworkRequest;
  34 class QPointF;
  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 QPointF &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 QPointF &coordinates, const QString &status, const bool &publish);
  87
  88 public slots:
  89
  90     /**
  91     * @brief Public slot, which indicates when http request has been completed
  92     *
  93     * @param reply storage for http reply
  94     */
  95     void requestFinished(QNetworkReply *reply);
  96
  97     /**
  98     * @brief Public slot, which indicates when facebook credentials are ready
  99     *
 100     * @param credentials New credentials
 101     */
 102     void credentialsReady(const FacebookCredentials &credentials);
 103
 104 private:
 105
 106     /**
 107     * @brief Forms a http cookie
 108     *
 109     * @param apiKeyValue application key
 110     * @param expiresValue session expire date&time from Facebook
 111     * @param userValue user id from Facebook
 112     * @param sessionKeyValue session key from Facebook
 113     * @param sessionSecretValue session secret from Facebook
 114     * @param signatureValue md5 generated signature
 115     * @param localeValue used locale
 116     * @return QString formed cookie
 117     */
 118     QString formCookie(const QString &apiKeyValue, QString expiresValue, QString userValue,
 119                        QString sessionKeyValue, QString sessionSecretValue,
 120                        const QString &signatureValue, const QString &localeValue);
 121
 122     /**
 123     * @brief Forms a http url
 124     *
 125     * @param baseUrl Server url
 126     * @param phpScript Server script
 127     * @param urlParameters optional parameters for url
 128     * @return QUrl formed url
 129     */
 130     QUrl formUrl(const QString &baseUrl, const QString &phpScript, QString urlParameters = 0);
 131
 132     /**
 133     * @brief Forms url parameters
 134     *
 135     * @param coordinates current coordinates
 136     * @param status optional status message
 137     * @param publish optional publish location on Facebook wall (true/false)
 138     * @return QString
 139     */
 140     QString formUrlParameters(const QPointF &coordinates, QString status = 0, QString publish = 0);
 141
 142     /**
 143     * @brief Parses user and friend data from JSON string
 144     *
 145     * @param jsonReply JSON string
 146     */
 147     void parseUserData(const QByteArray &jsonReply);
 148
 149     /**
 150     * @brief Sends http request
 151     *
 152     * @param url destination
 153     * @param cookieType type of the cookie
 154     * @param cookie http cookie
 155     */
 156     void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
 157
 158     /**
 159     * @brief Requests ImageFetcher if user/friend has a profile image
 160     *        uses members: m_user and m_friendsList
 161     *
 162     */
 163     void addProfileImages();
 164
 165 private slots:
 166
 167     /**
 168     * @brief Slot for received images
 169     *
 170     * @param url Image url
 171     * @param image Received image
 172     */
 173     void imageReceived(const QUrl &url, const QPixmap &image);
 174
 175 /*******************************************************************************
 176  * SIGNALS
 177  ******************************************************************************/
 178
 179 signals:
 180
 181     /**
 182     * @brief Signals error
 183     *
 184     * @param error error message
 185     */
 186     void error(const QString &error);
 187
 188     /**
 189     * @brief Signal for image fetching
 190     *
 191     * @param url Image url
 192     */
 193     void fetchImage(const QUrl &url);
 194
 195     /**
 196     * @brief Signals when address data is retrieved
 197     *
 198     * @param address Street address
 199     */
 200     void reverseGeoReady(const QString &address);
 201
 202     /**
 203     * @brief Signals when updateLocation request finished successfully
 204     *
 205     */
 206     void updateWasSuccessful();
 207
 208     /**
 209     * @brief Signals when user data is retrieved
 210     *
 211     * @param user instance of user
 212     * @param friendList list of friends
 213     */
 214     void userDataChanged(User *user, QList<User *> &friendList);
 215
 216 /*******************************************************************************
 217  * DATA MEMBERS
 218  ******************************************************************************/
 219
 220 private:
 221
 222     FacebookCredentials m_credentials; ///< handle for FacebookCredentials
 223     QList<QNetworkReply *> m_currentRequests; ///< List of current http requests
 224     QNetworkAccessManager *m_networkManager; ///< Pointer to QNetworkAccessManager
 225     ImageFetcher *m_imageFetcher; ///< Instance of the image fetcher
 226
 227     User *m_user; ///< Pointer to User
 228     QList<User *> m_friendsList; ///< List of friends(User)
 229     int m_visited; ///< Indicates number of friends with profile images
 230     int m_nbrOfImages; ///< Indicates number of friends whose profile images have been downloaded
 231     bool m_defaultImage; ///< Indicates if some of the friends or the user does not have a profile image
 232 };
 233
 234 #endif // SITUARESERVICE_H