Added network error flag to NetworkReply.
[situare] / src / situareservice / situareservice.cpp
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 #include <QtAlgorithms>
23 #include <QDebug>
24 #include <QtGlobal>
25 #include <QStringList>
26 #include <QPixmap>
27 #include <QNetworkReply>
28 #include "situareservice.h"
29 #include "situarecommon.h"
30 #include "common.h"
31 #include "parser.h"
32 #include "ui/avatarimage.h"
33 #include "network/networkaccessmanager.h"
34
35 SituareService::SituareService(QObject *parent)
36         : QObject(parent),
37         m_user(0)
38 {
39     qDebug() << __PRETTY_FUNCTION__;
40
41     m_networkManager = NetworkAccessManager::instance();
42     connect(m_networkManager, SIGNAL(finished(QNetworkReply*)),
43             this, SLOT(requestFinished(QNetworkReply*)), Qt::QueuedConnection);
44
45     m_imageFetcher = new ImageFetcher(NetworkAccessManager::instance(), this);
46     connect(this, SIGNAL(fetchImage(QUrl)),
47             m_imageFetcher, SLOT(fetchImage(QUrl)));
48     connect(m_imageFetcher, SIGNAL(imageReceived(QUrl,QPixmap)),
49             this, SLOT(imageReceived(QUrl, QPixmap)));
50     connect(m_imageFetcher, SIGNAL(error(int)),
51             this, SIGNAL(error(int)));
52 }
53
54 SituareService::~SituareService()
55 {
56     qDebug() << __PRETTY_FUNCTION__;
57
58     if(m_user) {
59         delete m_user;
60         m_user = 0;
61     }
62
63     qDeleteAll(m_friendsList.begin(), m_friendsList.end());
64     m_friendsList.clear();
65 }
66
67 void SituareService::fetchLocations()
68 {
69     qDebug() << __PRETTY_FUNCTION__;
70
71     QString cookie = formCookie(API_KEY, m_credentials.expires(), m_credentials.userID(),
72                                 m_credentials.sessionKey(), m_credentials.sessionSecret(),
73                                 m_credentials.sig(), EN_LOCALE);
74
75     QUrl url = formUrl(SITUARE_URL, GET_LOCATIONS);
76     sendRequest(url, COOKIE, cookie);
77 }
78
79 void SituareService::reverseGeo(const QPointF &coordinates)
80 {
81     qDebug() << __PRETTY_FUNCTION__;
82
83     QString cookie = formCookie(API_KEY, m_credentials.expires(),m_credentials.userID(),
84                                 m_credentials.sessionKey(), m_credentials.sessionSecret(),
85                                 m_credentials.sig(), EN_LOCALE);
86
87     QString urlParameters = formUrlParameters(coordinates);
88     QUrl url = formUrl(SITUARE_URL, REVERSE_GEO, urlParameters);
89
90     sendRequest(url, COOKIE, cookie);
91 }
92
93 void SituareService::updateLocation(const QPointF &coordinates, const QString &status,
94                                     const bool &publish)
95 {
96     qDebug() << __PRETTY_FUNCTION__;
97
98     QString cookie = formCookie(API_KEY, m_credentials.expires(), m_credentials.userID(),
99                                 m_credentials.sessionKey(), m_credentials.sessionSecret(),
100                                 m_credentials.sig(), EN_LOCALE);
101
102
103     QString publishValue;
104     if(publish) {
105         publishValue = PUBLISH_TRUE;
106     }
107     else {
108         publishValue = PUBLISH_FALSE;
109     }
110     QString urlParameters = formUrlParameters(coordinates, status, publishValue);
111     QUrl url = formUrl(SITUARE_URL, UPDATE_LOCATION, urlParameters);
112
113     sendRequest(url, COOKIE, cookie);
114 }
115
116 QString SituareService::formCookie(const QString &apiKeyValue, QString expiresValue,
117                                    QString userValue, QString sessionKeyValue,
118                                    QString sessionSecretValue, const QString &signatureValue,
119                                    const QString &localeValue)
120 {
121     qDebug() << __PRETTY_FUNCTION__;
122
123     QString cookie;
124     QString apiKey;
125     QString user;
126     QString expires;
127     QString sessionKey;
128     QString sessionSecret;
129     QString locale;
130     QString variable;
131     QString signature = EQUAL_MARK;
132     QStringList variableList;
133
134     signature.append(signatureValue);
135     apiKey.append(apiKeyValue);
136     apiKey.append(UNDERLINE_MARK);
137
138     user.append(USER);
139     user.append(EQUAL_MARK);
140     expires.append(EXPIRES);
141     expires.append(EQUAL_MARK);
142     sessionKey.append(SESSION_KEY);
143     sessionKey.append(EQUAL_MARK);
144     sessionSecret.append(SESSION_SECRET);
145     sessionSecret.append(EQUAL_MARK);
146     locale.append(LOCALE);
147     locale.append(EQUAL_MARK);
148     locale.append(localeValue);
149
150     variableList.append(expires.append(expiresValue.append(BREAK_MARK)));
151     variableList.append(sessionKey.append(sessionKeyValue.append(BREAK_MARK)));
152     variableList.append(user.append(userValue).append(BREAK_MARK));
153     variableList.append(sessionSecret.append(sessionSecretValue.append(BREAK_MARK)));
154
155     cookie.append(BREAK_MARK);
156
157     foreach(variable, variableList) {
158         cookie.append(apiKey);
159         cookie.append(variable);
160     }
161     apiKey.remove(UNDERLINE_MARK);
162     cookie.append(apiKey);
163     cookie.append(signature);
164     cookie.append(BREAK_MARK);
165     cookie.append(locale);
166
167     qDebug() << cookie;
168
169     return cookie;
170 }
171
172 QUrl SituareService::formUrl(const QString &baseUrl, const QString &phpScript,
173                              QString urlParameters)
174 {
175     qDebug() << __PRETTY_FUNCTION__;
176     QString urlString;
177
178     urlString.append(baseUrl);
179     urlString.append(phpScript);
180     if(!urlParameters.isEmpty())
181         urlString.append(urlParameters);
182
183     QUrl url = QUrl(urlString);
184
185     qDebug() << url;
186
187     return url;
188 }
189
190 QString SituareService::formUrlParameters(const QPointF &coordinates, QString status,
191                                           QString publish)
192 {
193     QString parameters;
194
195     parameters.append(QUESTION_MARK);
196     parameters.append(LATITUDE);
197     parameters.append(EQUAL_MARK);
198     parameters.append(QString::number(coordinates.y()));
199     parameters.append(AMBERSAND_MARK);
200     parameters.append(LONGTITUDE);
201     parameters.append(EQUAL_MARK);
202     parameters.append(QString::number(coordinates.x()));
203
204     if(publish.compare(PUBLISH_TRUE) == 0) {
205         parameters.append(AMBERSAND_MARK);
206         parameters.append(PUBLISH);
207         parameters.append(EQUAL_MARK);
208         parameters.append(PUBLISH_TRUE);
209     } else if(publish.compare(PUBLISH_FALSE) == 0) {
210         parameters.append(AMBERSAND_MARK);
211         parameters.append(PUBLISH);
212         parameters.append(EQUAL_MARK);
213         parameters.append(PUBLISH_FALSE);
214     }
215
216     if(!status.isEmpty()) {
217         parameters.append(AMBERSAND_MARK);
218         parameters.append(DATA);
219         parameters.append(EQUAL_MARK);
220         parameters.append(status);
221     }
222
223     return parameters;
224 }
225
226 void SituareService::sendRequest(const QUrl &url, const QString &cookieType, const QString &cookie)
227 {
228     qDebug() << __PRETTY_FUNCTION__;
229
230     QNetworkRequest request;
231
232     request.setUrl(url);
233     request.setAttribute(QNetworkRequest::CacheSaveControlAttribute, false);
234     request.setRawHeader(cookieType.toAscii(), cookie.toUtf8());
235
236     QNetworkReply *reply = m_networkManager->get(request, true);
237
238     m_currentRequests.append(reply);
239 }
240
241 void SituareService::requestFinished(QNetworkReply *reply)
242 {
243     qDebug() << __PRETTY_FUNCTION__;
244
245     //Reply from situare
246     if (m_currentRequests.contains(reply)) {
247
248         QUrl url = reply->url();
249         qDebug() << "BytesAvailable: " << reply->bytesAvailable();
250
251         if (reply->error()) {
252             emit error(reply->error());
253         } else {
254             qint64 max = reply->size();
255             QByteArray replyArray = reply->read(max);
256             qDebug() << "Reply from: " << url << "reply " << replyArray;
257
258             if(replyArray == ERROR_LAT.toAscii()) {
259                 qDebug() << "Error: " << ERROR_LAT;
260                 emit error(SituareError::UPDATE_FAILED);
261             } else if(replyArray == ERROR_LON.toAscii()) {
262                 qDebug() << "Error: " << ERROR_LON;
263                 emit error(SituareError::UPDATE_FAILED);
264             } else if(replyArray.contains(ERROR_SESSION.toAscii())) {
265                 qDebug() << "Error: " << ERROR_SESSION;
266                 emit error(SituareError::SESSION_EXPIRED);
267             } else if(replyArray.startsWith(OPENING_BRACE_MARK.toAscii())) {
268                 qDebug() << "JSON string";
269                 parseUserData(replyArray);
270             } else if(replyArray.isEmpty()) {
271                 if(url.toString().contains(UPDATE_LOCATION.toAscii())) {
272                     emit updateWasSuccessful();
273                 } else if(url.toString().contains(REVERSE_GEO.toAscii())) {
274                     // reversegeo failed
275                     emit error(SituareError::ADDRESS_RETRIEVAL_FAILED);
276                 } else {
277                     // session credentials are invalid
278                     emit error(SituareError::SESSION_EXPIRED);
279                 }
280             } else if(url.toString().contains(REVERSE_GEO.toAscii())) {
281                 // Street address ready
282                 QString address = QString::fromUtf8(replyArray);
283                 emit reverseGeoReady(address);
284             } else {
285                 // unknown reply
286                 emit error(SituareError::UNKNOWN_REPLY);
287             }
288         }
289         m_currentRequests.removeAll(reply);
290         reply->deleteLater();
291     }
292 }
293
294 void SituareService::credentialsReady(const FacebookCredentials &credentials)
295 {
296     qDebug() << __PRETTY_FUNCTION__;
297
298     m_credentials = credentials;    
299 }
300
301 void SituareService::parseUserData(/*const*/ QByteArray &jsonReply)
302 {
303     qDebug() << __PRETTY_FUNCTION__;
304
305     m_visited = 0;
306     m_nbrOfImages = 0;
307     m_defaultImage = false;
308     qDeleteAll(m_friendsList.begin(), m_friendsList.end());
309     m_friendsList.clear();
310
311     if(m_user) {
312         delete m_user;
313         m_user = 0;
314     }
315
316     QJson::Parser parser;
317     bool ok;
318
319     QVariantMap result = parser.parse (jsonReply, &ok).toMap();
320     if (!ok) {
321         emit error(SituareError::INVALID_JSON);
322         return;
323     } else {
324
325         QVariant userVariant = result.value("user");
326         QMap<QString, QVariant> userMap = userVariant.toMap();
327
328         QPointF coordinates(userMap["longitude"].toReal(), userMap["latitude"].toReal());
329
330         QUrl imageUrl = userMap[NORMAL_SIZE_PROFILE_IMAGE].toUrl();
331
332         if(imageUrl.isEmpty()) {
333             // user doesn't have profile image, so we need to get him a silhouette image
334             m_defaultImage = true;
335         }
336
337         m_user = new User(userMap["address"].toString(), coordinates, userMap["name"].toString(),
338                       userMap["note"].toString(), imageUrl, userMap["timestamp"].toString(),
339                       true, userMap["uid"].toString());
340
341         foreach (QVariant friendsVariant, result["friends"].toList()) {
342           QMap<QString, QVariant> friendMap = friendsVariant.toMap();
343           QVariant distance = friendMap["distance"];
344           QMap<QString, QVariant> distanceMap = distance.toMap();
345
346           QPointF coordinates(friendMap["longitude"].toReal(), friendMap["latitude"].toReal());
347
348           QUrl imageUrl = friendMap["profile_pic"].toUrl();
349
350           if(imageUrl.isEmpty()) {
351               // friend doesn't have profile image, so we need to get him a silhouette image
352               m_defaultImage = true;
353           }
354
355           User *user = new User(friendMap["address"].toString(), coordinates,
356                                 friendMap["name"].toString(),
357                                 friendMap["note"].toString(), imageUrl,
358                                 friendMap["timestamp"].toString(),
359                                 false, friendMap["uid"].toString(),
360                                 distanceMap["units"].toString(),
361                                 distanceMap["value"].toDouble());
362
363           m_friendsList.append(user);
364         }
365         addProfileImages();
366     }
367 }
368
369 void SituareService::imageReceived(const QUrl &url, const QPixmap &image)
370 {
371     qDebug() << __PRETTY_FUNCTION__;
372     qDebug() << "Image URL: " << url << " size :" << image.size();
373
374     // assign facebook silhouette image to all who doesn't have a profile image
375     if(url == QUrl(SILHOUETTE_URL)) {
376         if(m_user->profileImageUrl().isEmpty()) {
377             m_user->setProfileImage(AvatarImage::create(image, AvatarImage::Large));
378         }
379         for(int i=0;i < m_friendsList.count();i++) {
380             if(m_friendsList.at(i)->profileImageUrl().isEmpty()) {
381                 m_friendsList.at(i)->setProfileImage(AvatarImage::create(image,
382                                                                          AvatarImage::Small));
383             }
384         }
385     }
386
387     if (m_user->profileImageUrl() == url) {
388         m_user->setProfileImage(AvatarImage::create(image, AvatarImage::Large));
389     }
390
391     for(int i=0;i<m_friendsList.count();i++) {
392         if(m_friendsList.at(i)->profileImageUrl() == url) {
393             m_friendsList.at(i)->setProfileImage(AvatarImage::create(image, AvatarImage::Small));
394             m_nbrOfImages++; // indicates how many friend profile images has been downloaded
395         }
396     }
397
398     if(m_nbrOfImages == m_visited) {
399         qDebug() << "m_nbrOfImages: " << m_nbrOfImages << " m_visited: " << m_visited;
400         qDebug() << "emit userDataChanged";
401         emit userDataChanged(m_user, m_friendsList);
402     }
403 }
404
405 void SituareService::addProfileImages()
406 {
407     qDebug() << __PRETTY_FUNCTION__;
408
409     // reduce net traffic by sending only one download request for facebook silhouette image
410     if(m_defaultImage) {
411         emit fetchImage(QUrl(SILHOUETTE_URL));
412     }
413
414     if(!m_user->profileImageUrl().isEmpty() && m_user->profileImageUrl().isValid())
415         emit fetchImage(m_user->profileImageUrl());
416
417     for(int i=0;i<m_friendsList.count();i++) {
418         if(!m_friendsList.at(i)->profileImageUrl().isEmpty() &&
419            m_friendsList.at(i)->profileImageUrl().isValid()) {
420             m_visited++; // indicates how many friends that have profile image
421             emit fetchImage(m_friendsList.at(i)->profileImageUrl());
422         }
423     }
424 }
425
426 void SituareService::clearUserData()
427 {
428     qDebug() << __PRETTY_FUNCTION__;
429
430     qDeleteAll(m_friendsList.begin(), m_friendsList.end());
431     m_friendsList.clear();
432
433     if(m_user) {
434         delete m_user;
435         m_user = 0;
436     }
437     emit userDataChanged(m_user, m_friendsList);
438 }