2 Situare - A location system for Facebook
3 Copyright (C) 2010 Ixonos Plc. Authors:
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
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.
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.
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,
32 #include "coordinates/geocoordinate.h"
38 class FacebookAuthentication;
39 class FacebookCredentials;
40 class GeocodingService;
46 class NetworkAccessManager;
53 * @brief Engine class for Situare Application
55 * This class handles all the underlaying login of the Situare
58 class SituareEngine : public QObject
73 /*******************************************************************************
74 * MEMBER FUNCTIONS AND SLOTS
75 ******************************************************************************/
78 * @brief Slot to intercept error signal from ImageFetcher and SituareService
80 * @param context Error context
81 * @param error Error message
83 void error(const int context, const int error);
86 * @brief Slot to intercept signal when username is fetched from settings
89 void fetchUsernameFromSettings();
92 * @brief Slot to intercept signal when location search is issued
94 * @param location QString location
96 void locationSearch(QString location);
101 * @brief Slot to intercept signal when Login/Logout action is pressed
104 void loginActionPressed();
107 * @brief Slot to intercept signal from successful login
113 * @brief Slot to intercept signal when user has cancelled login process
115 void loginProcessCancelled();
118 * @brief Changes application state when logged out
124 * @brief Calls reverseGeo from SituareService to translate coordinates to street address
127 void requestAddress();
130 * @brief Calls updateLocation from SituareService to send the location update to
133 * @param status Status message
134 * @param publish Publish on Facebook
136 void requestUpdateLocation(const QString &status = QString(), bool publish = false);
139 * @brief Slot to refresh user data
141 void refreshUserData();
144 * @brief Slot to intercept signal from successful location update
147 void updateWasSuccessful();
150 * @brief Slot to intercept signal when new user data is available.
151 * Splits User and friendsList data and emits them as two different signals.
153 * @param user instance of User
154 * @param friendsList list of User instances (friends)
156 void userDataChanged(User *user, QList<User *> &friendsList);
160 * @brief Read settings and determine whether to use GPS and autocentering.
161 * When values does not found on the settings, GPS and autocentering are enabled as a default.
163 void initializeGpsAndAutocentering();
166 * @brief Connect signals coming from Facebook authenticator
168 void signalsFromFacebookAuthenticator();
171 * @brief Connect signals coming from GeocodingService
173 void signalsFromGeocodingService();
176 * @brief Connect signals coming from GPS
178 void signalsFromGPS();
181 * @brief Connect signals coming from MainWindow
183 void signalsFromMainWindow();
186 * @brief Connect signals coming from MapEngine
188 void signalsFromMapEngine();
191 * @brief Connect signals coming from MapView
193 void signalsFromMapView();
196 * @brief Connect signals coming from RoutingService
198 void signalsFromRoutingService();
201 * @brief Connect signals coming from Situare
203 void signalsFromSituareService();
207 * @brief Set auto centering feature enabled / disabled
209 * @param enabled true if enabled, false otherwise
211 void changeAutoCenteringSetting(bool enabled);
214 * @brief Slot for disabling automatic centering when map is scrolled manually
216 void disableAutoCentering();
219 * @brief Calls vibration feedback.
221 void draggingModeTriggered();
224 * @brief Enables automatic location update.
226 * @param enabled true if enabled, false otherwise
227 * @param updateIntervalMsecs update interval in milliseconds
229 void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
232 * @brief Slot to intercept signal when user's/friend's image is downloaded
234 * @param user Instance of user/friend
236 void imageReady(User *user);
239 * @brief Requests automatic update.
241 * Makes automatic location update request if user has moved enough.
243 * @param position geo coordinates
245 void requestAutomaticUpdateIfMoved(GeoCoordinate position);
248 * @brief Route is parsed and is ready for further processing.
250 * @param route Route item containing parsed route details
252 void routeParsed(Route &route);
255 * @brief Routes to geo coordinates.
257 * Uses map center coordinates as start point.
258 * @param endPointCoordinates end point geo coordinates
260 void routeTo(const GeoCoordinate &endPointCoordinates);
263 * @brief Route to current cursor position
265 void routeToCursor();
268 * @brief Slot for setting auto centering state.
270 * Calls gps to send last known position
272 * @param enabled true if auto centering was enabled, false otherwise
274 void setAutoCentering(bool enabled);
277 * @brief Sets zoom level to default when first GPS location is received if autocentering
280 void setFirstStartZoomLevel();
283 * @brief Slot for setting GPS state.
285 * @param enabled true if gps should be enabled, false otherwise
287 void setGPS(bool enabled);
290 * @brief Slot for setting power saving state.
292 * @param enabled true if enabled, false otherwise
294 void setPowerSaving(bool enabled);
297 * @brief Shows contact dialog.
299 * Calls MainWindow showContactDialog with contact guid defined by contact's Facebook ID.
300 * @param facebookId contact's facebookId
302 void showContactDialog(const QString &facebookId);
305 * @brief Automatic update interval timer timeout.
307 * Requests update location if user has moved.
309 void startAutomaticUpdate();
312 * @brief Called when topmost window is changed
314 * Does set power saving state.
316 * @param isMainWindow True if MainWindow is the topmost one
318 void topmostWindowChanged(bool isMainWindow);
320 /*******************************************************************************
322 ******************************************************************************/
325 * @brief Signals when automatic location update was enabled.
327 * @param enabled true if enabled, false otherwise
329 void automaticLocationUpdateEnabled(bool enabled);
332 * @brief Signal to clear locationUpdateDialog's data
335 void clearUpdateLocationDialogData();
338 * @brief Signal when direction and distance from current map center point to current GPS
339 * location is changed
341 * @param direction Direction in degrees
342 * @param distance Distance in meters
343 * @param draw Should the indicator triangle be drawn or not
345 void directionIndicatorValuesUpdate(qreal direction, qreal distance, bool draw);
348 * @brief Signals when new friends data is ready
350 * @param friendList List of User instances (friends)
352 void friendsLocationsReady(QList<User *> &friendList);
355 * @brief Signals when friend's image is ready
357 * @param user Instance of friend
359 void friendImageReady(User *user);
362 * @brief Emited when location request is parsed and is ready for further processing
364 * @param result List of Location items
366 void locationDataParsed(QList<Location> &result);
369 * @brief Signals when new user data is ready
371 * @param user Instance of User
373 void userLocationReady(User *user);
375 /*******************************************************************************
377 ******************************************************************************/
379 bool m_autoCenteringEnabled; ///< Auto centering flag
380 bool m_automaticUpdateFirstStart; ///< Automatic location update first start flag
381 bool m_automaticUpdateRequest; ///< Flag for automatic update request
382 bool m_userMoved; ///< Flag for user move
384 QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
386 ContactManager *m_contactManager; ///< Instance of contact manager
387 FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
388 GeocodingService *m_geocodingService; ///< Instance of the geocoding service
389 GeoCoordinate m_lastUpdatedGPSPosition; ///< Last updated GPS position
390 GPSPosition *m_gps; ///< Instance of the gps position
391 MainWindow *m_ui; ///< Instance of the MainWindow UI
392 MapEngine *m_mapEngine; ///< MapEngine
393 NetworkAccessManager *m_networkAccessManager; ///< NetworkAccessManager
394 RoutingService *m_routingService; ///< Instance of the routing service
395 SituareService *m_situareService; ///< Instance of the situare server communication service
396 MCE *m_mce; ///< Instance of the MCE