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 QNetworkAccessManager;
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 QPointF &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 (true/false)
86 void updateLocation(const QPointF &coordinates, const QString &status, const bool &publish);
91 * @brief Public slot, which indicates when http request has been completed
93 * @param reply storage for http reply
95 void requestFinished(QNetworkReply *reply);
98 * @brief Public slot, which indicates when facebook credentials are ready
100 * @param freshLogin Was login done via login dialog
101 * @param credentials New credentials
103 void credentialsReady(bool freshLogin, const FacebookCredentials &credentials);
108 * @brief Forms a http cookie
110 * @param apiKeyValue application key
111 * @param expiresValue session expire date&time from Facebook
112 * @param userValue user id from Facebook
113 * @param sessionKeyValue session key from Facebook
114 * @param sessionSecretValue session secret from Facebook
115 * @param signatureValue md5 generated signature
116 * @param localeValue used locale
117 * @return QString formed cookie
119 QString formCookie(const QString &apiKeyValue, QString expiresValue, QString userValue,
120 QString sessionKeyValue, QString sessionSecretValue,
121 const QString &signatureValue, const QString &localeValue);
124 * @brief Forms a http url
126 * @param baseUrl Server url
127 * @param phpScript Server script
128 * @param urlParameters optional parameters for url
129 * @return QUrl formed url
131 QUrl formUrl(const QString &baseUrl, const QString &phpScript, QString urlParameters = QString());
134 * @brief Forms url parameters
136 * @param coordinates current coordinates
137 * @param status optional status message
138 * @param publish optional publish location on Facebook wall (true/false)
141 QString formUrlParameters(const QPointF &coordinates, QString status = QString(), QString publish = QString());
144 * @brief Parses user and friend data from JSON string
146 * @param jsonReply JSON string
148 void parseUserData(const QByteArray &jsonReply);
151 * @brief Sends http request
153 * @param url destination
154 * @param cookieType type of the cookie
155 * @param cookie http cookie
157 void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
160 * @brief Requests ImageFetcher if user/friend has a profile image
161 * uses members: m_user and m_friendsList
164 void addProfileImages();
169 * @brief Slot for received images
171 * @param url Image url
172 * @param image Received image
174 void imageReceived(const QUrl &url, const QPixmap &image);
176 /*******************************************************************************
178 ******************************************************************************/
183 * @brief Signals error
185 * @param error error message
187 void error(const QString &error);
190 * @brief Signal for image fetching
192 * @param url Image url
194 void fetchImage(const QUrl &url);
197 * @brief Signals when address data is retrieved
199 * @param address Street address
201 void reverseGeoReady(const QString &address);
204 * @brief Signals when updateLocation request finished successfully
207 void updateWasSuccessful();
210 * @brief Signals when user data is retrieved
212 * @param user instance of user
213 * @param friendList list of friends
215 void userDataChanged(User *user, QList<User *> &friendList);
217 /*******************************************************************************
219 ******************************************************************************/
223 FacebookCredentials m_credentials; ///< handle for FacebookCredentials
224 QList<QNetworkReply *> m_currentRequests; ///< List of current http requests
225 QNetworkAccessManager *m_networkManager; ///< Pointer to QNetworkAccessManager
226 ImageFetcher *m_imageFetcher; ///< Instance of the image fetcher
228 User *m_user; ///< Pointer to User
229 QList<User *> m_friendsList; ///< List of friends(User)
230 int m_visited; ///< Indicates number of friends with profile images
231 int m_nbrOfImages; ///< Indicates number of friends whose profile images have been downloaded
232 bool m_defaultImage; ///< Indicates if some of the friends or the user does not have a profile image
235 #endif // SITUARESERVICE_H