git.maemo.org Git - situare/blob - src/facebookservice/facebookauthentication.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5        Ville Tiensuu - ville.tiensuu@ixonos.com
   6        Kaj Wallin - kaj.wallin@ixonos.com
   7        Henri Lampela - henri.lampela@ixonos.com
   8
   9    Situare is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU General Public License
  11    version 2 as published by the Free Software Foundation.
  12
  13    Situare is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Situare; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  21    USA.
  22 */
  23
  24 #ifndef FACEBOOKAUTHENTICATION_H
  25 #define FACEBOOKAUTHENTICATION_H
  26
  27 #include <QUrl>
  28
  29 class QNetworkReply;
  30 class QSslError;
  31 class QWebView;
  32
  33 class MainWindow;
  34
  35 /**
  36 * @brief FacebookAuthentication class takes care of Facebook login process. It creates
  37          QWebView instance and tries to login with cookies using hidden browser.
  38          If failed, then visible login browser dialog is invoked. Class also does parse the
  39          accuired credentials.
  40 *
  41 * @author Ville Tiensuu
  42 * @author Sami Rämö - sami.ramo (at) ixonos.com
  43 */
  44 class FacebookAuthentication : public QObject
  45 {
  46     Q_OBJECT
  47
  48 public:
  49     /**
  50     * @brief Constructor
  51     *
  52     * Initiates internal data members.
  53     *
  54     * @param mainWindow MainWindow instance
  55     * @param parent Instance of the parent
  56     */
  57     FacebookAuthentication(MainWindow *mainWindow, QObject *parent = 0);
  58
  59 /*******************************************************************************
  60  * MEMBER FUNCTIONS AND SLOTS
  61  ******************************************************************************/
  62 public slots:
  63     /**
  64     * @brief Clears account information from settings
  65     *
  66     * @param keepUsername keep = true, false otherwise
  67     */
  68     void clearAccountInformation(bool keepUsername = false);
  69
  70     /**
  71       * @brief Is the user currently logged in
  72       *
  73       * @returns True if the user is logged in, otherwise false
  74       */
  75     bool isLoggedIn();
  76
  77     /**
  78       * @brief Initiate login process
  79       *
  80       * Builds login browser and starts loading login URL.
  81       */
  82     void login();
  83
  84     /**
  85       * @brief Log out
  86       */
  87     void logOut();
  88
  89 private:
  90     /**
  91       * @brief Destroy login dialog and browser
  92       */
  93     void destroyLogin();
  94
  95     /**
  96       * @brief Parses the session information from the URL
  97       *
  98       * @param url URL
  99       * @returns Parsed session, or empty string if parsing failed.
 100       */
 101     QString parseSession(const QUrl &url);
 102
 103 private slots:
 104     /**
 105       * @brief Cleanup after browser is destructed
 106       *
 107       * Clears the pointer to the browser and disables the progress indicator.
 108       */
 109     void browserDestroyed();
 110
 111     /**
 112       * @brief Handler for login page loading errors
 113       *
 114       * @param reply Network reply
 115       */
 116     void networkReplyHandler(QNetworkReply *reply);
 117
 118     /**
 119       * @brief Handler for SSL errors, ignores the error
 120       */
 121     void sslErrors(QNetworkReply *reply, const QList<QSslError> &errors);
 122
 123     /**
 124       * @brief Handler for browser URL changes
 125       *
 126       * Does check the new URL and based on that invokes the login dialog with visible browser view
 127       * or parses the session from the new URL.
 128       *
 129       * @param url New URL
 130       */
 131     void urlChanged(const QUrl &url);
 132
 133 /*******************************************************************************
 134  * SIGNALS
 135  ******************************************************************************/
 136 signals:
 137     /**
 138     * @brief Signals error
 139     *
 140     * @param context error context
 141     * @param error error code
 142     */
 143     void error(const int context, const int error);
 144
 145     /**
 146       * @brief Emitted when logged in successfully
 147       *
 148       * All login related actions should be connected to this signal.
 149       *
 150       * @param session Session data
 151       */
 152     void loggedIn(const QString session);
 153
 154     /**
 155       * @brief Emitted when logged out
 156       *
 157       * All logout related actions should be connected to this signal.
 158       */
 159     void loggedOut();
 160
 161 /*******************************************************************************
 162  * DATA MEMBERS
 163  ******************************************************************************/
 164 private:
 165     bool m_loggedIn;                ///< Is the user currently logged in
 166     QWebView *m_browser;            ///< Login browser
 167     MainWindow *m_mainWindow;       ///< MainWindow
 168 };
 169
 170 #endif // FACEBOOKAUTHENTICATION_H