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 credentials New credentials
102 void credentialsReady(const FacebookCredentials &credentials);
107 * @brief Forms a http url
109 * @param baseUrl Server url
110 * @param phpScript Server script
111 * @param urlParameters optional parameters for url
112 * @return QUrl formed url
114 QUrl formUrl(const QString &baseUrl, const QString &phpScript, QString urlParameters = 0);
117 * @brief Forms url parameters
119 * @param coordinates current coordinates
120 * @param status optional status message
121 * @param publish optional publish location on Facebook wall (true/false)
124 QString formUrlParameters(const QPointF &coordinates, QString status = 0, QString publish = 0);
127 * @brief Parses user and friend data from JSON string
129 * @param jsonReply JSON string
131 void parseUserData(const QByteArray &jsonReply);
134 * @brief Sends http request
136 * @param url destination
137 * @param cookieType type of the cookie
138 * @param cookie http cookie
140 void sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie);
143 * @brief Requests ImageFetcher if user/friend has a profile image
144 * uses members: m_user and m_friendsList
147 void addProfileImages();
152 * @brief Slot for received images
154 * @param url Image url
155 * @param image Received image
157 void imageReceived(const QUrl &url, const QPixmap &image);
159 /*******************************************************************************
161 ******************************************************************************/
166 * @brief Signals error
168 * @param error error message
170 void error(const QString &error);
173 * @brief Signal for image fetching
175 * @param url Image url
177 void fetchImage(const QUrl &url);
180 * @brief Signals when address data is retrieved
182 * @param address Street address
184 void reverseGeoReady(const QString &address);
187 * @brief Signals when updateLocation request finished successfully
190 void updateWasSuccessful();
193 * @brief Signals when user data is retrieved
195 * @param user instance of user
196 * @param friendList list of friends
198 void userDataChanged(User *user, QList<User *> &friendList);
200 /*******************************************************************************
202 ******************************************************************************/
206 FacebookCredentials m_credentials; ///< handle for FacebookCredentials
207 QList<QNetworkReply *> m_currentRequests; ///< List of current http requests
208 QNetworkAccessManager *m_networkManager; ///< Pointer to QNetworkAccessManager
209 ImageFetcher *m_imageFetcher; ///< Instance of the image fetcher
211 User *m_user; ///< Pointer to User
212 QList<User *> m_friendsList; ///< List of friends(User)
213 int m_visited; ///< Indicates number of friends with profile images
214 int m_nbrOfImages; ///< Indicates number of friends whose profile images have been downloaded
215 bool m_defaultImage; ///< Indicates if some of the friends or the user does not have a profile image
218 #endif // SITUARESERVICE_H