2 Situare - A location system for Facebook
3 Copyright (C) 2010 Ixonos Plc. Authors:
5 Henri Lampela - henri.lampela@ixonos.com
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.
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.
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,
23 #ifndef SITUARESERVICE_H
24 #define SITUARESERVICE_H
27 #include "../facebookservice/facebookcredentials.h"
28 #include "../user/user.h"
29 #include "imagefetcher.h"
31 class NetworkAccessManager;
33 class QNetworkRequest;
38 * @brief SituareService class for communicating with Situare server
40 * @author Henri Lampela
41 * @class SituareService situareservice.h "situareservice/situareservice.h"
43 class SituareService : public QObject
50 * @brief Default constructor
52 * @param parent instance of parent
54 SituareService(QObject *parent = 0);
62 /*******************************************************************************
63 * MEMBER FUNCTIONS AND SLOTS
64 ******************************************************************************/
67 * @brief Retrieves location user and friends information from Situare server
70 void fetchLocations();
73 * @brief Translates coordinates to street address via Situare server
75 * @param coordinates coordinates to be translated
77 void reverseGeo(const GeoCoordinate &coordinates);
80 * @brief Updates location to the Situare server
82 * @param coordinates current cordinates
83 * @param status message
84 * @param publish publish location on Facebook wall
86 void updateLocation(const GeoCoordinate &coordinates, const QString &status, const bool &publish);
91 * @brief Public slot, to clear user data
97 * @brief Public slot, which indicates when facebook credentials are ready
99 * @param credentials New credentials
101 void credentialsReady(const FacebookCredentials &credentials);
104 * @brief Public slot, which indicates when http request has been completed
106 * @param reply storage for http reply
108 void requestFinished(QNetworkReply *reply);
110 void updateAccessToken(const QString &accessToken);
115 * @brief Requests ImageFetcher if user/friend has a profile image
116 * uses members: m_user and m_friendsList
118 * @param imageUrlList list of image urls
120 void addProfileImages(const QList<QUrl> &imageUrlList);
122 void appendAccessToken(QString &requestUrl);
125 * @brief Forms a http cookie
127 * @param apiKeyValue application key
128 * @param expiresValue session expire date&time from Facebook
129 * @param userValue user id from Facebook
130 * @param sessionKeyValue session key from Facebook
131 * @param sessionSecretValue session secret from Facebook
132 * @param signatureValue md5 generated signature
133 * @param localeValue used locale
134 * @return QString formed cookie
136 QString formCookie(const QString &apiKeyValue, QString expiresValue, QString userValue,
137 QString sessionKeyValue, QString sessionSecretValue,
138 const QString &signatureValue, const QString &localeValue);
141 * @brief Forms a http url
143 * @param baseUrl Server url
144 * @param phpScript Server script
145 * @param urlParameters optional parameters for url
146 * @return QUrl formed url
148 QUrl formUrl(const QString &baseUrl, const QString &phpScript,
149 QString urlParameters = QString());
152 * @brief Forms url parameters
154 * @param coordinates current coordinates
155 * @param status optional status message
156 * @param publish optional publish location on Facebook wall
159 QString formUrlParameters(const GeoCoordinate &coordinates, QString status = QString(),
160 bool publish = false);
163 * @brief Parses user and friend data from JSON string
165 * @param jsonReply JSON string
167 void parseUserData(const QByteArray &jsonReply);
170 * @brief Sends http request
172 * @param url destination
173 * @param cookieType type of the cookie
174 * @param cookie http cookie
176 void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
179 void buildRequest(const QString &script, const QHash<QString,QString> ¶meters);
181 void sendRequest(const QString &requestUrl);
186 * @brief Slot for received images
188 * @param url Image url
189 * @param image Received image
191 void imageReceived(const QUrl &url, const QPixmap &image);
193 /*******************************************************************************
195 ******************************************************************************/
200 * @brief Signals error
202 * @param context error context
203 * @param error error code
205 void error(const int context, const int error);
208 * @brief Signal for image fetching
210 * @param url Image url
212 void fetchImage(const QUrl &url);
215 * @brief Signals when user's/friend's image is downloaded
217 * @param user Instance of user/friend
219 void imageReady(User *user);
222 * @brief Signals when address data is retrieved
224 * @param address Street address
226 void reverseGeoReady(const QString &address);
229 * @brief Signals when updateLocation request finished successfully
232 void updateWasSuccessful();
235 * @brief Signals when user data is retrieved
237 * @param user instance of user
238 * @param friendList list of friends
240 void userDataChanged(User *user, QList<User *> &friendList);
242 /*******************************************************************************
244 ******************************************************************************/
248 bool m_defaultImage; ///< Indicates if some of the friends/user doesn't have a image
250 QList<QNetworkReply *> m_currentRequests; ///< List of current http requests
251 QList<QString> m_requestsWaitingAccessToken;
252 QList<User *> m_friendsList; ///< List of friends(User)
254 QString m_accessToken;
256 NetworkAccessManager *m_networkManager; ///< Pointer to QNetworkAccessManager
258 FacebookCredentials m_credentials; ///< handle for FacebookCredentials
259 ImageFetcher *m_imageFetcher; ///< Instance of the image fetcher
260 User *m_user; ///< Pointer to User
263 #endif // SITUARESERVICE_H