Implemented functionality to show side panels only when they contain data
[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->toggleProgressIndicator(false);
218         m_ui->buildInformationBox(tr("Connection refused by the server"), true);
219         break;
220     case QNetworkReply::RemoteHostClosedError:
221         m_ui->toggleProgressIndicator(false);
222         m_ui->buildInformationBox(tr("Connection closed by the server"), true);
223         break;
224     case QNetworkReply::HostNotFoundError:
225         m_ui->toggleProgressIndicator(false);
226         m_ui->buildInformationBox(tr("Remote server not found"), true);
227         break;
228     case QNetworkReply::TimeoutError:
229         m_ui->toggleProgressIndicator(false);
230         m_ui->buildInformationBox(tr("Connection timed out"), true);
231         break;
232     case SituareError::SESSION_EXPIRED:
233         m_ui->buildInformationBox(tr("Session expired. Please login again"), true);
234         m_facebookAuthenticator->clearAccountInformation(true); // keep username = true
235         m_situareService->clearUserData();
236         m_ui->loggedIn(false);
237         m_ui->loginFailed();
238         break;
239     case SituareError::LOGIN_FAILED:
240         m_ui->toggleProgressIndicator(false);
241         m_ui->buildInformationBox(tr("Invalid E-mail address or password"), true);
242         m_ui->loginFailed();
243         break;
244     case SituareError::UPDATE_FAILED:
245         m_ui->toggleProgressIndicator(false);
246         m_ui->buildInformationBox(tr("Update failed, please try again"), true);
247         break;
248     case SituareError::DATA_RETRIEVAL_FAILED:
249         m_ui->toggleProgressIndicator(false);
250         m_ui->buildInformationBox(tr("Data retrieval failed, please try again"), true);
251         break;
252     case SituareError::ADDRESS_RETRIEVAL_FAILED:
253         m_ui->buildInformationBox(tr("Address retrieval failed"), true);
254         break;
255     case SituareError::IMAGE_DOWNLOAD_FAILED:
256         m_ui->buildInformationBox(tr("Image download failed"), true);
257         break;
258     case SituareError::MAP_IMAGE_DOWNLOAD_FAILED:
259         m_ui->buildInformationBox(tr("Map image download failed"), true);
260         break;
261     case SituareError::GPS_INITIALIZATION_FAILED:
262         enableGPS(false);
263         m_ui->buildInformationBox(tr("GPS initialization failed"), true);
264         break;
265     case SituareError::UNKNOWN_REPLY:
266         m_ui->toggleProgressIndicator(false);
267         m_ui->buildInformationBox(tr("Unknown server response"), true);
268         break;
269     case SituareError::INVALID_JSON:
270         m_ui->buildInformationBox(tr("Malformatted reply from server"), true);
271         m_ui->loggedIn(false);
272         m_facebookAuthenticator->clearAccountInformation(false); // clean all
273         break;
274     default:
275         m_ui->toggleProgressIndicator(false);
276         qCritical() << "QNetworkReply::NetworkError :" << error;
277         break;
278     }
279 }
280
281 void SituareEngine::fetchUsernameFromSettings()
282 {
283     qDebug() << __PRETTY_FUNCTION__;
284
285     m_ui->setUsername(m_facebookAuthenticator->loadUsername());
286 }
287
288 void SituareEngine::initializeGpsAndAutocentering()
289 {
290     qDebug() << __PRETTY_FUNCTION__;
291
292     QSettings settings(DIRECTORY_NAME, FILE_NAME);
293     QVariant gpsEnabled = settings.value(SETTINGS_GPS_ENABLED);
294     QVariant autoCenteringEnabled = settings.value(SETTINGS_AUTO_CENTERING_ENABLED);
295
296     if (m_gps->isInitialized()) {
297
298         if (gpsEnabled.toString().isEmpty()) { // First start. Situare.conf file does not exists
299
300             connect(m_gps, SIGNAL(position(QPointF,qreal)),
301                     this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
302
303             changeAutoCenteringSetting(true);
304             enableGPS(true);
305
306             m_ui->buildInformationBox(tr("GPS enabled"));
307             m_ui->buildInformationBox(tr("Auto centering enabled"));
308
309         } else { // Normal start
310             changeAutoCenteringSetting(autoCenteringEnabled.toBool());
311             enableGPS(gpsEnabled.toBool());
312
313             if (gpsEnabled.toBool())
314                 m_ui->buildInformationBox(tr("GPS enabled"));
315
316             if (gpsEnabled.toBool() && autoCenteringEnabled.toBool())
317                 m_ui->buildInformationBox(tr("Auto centering enabled"));
318         }
319     } else {
320         enableGPS(false);
321     }
322 }
323
324 bool SituareEngine::isUserMoved()
325 {
326     qDebug() << __PRETTY_FUNCTION__;
327
328     return m_userMoved;
329 }
330
331 void SituareEngine::loginActionPressed()
332 {
333     qDebug() << __PRETTY_FUNCTION__;
334
335     if(m_ui->loginState()) {
336         logout();
337         m_situareService->clearUserData();
338     } else {
339         m_facebookAuthenticator->start();
340     }
341 }
342
343 void SituareEngine::loginOk()
344 {
345     qDebug() << __PRETTY_FUNCTION__;
346
347     m_ui->loggedIn(true);
348
349     m_ui->show();
350     m_situareService->fetchLocations(); // request user locations
351
352     if (m_gps->isRunning())
353         m_ui->readAutomaticLocationUpdateSettings();
354 }
355
356 void SituareEngine::loginProcessCancelled()
357 {
358     qDebug() << __PRETTY_FUNCTION__;
359
360     m_ui->toggleProgressIndicator(false);
361     m_ui->updateItemVisibility();
362 }
363
364 void SituareEngine::logout()
365 {
366     qDebug() << __PRETTY_FUNCTION__;
367
368     m_ui->loggedIn(false);
369
370     // signal to clear locationUpdateDialog's data
371     connect(this, SIGNAL(clearUpdateLocationDialogData()),
372             m_ui, SIGNAL(clearUpdateLocationDialogData()));
373     emit clearUpdateLocationDialogData();
374
375     m_facebookAuthenticator->clearAccountInformation(); // clear all
376     m_automaticUpdateFirstStart = true;
377 }
378
379 void SituareEngine::refreshUserData()
380 {
381     qDebug() << __PRETTY_FUNCTION__;
382
383     m_ui->toggleProgressIndicator(true);
384
385     m_situareService->fetchLocations();
386 }
387
388 void SituareEngine::requestAddress()
389 {
390     qDebug() << __PRETTY_FUNCTION__;
391
392     if (m_gps->isRunning())
393         m_situareService->reverseGeo(m_gps->lastPosition());
394     else
395         m_situareService->reverseGeo(m_mapEngine->centerGeoCoordinate());
396 }
397
398 void SituareEngine::requestUpdateLocation(const QString &status, bool publish)
399 {
400     qDebug() << __PRETTY_FUNCTION__;
401
402     m_ui->toggleProgressIndicator(true);
403
404     if (m_gps->isRunning())
405         m_situareService->updateLocation(m_gps->lastPosition(), status, publish);
406     else
407         m_situareService->updateLocation(m_mapEngine->centerGeoCoordinate(), status, publish);
408 }
409
410 void SituareEngine::saveGPSPosition(QPointF position)
411 {
412     qDebug() << __PRETTY_FUNCTION__;
413
414     if ((fabs(m_lastUpdatedGPSPosition.x() - position.x()) >
415          USER_MOVEMENT_MINIMUM_LONGITUDE_DIFFERENCE) ||
416         (fabs(m_lastUpdatedGPSPosition.y() - position.y()) >
417          USER_MOVEMENT_MINIMUM_LATITUDE_DIFFERENCE)) {
418
419         m_lastUpdatedGPSPosition = position;
420         m_userMoved = true;
421     }
422 }
423
424 void SituareEngine::setFirstStartZoomLevel(QPointF latLonCoordinate, qreal accuracy)
425 {
426     qDebug() << __PRETTY_FUNCTION__;
427
428     Q_UNUSED(latLonCoordinate);
429     Q_UNUSED(accuracy);
430
431     if (m_autoCenteringEnabled) // autocentering is disabled when map is scrolled        
432         m_mapEngine->setZoomLevel(DEFAULT_ZOOM_LEVEL_WHEN_GPS_IS_AVAILABLE);
433
434     disconnect(m_gps, SIGNAL(position(QPointF,qreal)),
435                this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
436 }
437
438 void SituareEngine::signalsFromFacebookAuthenticator()
439 {
440     qDebug() << __PRETTY_FUNCTION__;
441
442     connect(m_facebookAuthenticator, SIGNAL(error(int)),
443             this, SLOT(error(int)));
444
445     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
446             m_situareService, SLOT(credentialsReady(FacebookCredentials)));
447
448     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
449             this, SLOT(loginOk()));
450
451     connect(m_facebookAuthenticator, SIGNAL(newLoginRequest()),
452             m_ui, SLOT(startLoginProcess()));
453
454     connect(m_facebookAuthenticator, SIGNAL(saveCookiesRequest()),
455             m_ui, SLOT(saveCookies()));
456
457     connect(m_facebookAuthenticator, SIGNAL(loginUsingCookies()),
458             m_ui, SLOT(loginUsingCookies()));
459 }
460
461 void SituareEngine::signalsFromGPS()
462 {
463     qDebug() << __PRETTY_FUNCTION__;
464
465     connect(m_gps, SIGNAL(position(QPointF,qreal)),
466             m_mapEngine, SLOT(gpsPositionUpdate(QPointF,qreal)));
467
468     connect(m_gps, SIGNAL(timeout()),
469             m_ui, SLOT(gpsTimeout()));
470
471     connect(m_gps, SIGNAL(error(int)),
472             this, SLOT(error(int)));
473
474     connect(m_gps, SIGNAL(position(QPointF,qreal)),
475             this, SLOT(saveGPSPosition(QPointF)));
476 }
477
478 void SituareEngine::signalsFromMainWindow()
479 {
480     qDebug() << __PRETTY_FUNCTION__;    
481
482     connect(m_ui, SIGNAL(error(int)),
483             this, SLOT(error(int)));
484
485     connect(m_ui, SIGNAL(fetchUsernameFromSettings()),
486             this, SLOT(fetchUsernameFromSettings()));
487
488     connect(m_ui, SIGNAL(loginActionPressed()),
489             this, SLOT(loginActionPressed()));
490
491     connect(m_ui, SIGNAL(saveUsername(QString)),
492             m_facebookAuthenticator, SLOT(saveUsername(QString)));
493
494     connect(m_ui, SIGNAL(updateCredentials(QUrl)),
495             m_facebookAuthenticator, SLOT(updateCredentials(QUrl)));
496
497     // signals from map view
498     connect(m_ui, SIGNAL(mapViewScrolled(QPoint)),
499             m_mapEngine, SLOT(setLocation(QPoint)));
500
501     connect(m_ui, SIGNAL(mapViewResized(QSize)),
502             m_mapEngine, SLOT(viewResized(QSize)));
503
504     connect(m_ui, SIGNAL(viewZoomFinished()),
505             m_mapEngine, SLOT(viewZoomFinished()));
506
507     // signals from zoom buttons (zoom panel and volume buttons)
508     connect(m_ui, SIGNAL(zoomIn()),
509             m_mapEngine, SLOT(zoomIn()));
510
511     connect(m_ui, SIGNAL(zoomOut()),
512             m_mapEngine, SLOT(zoomOut()));
513
514     // signals from menu buttons
515     connect(m_ui, SIGNAL(autoCenteringTriggered(bool)),
516             this, SLOT(changeAutoCenteringSetting(bool)));
517
518     connect(m_ui, SIGNAL(gpsTriggered(bool)),
519             this, SLOT(enableGPS(bool)));
520
521     //signals from dialogs
522     connect(m_ui, SIGNAL(cancelLoginProcess()),
523             this, SLOT(loginProcessCancelled()));
524
525     connect(m_ui, SIGNAL(requestReverseGeo()),
526             this, SLOT(requestAddress()));
527
528     connect(m_ui, SIGNAL(statusUpdate(QString,bool)),
529             this, SLOT(requestUpdateLocation(QString,bool)));
530
531     connect(m_ui, SIGNAL(enableAutomaticLocationUpdate(bool, int)),
532             this, SLOT(enableAutomaticLocationUpdate(bool, int)));    
533
534     // signals from user info tab
535     connect(m_ui, SIGNAL(refreshUserData()),
536             this, SLOT(refreshUserData()));
537
538     connect(m_ui, SIGNAL(findUser(QPointF)),
539             m_mapEngine, SLOT(setViewLocation(QPointF)));
540
541     // signals from friend list tab
542     connect(m_ui, SIGNAL(findFriend(QPointF)),
543             m_mapEngine, SLOT(setViewLocation(QPointF)));
544 }
545
546 void SituareEngine::signalsFromMapEngine()
547 {
548     qDebug() << __PRETTY_FUNCTION__;
549
550     connect(m_mapEngine, SIGNAL(error(int)),
551             this, SLOT(error(int)));
552
553     connect(m_mapEngine, SIGNAL(locationChanged(QPoint)),
554             m_ui, SIGNAL(centerToSceneCoordinates(QPoint)));
555
556     connect(m_mapEngine, SIGNAL(zoomLevelChanged(int)),
557             m_ui, SIGNAL(zoomLevelChanged(int)));
558
559     connect(m_mapEngine, SIGNAL(mapScrolledManually()),
560             this, SLOT(disableAutoCentering()));
561
562     connect(m_mapEngine, SIGNAL(maxZoomLevelReached()),
563             m_ui, SIGNAL(maxZoomLevelReached()));
564
565     connect(m_mapEngine, SIGNAL(minZoomLevelReached()),
566             m_ui, SIGNAL(minZoomLevelReached()));
567
568     connect(m_mapEngine, SIGNAL(locationItemClicked(QList<QString>)),
569             m_ui, SIGNAL(locationItemClicked(QList<QString>)));
570
571     connect(m_mapEngine, SIGNAL(newMapResolution(qreal)),
572             m_ui, SIGNAL(newMapResolution(qreal)));
573 }
574
575 void SituareEngine::signalsFromSituareService()
576 {
577     qDebug() << __PRETTY_FUNCTION__;
578
579     connect(m_situareService, SIGNAL(error(int)),
580             this, SLOT(error(int)));
581
582     connect(m_situareService, SIGNAL(error(int)),
583             m_ui, SIGNAL(messageSendingFailed(int)));
584
585     connect(m_situareService, SIGNAL(reverseGeoReady(QString)),
586             m_ui, SIGNAL(reverseGeoReady(QString)));
587
588     connect(m_situareService, SIGNAL(userDataChanged(User*, QList<User*>&)),
589             this, SLOT(userDataChanged(User*, QList<User*>&)));
590
591     connect(m_situareService, SIGNAL(updateWasSuccessful()),
592             this, SLOT(updateWasSuccessful()));
593
594     connect(m_situareService, SIGNAL(updateWasSuccessful()),
595             m_ui, SIGNAL(clearUpdateLocationDialogData()));
596 }
597
598 void SituareEngine::updateWasSuccessful()
599 {
600     qDebug() << __PRETTY_FUNCTION__;
601
602     m_situareService->fetchLocations();
603 }
604
605 void SituareEngine::userDataChanged(User *user, QList<User *> &friendsList)
606 {
607     qDebug() << __PRETTY_FUNCTION__;
608
609     m_ui->toggleProgressIndicator(false);
610     m_ui->showPanels();
611
612     emit userLocationReady(user);
613     emit friendsLocationsReady(friendsList);
614 }