backup
[situare] / src / engine / engine.cpp
1  /*
2     Situare - A location system for Facebook
3     Copyright (C) 2010  Ixonos Plc. Authors:
4
5         Kaj Wallin - kaj.wallin@ixonos.com
6         Henri Lampela - henri.lampela@ixonos.com
7         Jussi Laitinen - jussi.laitinen@ixonos.com
8         Sami Rämö - sami.ramo@ixonos.com
9
10     Situare is free software; you can redistribute it and/or
11     modify it under the terms of the GNU General Public License
12     version 2 as published by the Free Software Foundation.
13
14     Situare is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17     GNU General Public License for more details.
18
19     You should have received a copy of the GNU General Public License
20     along with Situare; if not, write to the Free Software
21     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
22     USA.
23  */
24
25 #include <QMessageBox>
26 #include <QNetworkReply>
27
28 #include "common.h"
29 #include "facebookservice/facebookauthentication.h"
30 #include "gps/gpsposition.h"
31 #include "map/mapengine.h"
32 #include "situareservice/situareservice.h"
33 #include "ui/mainwindow.h"
34 #include <cmath>
35
36 #include "engine.h"
37
38 const QString SETTINGS_GPS_ENABLED = "GPS_ENABLED"; ///< GPS setting
39 const QString SETTINGS_AUTO_CENTERING_ENABLED = "AUTO_CENTERING_ENABLED";///< Auto centering setting
40 const int DEFAULT_ZOOM_LEVEL_WHEN_GPS_IS_AVAILABLE = 12;  ///< Default zoom level when GPS available
41 const qreal USER_MOVEMENT_MINIMUM_LONGITUDE_DIFFERENCE = 0.003;///< Min value for user move latitude
42 const qreal USER_MOVEMENT_MINIMUM_LATITUDE_DIFFERENCE = 0.001;///< Min value for user move longitude
43 const int MIN_UPDATE_INTERVAL_MSECS = 5*60*1000;
44
45 SituareEngine::SituareEngine(QMainWindow *parent)
46     : QObject(parent),
47       m_autoCenteringEnabled(false),
48       m_automaticUpdateFirstStart(true),
49       m_userMoved(false),
50       m_automaticUpdateIntervalTimer(0),
51       m_lastUpdatedGPSPosition(QPointF())
52 {    
53     qDebug() << __PRETTY_FUNCTION__;
54     m_ui = new MainWindow;
55     m_ui->updateItemVisibility();
56
57     // build MapEngine
58     m_mapEngine = new MapEngine(this);
59     m_ui->setMapViewScene(m_mapEngine->scene());
60
61     // build GPS
62     m_gps = new GPSPosition(this);
63
64     // build SituareService
65     m_situareService = new SituareService(this);
66
67     // build FacebookAuthenticator
68     m_facebookAuthenticator = new FacebookAuthentication(this);
69
70     // connect signals
71     signalsFromMapEngine();
72     signalsFromGPS();
73     signalsFromSituareService();
74     signalsFromMainWindow();
75     signalsFromFacebookAuthenticator();
76
77     connect(this, SIGNAL(userLocationReady(User*)),
78             m_ui, SIGNAL(userLocationReady(User*)));
79
80     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
81             m_ui, SIGNAL(friendsLocationsReady(QList<User*>&)));
82
83     connect(this, SIGNAL(userLocationReady(User*)),
84             m_mapEngine, SLOT(receiveOwnLocation(User*)));
85
86     connect(this, SIGNAL(friendsLocationsReady(QList<User*>&)),
87             m_mapEngine, SIGNAL(friendsLocationsReady(QList<User*>&)));
88
89     m_automaticUpdateIntervalTimer = new QTimer(this);
90     connect(m_automaticUpdateIntervalTimer, SIGNAL(timeout()),
91             this, SLOT(automaticUpdateIntervalTimerTimeout()));
92
93     // signals connected, now it's time to show the main window
94     // but init the MapEngine before so starting location is set
95     m_mapEngine->init();
96     m_ui->show();
97
98     m_facebookAuthenticator->start();
99
100     m_gps->setMode(GPSPosition::Default);
101     initializeGpsAndAutocentering();
102 }
103
104 SituareEngine::~SituareEngine()
105 {
106     qDebug() << __PRETTY_FUNCTION__;
107
108     delete m_ui;
109
110     QSettings settings(DIRECTORY_NAME, FILE_NAME);
111     settings.setValue(SETTINGS_GPS_ENABLED, m_gps->isRunning());
112     settings.setValue(SETTINGS_AUTO_CENTERING_ENABLED, m_autoCenteringEnabled);
113 }
114
115 void SituareEngine::automaticUpdateIntervalTimerTimeout()
116 {
117     qDebug() << __PRETTY_FUNCTION__;
118
119     if (m_gps->isRunning() && m_userMoved) {
120         requestUpdateLocation();
121         m_userMoved = false;
122     }
123 }
124
125 void SituareEngine::changeAutoCenteringSetting(bool enabled)
126 {
127     qDebug() << __PRETTY_FUNCTION__;
128
129     m_autoCenteringEnabled = enabled;
130     enableAutoCentering(enabled);
131 }
132
133 void SituareEngine::disableAutoCentering()
134 {
135     qDebug() << __PRETTY_FUNCTION__;
136
137     changeAutoCenteringSetting(false);
138     m_ui->buildInformationBox(tr("Auto centering disabled"));
139 }
140
141 void SituareEngine::enableAutoCentering(bool enabled)
142 {
143     qDebug() << __PRETTY_FUNCTION__;
144
145     m_ui->setAutoCenteringButtonEnabled(enabled);
146     m_mapEngine->setAutoCentering(enabled);
147
148     if (enabled)
149         m_gps->requestLastPosition();
150 }
151
152 void SituareEngine::enableGPS(bool enabled)
153 {
154     qDebug() << __PRETTY_FUNCTION__;
155
156     m_ui->setOwnLocationCrosshairVisibility(!enabled);
157
158     if (m_gps->isInitialized()) {
159         m_ui->setGPSButtonEnabled(enabled);
160         m_mapEngine->setGPSEnabled(enabled);
161
162         if (enabled && !m_gps->isRunning()) {
163             m_gps->start();
164             enableAutoCentering(m_autoCenteringEnabled);
165             m_gps->requestLastPosition();
166
167             if(m_ui->loginState())
168                 m_ui->readAutomaticLocationUpdateSettings();
169         }
170         else if (!enabled && m_gps->isRunning()) {
171             m_gps->stop();
172             enableAutoCentering(false);
173             enableAutomaticLocationUpdate(false);
174         }
175     }
176     else {
177         if (enabled)
178             m_ui->buildInformationBox(tr("Unable to start GPS"));
179         m_ui->setGPSButtonEnabled(false);
180         m_mapEngine->setGPSEnabled(false);
181     }
182 }
183
184 void SituareEngine::enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs)
185 {
186     qDebug() << __PRETTY_FUNCTION__;
187
188     //Show automatic update confirmation dialog
189     if (m_automaticUpdateFirstStart && m_gps->isRunning() && enabled) {
190         m_ui->showEnableAutomaticUpdateLocationDialog(
191                 tr("Do you want to enable automatic location update with %1 min update interval?")
192                 .arg(updateIntervalMsecs/1000/60));
193         m_automaticUpdateFirstStart = false;
194     } else {
195         if (enabled && m_gps->isRunning()) {
196             m_ui->buildInformationBox(tr("Automatic location update enabled"));
197             if (updateIntervalMsecs < MIN_UPDATE_INTERVAL_MSECS)
198                 m_automaticUpdateIntervalTimer->setInterval(MIN_UPDATE_INTERVAL_MSECS);
199             else
200                 m_automaticUpdateIntervalTimer->setInterval(updateIntervalMsecs);
201
202             m_automaticUpdateIntervalTimer->start();
203
204         } else {
205             m_automaticUpdateIntervalTimer->stop();
206         }
207     }
208 }
209
210 void SituareEngine::error(const int error)
211 {
212     qDebug() << __PRETTY_FUNCTION__;    
213
214     switch(error)
215     {
216     case QNetworkReply::ConnectionRefusedError:
217         m_ui->buildInformationBox(tr("Connection refused by the server"), true);
218         break;
219     case QNetworkReply::RemoteHostClosedError:
220         m_ui->buildInformationBox(tr("Connection closed by the server"), true);
221         break;
222     case QNetworkReply::HostNotFoundError:
223         m_ui->buildInformationBox(tr("Remote server not found"), true);
224         break;
225     case QNetworkReply::TimeoutError:
226         m_ui->buildInformationBox(tr("Connection timed out"), true);
227         break;
228     case SituareError::SESSION_EXPIRED:
229         m_ui->buildInformationBox(tr("Session expired. Please login again"), true);
230         m_facebookAuthenticator->clearAccountInformation(true); // keep username = true
231         m_situareService->clearUserData();
232         m_ui->loggedIn(false);
233         m_ui->loginFailed();
234         break;
235     case SituareError::LOGIN_FAILED:
236         m_ui->buildInformationBox(tr("Invalid E-mail address or password"), true);
237         break;
238     case SituareError::UPDATE_FAILED:
239         m_ui->buildInformationBox(tr("Update failed, please try again"), true);
240         break;
241     case SituareError::DATA_RETRIEVAL_FAILED:
242         m_ui->buildInformationBox(tr("Data retrieval failed, please try again"), true);
243         break;
244     case SituareError::ADDRESS_RETRIEVAL_FAILED:
245         m_ui->buildInformationBox(tr("Address retrieval failed"), true);
246         break;
247     case SituareError::IMAGE_DOWNLOAD_FAILED:
248         m_ui->buildInformationBox(tr("Image download failed"), true);
249         break;
250     case SituareError::MAP_IMAGE_DOWNLOAD_FAILED:
251         m_ui->buildInformationBox(tr("Map image download failed"), true);
252         break;
253     case SituareError::GPS_INITIALIZATION_FAILED:
254         enableGPS(false);
255         m_ui->buildInformationBox(tr("GPS initialization failed"), true);
256         break;
257     case SituareError::UNKNOWN_REPLY:
258         m_ui->buildInformationBox(tr("Unknown server response"), true);
259         break;
260     case SituareError::INVALID_JSON:
261         m_ui->buildInformationBox(tr("Malformatted reply from server"), true);
262         m_ui->loggedIn(false);
263         m_facebookAuthenticator->clearAccountInformation(false); // clean all
264         break;
265     default:
266         qCritical() << "QNetworkReply::NetworkError :" << error;
267         break;
268     }
269 }
270
271 void SituareEngine::fetchUsernameFromSettings()
272 {
273     qDebug() << __PRETTY_FUNCTION__;
274
275     m_ui->setUsername(m_facebookAuthenticator->loadUsername());
276 }
277
278 void SituareEngine::initializeGpsAndAutocentering()
279 {
280     qDebug() << __PRETTY_FUNCTION__;
281
282     QSettings settings(DIRECTORY_NAME, FILE_NAME);
283     QVariant gpsEnabled = settings.value(SETTINGS_GPS_ENABLED);
284     QVariant autoCenteringEnabled = settings.value(SETTINGS_AUTO_CENTERING_ENABLED);
285
286     if (m_gps->isInitialized()) {
287
288         if (gpsEnabled.toString().isEmpty()) { // First start. Situare.conf file does not exists
289
290             connect(m_gps, SIGNAL(position(QPointF,qreal)),
291                     this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
292
293             changeAutoCenteringSetting(true);
294             enableGPS(true);
295
296             m_ui->buildInformationBox(tr("GPS enabled"));
297             m_ui->buildInformationBox(tr("Auto centering enabled"));
298
299         } else { // Normal start
300             changeAutoCenteringSetting(autoCenteringEnabled.toBool());
301             enableGPS(gpsEnabled.toBool());
302
303             if (gpsEnabled.toBool())
304                 m_ui->buildInformationBox(tr("GPS enabled"));
305
306             if (gpsEnabled.toBool() && autoCenteringEnabled.toBool())
307                 m_ui->buildInformationBox(tr("Auto centering enabled"));
308         }
309     } else {
310         enableGPS(false);
311     }
312 }
313
314 bool SituareEngine::isUserMoved()
315 {
316     qDebug() << __PRETTY_FUNCTION__;
317
318     return m_userMoved;
319 }
320
321 void SituareEngine::loginActionPressed()
322 {
323     qDebug() << __PRETTY_FUNCTION__;
324
325     if(m_ui->loginState()) {
326         logout();
327         m_situareService->clearUserData();
328     }
329     else {
330         m_facebookAuthenticator->start();
331     }
332 }
333
334 void SituareEngine::loginOk()
335 {
336     qDebug() << __PRETTY_FUNCTION__;
337
338     m_ui->loggedIn(true);
339
340     m_ui->show();
341     m_situareService->fetchLocations(); // request user locations
342
343     if (m_gps->isRunning())
344         m_ui->readAutomaticLocationUpdateSettings();
345 }
346
347 void SituareEngine::loginProcessCancelled()
348 {
349     qDebug() << __PRETTY_FUNCTION__;
350
351     m_ui->toggleProgressIndicator(false);
352     m_ui->updateItemVisibility();
353 }
354
355 void SituareEngine::logout()
356 {
357     qDebug() << __PRETTY_FUNCTION__;
358
359     m_ui->loggedIn(false);
360
361     // signal to clear locationUpdateDialog's data
362     connect(this, SIGNAL(clearUpdateLocationDialogData()),
363             m_ui, SIGNAL(clearUpdateLocationDialogData()));
364     emit clearUpdateLocationDialogData();
365
366     m_facebookAuthenticator->clearAccountInformation(); // clear all
367     m_automaticUpdateFirstStart = true;
368 }
369
370 void SituareEngine::refreshUserData()
371 {
372     qDebug() << __PRETTY_FUNCTION__;
373
374     m_ui->toggleProgressIndicator(true);
375
376     m_situareService->fetchLocations();
377 }
378
379 void SituareEngine::requestAddress()
380 {
381     qDebug() << __PRETTY_FUNCTION__;
382
383     if (m_gps->isRunning())
384         m_situareService->reverseGeo(m_gps->lastPosition());
385     else
386         m_situareService->reverseGeo(m_mapEngine->centerGeoCoordinate());
387 }
388
389 void SituareEngine::requestUpdateLocation(const QString &status, bool publish)
390 {
391     qDebug() << __PRETTY_FUNCTION__;
392
393     m_ui->toggleProgressIndicator(true);
394
395     if (m_gps->isRunning())
396         m_situareService->updateLocation(m_gps->lastPosition(), status, publish);
397     else
398         m_situareService->updateLocation(m_mapEngine->centerGeoCoordinate(), status, publish);
399 }
400
401 void SituareEngine::saveGPSPosition(QPointF position)
402 {
403     qDebug() << __PRETTY_FUNCTION__;
404
405     if ((fabs(m_lastUpdatedGPSPosition.x() - position.x()) >
406          USER_MOVEMENT_MINIMUM_LONGITUDE_DIFFERENCE) ||
407         (fabs(m_lastUpdatedGPSPosition.y() - position.y()) >
408          USER_MOVEMENT_MINIMUM_LATITUDE_DIFFERENCE)) {
409
410         m_lastUpdatedGPSPosition = position;
411         m_userMoved = true;
412     }
413 }
414
415 void SituareEngine::setFirstStartZoomLevel(QPointF latLonCoordinate, qreal accuracy)
416 {
417     qDebug() << __PRETTY_FUNCTION__;
418
419     Q_UNUSED(latLonCoordinate);
420     Q_UNUSED(accuracy);
421
422     if (m_autoCenteringEnabled) // autocentering is disabled when map is scrolled        
423         m_mapEngine->setZoomLevel(DEFAULT_ZOOM_LEVEL_WHEN_GPS_IS_AVAILABLE);
424
425     disconnect(m_gps, SIGNAL(position(QPointF,qreal)),
426                this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
427 }
428
429 void SituareEngine::signalsFromFacebookAuthenticator()
430 {
431     qDebug() << __PRETTY_FUNCTION__;
432
433     connect(m_facebookAuthenticator, SIGNAL(error(int)),
434             this, SLOT(error(int)));
435
436     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
437             m_situareService, SLOT(credentialsReady(FacebookCredentials)));
438
439     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
440             this, SLOT(loginOk()));
441
442     connect(m_facebookAuthenticator, SIGNAL(newLoginRequest()),
443             m_ui, SLOT(startLoginProcess()));
444
445     connect(m_facebookAuthenticator, SIGNAL(loginFailure()),
446             m_ui, SLOT(loginFailed()));
447
448     connect(m_facebookAuthenticator, SIGNAL(saveCookiesRequest()),
449             m_ui, SLOT(saveCookies()));
450
451     connect(m_facebookAuthenticator, SIGNAL(loginUsingCookies()),
452             m_ui, SLOT(loginUsingCookies()));
453 }
454
455 void SituareEngine::signalsFromGPS()
456 {
457     qDebug() << __PRETTY_FUNCTION__;
458
459     connect(m_gps, SIGNAL(position(QPointF,qreal)),
460             m_mapEngine, SLOT(gpsPositionUpdate(QPointF,qreal)));
461
462     connect(m_gps, SIGNAL(timeout()),
463             m_ui, SLOT(gpsTimeout()));
464
465     connect(m_gps, SIGNAL(error(int)),
466             this, SLOT(error(int)));
467
468     connect(m_gps, SIGNAL(position(QPointF,qreal)),
469             this, SLOT(saveGPSPosition(QPointF)));
470 }
471
472 void SituareEngine::signalsFromMainWindow()
473 {
474     qDebug() << __PRETTY_FUNCTION__;    
475
476     connect(m_ui, SIGNAL(error(int)),
477             this, SLOT(error(int)));
478
479     connect(m_ui, SIGNAL(fetchUsernameFromSettings()),
480             this, SLOT(fetchUsernameFromSettings()));
481
482     connect(m_ui, SIGNAL(loginActionPressed()),
483             this, SLOT(loginActionPressed()));
484
485     connect(m_ui, SIGNAL(saveUsername(QString)),
486             m_facebookAuthenticator, SLOT(saveUsername(QString)));
487
488     connect(m_ui, SIGNAL(updateCredentials(QUrl)),
489             m_facebookAuthenticator, SLOT(updateCredentials(QUrl)));
490
491     // signals from map view
492     connect(m_ui, SIGNAL(mapViewScrolled(QPoint)),
493             m_mapEngine, SLOT(setLocation(QPoint)));
494
495     connect(m_ui, SIGNAL(mapViewResized(QSize)),
496             m_mapEngine, SLOT(viewResized(QSize)));
497
498     connect(m_ui, SIGNAL(viewZoomFinished()),
499             m_mapEngine, SLOT(viewZoomFinished()));
500
501     // signals from zoom buttons (zoom panel and volume buttons)
502     connect(m_ui, SIGNAL(zoomIn()),
503             m_mapEngine, SLOT(zoomIn()));
504
505     connect(m_ui, SIGNAL(zoomOut()),
506             m_mapEngine, SLOT(zoomOut()));
507
508     // signals from menu buttons
509     connect(m_ui, SIGNAL(autoCenteringTriggered(bool)),
510             this, SLOT(changeAutoCenteringSetting(bool)));
511
512     connect(m_ui, SIGNAL(gpsTriggered(bool)),
513             this, SLOT(enableGPS(bool)));
514
515     //signals from dialogs
516     connect(m_ui, SIGNAL(cancelLoginProcess()),
517             this, SLOT(loginProcessCancelled()));
518
519     connect(m_ui, SIGNAL(requestReverseGeo()),
520             this, SLOT(requestAddress()));
521
522     connect(m_ui, SIGNAL(statusUpdate(QString,bool)),
523             this, SLOT(requestUpdateLocation(QString,bool)));
524
525     connect(m_ui, SIGNAL(enableAutomaticLocationUpdate(bool, int)),
526             this, SLOT(enableAutomaticLocationUpdate(bool, int)));    
527
528     // signals from user info tab
529     connect(m_ui, SIGNAL(refreshUserData()),
530             this, SLOT(refreshUserData()));
531
532     connect(m_ui, SIGNAL(findUser(QPointF)),
533             m_mapEngine, SLOT(setViewLocation(QPointF)));
534
535     // signals from friend list tab
536     connect(m_ui, SIGNAL(findFriend(QPointF)),
537             m_mapEngine, SLOT(setViewLocation(QPointF)));
538 }
539
540 void SituareEngine::signalsFromMapEngine()
541 {
542     qDebug() << __PRETTY_FUNCTION__;
543
544     connect(m_mapEngine, SIGNAL(error(int)),
545             this, SLOT(error(int)));
546
547     connect(m_mapEngine, SIGNAL(locationChanged(QPoint)),
548             m_ui, SIGNAL(centerToSceneCoordinates(QPoint)));
549
550     connect(m_mapEngine, SIGNAL(zoomLevelChanged(int)),
551             m_ui, SIGNAL(zoomLevelChanged(int)));
552
553     connect(m_mapEngine, SIGNAL(mapScrolledManually()),
554             this, SLOT(disableAutoCentering()));
555
556     connect(m_mapEngine, SIGNAL(maxZoomLevelReached()),
557             m_ui, SIGNAL(maxZoomLevelReached()));
558
559     connect(m_mapEngine, SIGNAL(minZoomLevelReached()),
560             m_ui, SIGNAL(minZoomLevelReached()));
561
562     connect(m_mapEngine, SIGNAL(locationItemClicked(QList<QString>)),
563             m_ui, SIGNAL(locationItemClicked(QList<QString>)));
564
565     connect(m_mapEngine, SIGNAL(newMapResolution(qreal)),
566             m_ui, SIGNAL(newMapResolution(qreal)));
567 }
568
569 void SituareEngine::signalsFromSituareService()
570 {
571     qDebug() << __PRETTY_FUNCTION__;
572
573     connect(m_situareService, SIGNAL(error(int)),
574             this, SLOT(error(int)));
575
576     connect(m_situareService, SIGNAL(error(int)),
577             m_ui, SIGNAL(messageSendingFailed(int)));
578
579     connect(m_situareService, SIGNAL(reverseGeoReady(QString)),
580             m_ui, SIGNAL(reverseGeoReady(QString)));
581
582     connect(m_situareService, SIGNAL(userDataChanged(User*, QList<User*>&)),
583             this, SLOT(userDataChanged(User*, QList<User*>&)));
584
585     connect(m_situareService, SIGNAL(updateWasSuccessful()),
586             this, SLOT(updateWasSuccessful()));
587
588     connect(m_situareService, SIGNAL(updateWasSuccessful()),
589             m_ui, SIGNAL(clearUpdateLocationDialogData()));
590 }
591
592 void SituareEngine::updateWasSuccessful()
593 {
594     qDebug() << __PRETTY_FUNCTION__;
595
596     m_situareService->fetchLocations();
597 }
598
599 void SituareEngine::userDataChanged(User *user, QList<User *> &friendsList)
600 {
601     qDebug() << __PRETTY_FUNCTION__;
602
603     m_ui->toggleProgressIndicator(false);
604
605     emit userLocationReady(user);
606     emit friendsLocationsReady(friendsList);
607 }