Modified automatic location update feature.
[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
27 #include "common.h"
28 #include "facebookservice/facebookauthentication.h"
29 #include "gps/gpsposition.h"
30 #include "map/mapengine.h"
31 #include "situareservice/situareservice.h"
32 #include "ui/mainwindow.h"
33 #include <cmath>
34
35 #include "engine.h"
36
37 const QString SETTINGS_GPS_ENABLED = "GPS_ENABLED"; ///< GPS setting
38 const QString SETTINGS_AUTO_CENTERING_ENABLED = "AUTO_CENTERING_ENABLED";///< Auto centering setting
39 const int DEFAULT_ZOOM_LEVEL_WHEN_GPS_IS_AVAILABLE = 12;  ///< Default zoom level when GPS available
40 const qreal USER_MOVEMENT_MINIMUM_LONGITUDE_DIFFERENCE = 0.003;///< Min value for user move latitude
41 const qreal USER_MOVEMENT_MINIMUM_LATITUDE_DIFFERENCE = 0.001;///< Min value for user move longitude
42 const int MIN_UPDATE_INTERVAL_MSECS = 5*60*1000;
43
44 SituareEngine::SituareEngine(QMainWindow *parent)
45     : QObject(parent),
46       m_autoCenteringEnabled(false),
47       m_automaticUpdateFirstStart(true),
48       m_loggedIn(false),
49       m_automaticUpdateIntervalTimer(0),
50       m_lastUpdatedGPSPosition(QPointF()),
51       m_userMoved(false),
52       m_automaticUpdateEnabled(false)
53 {
54     qDebug() << __PRETTY_FUNCTION__;
55     m_ui = new MainWindow;
56     m_ui->updateItemVisibility(m_loggedIn);
57
58     // build MapEngine
59     m_mapEngine = new MapEngine(this);
60     m_ui->setMapViewScene(m_mapEngine->scene());
61
62     // build GPS
63     m_gps = new GPSPosition(this);
64     m_gps->setMode(GPSPosition::Default);
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     initializeGpsAndAutocentering();
103 }
104
105 SituareEngine::~SituareEngine()
106 {
107     qDebug() << __PRETTY_FUNCTION__;
108
109     delete m_ui;
110
111     QSettings settings(DIRECTORY_NAME, FILE_NAME);
112     settings.setValue(SETTINGS_GPS_ENABLED, m_gps->isRunning());
113     settings.setValue(SETTINGS_AUTO_CENTERING_ENABLED, m_autoCenteringEnabled);
114 }
115
116 void SituareEngine::automaticUpdateIntervalTimerTimeout()
117 {
118     qDebug() << __PRETTY_FUNCTION__;
119
120     if (m_gps->isRunning() && m_userMoved) {
121         requestUpdateLocation();
122         m_userMoved = false;
123     }
124 }
125
126 void SituareEngine::changeAutoCenteringSetting(bool enabled)
127 {
128     qDebug() << __PRETTY_FUNCTION__;
129
130     m_autoCenteringEnabled = enabled;
131     enableAutoCentering(enabled);
132 }
133
134 void SituareEngine::disableAutoCentering()
135 {
136     qDebug() << __PRETTY_FUNCTION__;
137
138     changeAutoCenteringSetting(false);
139     m_ui->buildInformationBox(tr("Auto centering disabled"));
140 }
141
142 void SituareEngine::enableAutoCentering(bool enabled)
143 {
144     qDebug() << __PRETTY_FUNCTION__;
145
146     m_ui->setAutoCenteringButtonEnabled(enabled);
147     m_mapEngine->setAutoCentering(enabled);
148
149     if (enabled)
150         m_gps->requestLastPosition();
151 }
152
153 void SituareEngine::enableGPS(bool enabled)
154 {
155     qDebug() << __PRETTY_FUNCTION__;
156
157     m_ui->setGPSButtonEnabled(enabled);
158     m_mapEngine->setGPSEnabled(enabled);
159
160     if (enabled && !m_gps->isRunning()) {
161         m_gps->start();
162         enableAutoCentering(m_autoCenteringEnabled);
163         m_gps->requestLastPosition();
164
165         if (!m_automaticUpdateEnabled && m_loggedIn)
166             m_ui->requestAutomaticLocationUpdateSettings();
167     }
168     else if (!enabled && m_gps->isRunning()) {
169         m_gps->stop();
170         enableAutoCentering(false);
171         enableAutomaticLocationUpdate(false);
172     }
173 }
174
175 void SituareEngine::enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs)
176 {
177     qDebug() << __PRETTY_FUNCTION__;
178
179     m_automaticUpdateEnabled = enabled;
180
181     //Show automatic update confirmation dialog
182     if (m_automaticUpdateFirstStart && m_gps->isRunning() && m_automaticUpdateEnabled) {
183         m_ui->showEnableAutomaticUpdateLocationDialog(
184                 tr("Do you want to enable automatic location update with %1 min update interval?")
185                 .arg(updateIntervalMsecs/1000/60));
186         m_automaticUpdateFirstStart = false;
187     } else {
188         if (m_automaticUpdateEnabled && m_gps->isRunning()) {
189             m_ui->buildInformationBox(tr("Automatic location update enabled"));
190             if (updateIntervalMsecs < MIN_UPDATE_INTERVAL_MSECS)
191                 m_automaticUpdateIntervalTimer->setInterval(MIN_UPDATE_INTERVAL_MSECS);
192             else
193                 m_automaticUpdateIntervalTimer->setInterval(updateIntervalMsecs);
194
195             m_automaticUpdateIntervalTimer->start();
196
197         } else {
198             m_automaticUpdateIntervalTimer->stop();
199         }
200     }
201 }
202
203 void SituareEngine::error(const QString &error)
204 {
205     qDebug() << __PRETTY_FUNCTION__;
206     qDebug() << "ERROR MESSAGE: " << error;
207
208     m_ui->buildInformationBox(error, true);
209
210     if(error.compare(SESSION_EXPIRED) == 0) {
211         m_facebookAuthenticator->clearAccountInformation(true); // keep username = true
212         m_ui->loggedIn(false);
213         m_ui->loginFailed();
214     }
215 }
216
217 void SituareEngine::fetchUsernameFromSettings()
218 {
219     qDebug() << __PRETTY_FUNCTION__;
220
221     m_ui->setUsername(m_facebookAuthenticator->loadUsername());
222 }
223
224 void SituareEngine::initializeGpsAndAutocentering()
225 {
226     qDebug() << __PRETTY_FUNCTION__;
227
228     QSettings settings(DIRECTORY_NAME, FILE_NAME);
229     QVariant gpsEnabled = settings.value(SETTINGS_GPS_ENABLED);
230     QVariant autoCenteringEnabled = settings.value(SETTINGS_AUTO_CENTERING_ENABLED);     
231
232     if (gpsEnabled.toString().isEmpty()) { // First start. Situare.conf file does not exists
233
234         connect(m_gps, SIGNAL(position(QPointF,qreal)),
235                 this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
236
237         changeAutoCenteringSetting(true);
238         enableGPS(true);
239
240         m_ui->buildInformationBox(tr("GPS enabled"));
241         m_ui->buildInformationBox(tr("Auto centering enabled"));
242
243     } else { // Normal start
244         changeAutoCenteringSetting(autoCenteringEnabled.toBool());
245         enableGPS(gpsEnabled.toBool());
246
247         if (gpsEnabled.toBool())
248             m_ui->buildInformationBox(tr("GPS enabled"));
249
250         if (gpsEnabled.toBool() && autoCenteringEnabled.toBool())
251             m_ui->buildInformationBox(tr("Auto centering enabled"));
252     }
253 }
254
255 bool SituareEngine::isUserMoved()
256 {
257     qDebug() << __PRETTY_FUNCTION__;
258
259     return m_userMoved;
260 }
261
262 void SituareEngine::loginActionPressed()
263 {
264     qDebug() << __PRETTY_FUNCTION__;
265
266     if(m_loggedIn) {
267         logout();
268         m_situareService->clearUserData();
269     }
270     else {
271         m_facebookAuthenticator->start();
272     }
273 }
274
275 void SituareEngine::loginOk()
276 {
277     qDebug() << __PRETTY_FUNCTION__;
278
279     m_loggedIn = true;
280     m_ui->loggedIn(m_loggedIn);
281
282     m_ui->show();
283     m_situareService->fetchLocations(); // request user locations
284
285     if (m_gps->isRunning())
286         m_ui->requestAutomaticLocationUpdateSettings();
287 }
288
289 void SituareEngine::loginProcessCancelled()
290 {
291     qDebug() << __PRETTY_FUNCTION__;
292
293     m_ui->toggleProgressIndicator(false);
294     m_ui->updateItemVisibility(m_loggedIn);
295 }
296
297 void SituareEngine::logout()
298 {
299     qDebug() << __PRETTY_FUNCTION__;
300
301     m_loggedIn = false;
302     m_ui->loggedIn(m_loggedIn);
303     m_facebookAuthenticator->clearAccountInformation(); // clear all
304     m_automaticUpdateEnabled = false;
305     m_automaticUpdateFirstStart = true;
306 }
307
308 void SituareEngine::refreshUserData()
309 {
310     qDebug() << __PRETTY_FUNCTION__;
311
312     m_ui->toggleProgressIndicator(true);
313
314     m_situareService->fetchLocations();
315 }
316
317 void SituareEngine::requestAddress()
318 {
319     qDebug() << __PRETTY_FUNCTION__;
320
321     if (m_gps->isRunning())
322         m_situareService->reverseGeo(m_gps->lastPosition());
323     else
324         m_situareService->reverseGeo(m_mapEngine->centerGeoCoordinate());
325 }
326
327 void SituareEngine::requestUpdateLocation(const QString &status, bool publish)
328 {
329     qDebug() << __PRETTY_FUNCTION__;
330
331     m_ui->toggleProgressIndicator(true);
332
333     if (m_gps->isRunning())
334         m_situareService->updateLocation(m_gps->lastPosition(), status, publish);
335     else
336         m_situareService->updateLocation(m_mapEngine->centerGeoCoordinate(), status, publish);
337 }
338
339 void SituareEngine::saveGPSPosition(QPointF position)
340 {
341     qDebug() << __PRETTY_FUNCTION__;
342
343     if ((fabs(m_lastUpdatedGPSPosition.x() - position.x()) >
344          USER_MOVEMENT_MINIMUM_LONGITUDE_DIFFERENCE) ||
345         (fabs(m_lastUpdatedGPSPosition.y() - position.y()) >
346          USER_MOVEMENT_MINIMUM_LATITUDE_DIFFERENCE)) {
347
348         m_lastUpdatedGPSPosition = position;
349         m_userMoved = true;
350     }
351 }
352
353 void SituareEngine::setFirstStartZoomLevel(QPointF latLonCoordinate, qreal accuracy)
354 {
355     qDebug() << __PRETTY_FUNCTION__;
356
357     Q_UNUSED(latLonCoordinate);
358     Q_UNUSED(accuracy);
359
360     if (m_autoCenteringEnabled) // autocentering is disabled when map is scrolled        
361         m_mapEngine->setZoomLevel(DEFAULT_ZOOM_LEVEL_WHEN_GPS_IS_AVAILABLE);
362
363     disconnect(m_gps, SIGNAL(position(QPointF,qreal)),
364                this, SLOT(setFirstStartZoomLevel(QPointF,qreal)));
365 }
366
367 void SituareEngine::signalsFromFacebookAuthenticator()
368 {
369     qDebug() << __PRETTY_FUNCTION__;
370
371     connect(m_facebookAuthenticator, SIGNAL(error(QString)),
372             this, SLOT(error(QString)));
373
374     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
375             m_situareService, SLOT(credentialsReady(FacebookCredentials)));
376
377     connect(m_facebookAuthenticator, SIGNAL(credentialsReady(FacebookCredentials)),
378             this, SLOT(loginOk()));
379
380     connect(m_facebookAuthenticator, SIGNAL(newLoginRequest()),
381             m_ui, SLOT(startLoginProcess()));
382
383     connect(m_facebookAuthenticator, SIGNAL(loginFailure()),
384             m_ui, SLOT(loginFailed()));
385
386     connect(m_facebookAuthenticator, SIGNAL(saveCookiesRequest()),
387             m_ui, SLOT(saveCookies()));
388
389     connect(m_facebookAuthenticator, SIGNAL(loginUsingCookies()),
390             m_ui, SLOT(loginUsingCookies()));
391 }
392
393 void SituareEngine::signalsFromGPS()
394 {
395     qDebug() << __PRETTY_FUNCTION__;
396
397     connect(m_gps, SIGNAL(position(QPointF,qreal)),
398             m_mapEngine, SLOT(gpsPositionUpdate(QPointF,qreal)));
399
400     connect(m_gps, SIGNAL(timeout()),
401             m_ui, SLOT(gpsTimeout()));
402
403     connect(m_gps, SIGNAL(error(QString)),
404             this, SLOT(error(QString)));
405
406     connect(m_gps, SIGNAL(position(QPointF,qreal)),
407             this, SLOT(saveGPSPosition(QPointF)));
408 }
409
410 void SituareEngine::signalsFromMainWindow()
411 {
412     qDebug() << __PRETTY_FUNCTION__;    
413
414     connect(m_ui, SIGNAL(fetchUsernameFromSettings()),
415             this, SLOT(fetchUsernameFromSettings()));
416
417     connect(m_ui, SIGNAL(loginActionPressed()),
418             this, SLOT(loginActionPressed()));
419
420     connect(m_ui, SIGNAL(saveUsername(QString)),
421             m_facebookAuthenticator, SLOT(saveUsername(QString)));
422
423     connect(m_ui, SIGNAL(updateCredentials(QUrl)),
424             m_facebookAuthenticator, SLOT(updateCredentials(QUrl)));
425
426     // signals from map view
427     connect(m_ui, SIGNAL(mapViewScrolled(QPoint)),
428             m_mapEngine, SLOT(setLocation(QPoint)));
429
430     connect(m_ui, SIGNAL(mapViewResized(QSize)),
431             m_mapEngine, SLOT(viewResized(QSize)));
432
433     connect(m_ui, SIGNAL(viewZoomFinished()),
434             m_mapEngine, SLOT(viewZoomFinished()));
435
436     // signals from zoom buttons (zoom panel and volume buttons)
437     connect(m_ui, SIGNAL(zoomIn()),
438             m_mapEngine, SLOT(zoomIn()));
439
440     connect(m_ui, SIGNAL(zoomOut()),
441             m_mapEngine, SLOT(zoomOut()));
442
443     // signals from menu buttons
444     connect(m_ui, SIGNAL(autoCenteringTriggered(bool)),
445             this, SLOT(changeAutoCenteringSetting(bool)));
446
447     connect(m_ui, SIGNAL(gpsTriggered(bool)),
448             this, SLOT(enableGPS(bool)));
449
450     //signals from dialogs
451     connect(m_ui, SIGNAL(cancelLoginProcess()),
452             this, SLOT(loginProcessCancelled()));
453
454     connect(m_ui, SIGNAL(requestReverseGeo()),
455             this, SLOT(requestAddress()));
456
457     connect(m_ui, SIGNAL(statusUpdate(QString,bool)),
458             this, SLOT(requestUpdateLocation(QString,bool)));
459
460     connect(m_ui, SIGNAL(enableAutomaticLocationUpdate(bool, int)),
461             this, SLOT(enableAutomaticLocationUpdate(bool, int)));    
462
463     // signals from user info tab
464     connect(m_ui, SIGNAL(refreshUserData()),
465             this, SLOT(refreshUserData()));
466
467     connect (m_ui, SIGNAL(notificateUpdateFailing(QString)),
468              this, SLOT(error(QString)));
469
470     connect(m_ui, SIGNAL(findUser(QPointF)),
471             m_mapEngine, SLOT(setViewLocation(QPointF)));
472
473     // signals from friend list tab
474     connect(m_ui, SIGNAL(findFriend(QPointF)),
475             m_mapEngine, SLOT(setViewLocation(QPointF)));
476 }
477
478 void SituareEngine::signalsFromMapEngine()
479 {
480     qDebug() << __PRETTY_FUNCTION__;
481
482     connect(m_mapEngine, SIGNAL(error(QString)),
483             this, SLOT(error(QString)));
484
485     connect(m_mapEngine, SIGNAL(locationChanged(QPoint)),
486             m_ui, SIGNAL(centerToSceneCoordinates(QPoint)));
487
488     connect(m_mapEngine, SIGNAL(zoomLevelChanged(int)),
489             m_ui, SIGNAL(zoomLevelChanged(int)));
490
491     connect(m_mapEngine, SIGNAL(mapScrolledManually()),
492             this, SLOT(disableAutoCentering()));
493
494     connect(m_mapEngine, SIGNAL(maxZoomLevelReached()),
495             m_ui, SIGNAL(maxZoomLevelReached()));
496
497     connect(m_mapEngine, SIGNAL(minZoomLevelReached()),
498             m_ui, SIGNAL(minZoomLevelReached()));
499
500     connect(m_mapEngine, SIGNAL(locationItemClicked(QList<QString>)),
501             m_ui, SIGNAL(locationItemClicked(QList<QString>)));
502
503     connect(m_mapEngine, SIGNAL(newMapResolution(qreal)),
504             m_ui, SIGNAL(newMapResolution(qreal)));
505 }
506
507 void SituareEngine::signalsFromSituareService()
508 {
509     qDebug() << __PRETTY_FUNCTION__;
510
511     connect(m_situareService, SIGNAL(error(QString)),
512             this, SLOT(error(QString)));
513
514     connect(m_situareService, SIGNAL(reverseGeoReady(QString)),
515             m_ui, SIGNAL(reverseGeoReady(QString)));
516
517     connect(m_situareService, SIGNAL(userDataChanged(User*, QList<User*>&)),
518             this, SLOT(userDataChanged(User*, QList<User*>&)));
519
520     connect(m_situareService, SIGNAL(updateWasSuccessful()),
521             this, SLOT(updateWasSuccessful()));
522
523     connect(m_situareService, SIGNAL(updateWasSuccessful()),
524             m_ui, SIGNAL(updateWasSuccessful()));
525
526     connect(m_situareService, SIGNAL(error(QString)),
527             m_ui, SIGNAL(messageSendingFailed(QString)));
528 }
529
530 void SituareEngine::updateWasSuccessful()
531 {
532     qDebug() << __PRETTY_FUNCTION__;
533
534     m_situareService->fetchLocations();
535 }
536
537 void SituareEngine::userDataChanged(User *user, QList<User *> &friendsList)
538 {
539     qDebug() << __PRETTY_FUNCTION__;
540
541     m_ui->toggleProgressIndicator(false);
542
543     emit userLocationReady(user);
544     emit friendsLocationsReady(friendsList);
545 }