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