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 #include "facebookcredentials.h"
  29
  30 /**
  31 * @brief FacebookAuthentication class takes care of parsing and handling of  credentials for
  32 *        Facebook. Other components of Situare application needs credentials to communicate with
  33 *        facebook.
  34 *
  35 * @author Ville Tiensuu
  36 */
  37 class FacebookAuthentication : public QObject
  38 {
  39     Q_OBJECT
  40
  41 public:
  42     /**
  43     * @brief FacebookAuthentication constructor
  44     *
  45     * -Checks if there is valid credentials stored on the file. If there is emits signal.
  46     *
  47     * @param parent instance of parent
  48     */
  49     FacebookAuthentication(QObject *parent = 0);
  50
  51 /*******************************************************************************
  52  * MEMBER FUNCTIONS AND SLOTS
  53  ******************************************************************************/
  54
  55     /**
  56     * @brief Getter for m_loginCredentials
  57     *
  58     * @return FacebookCredentials
  59     */
  60     FacebookCredentials loginCredentials() const;
  61
  62 public slots:
  63
  64     /**
  65     * @brief Clears account iformation from settings
  66     *
  67     */
  68     void clearAccountInformation();
  69
  70     /**
  71     * @brief Loads username from settings
  72     *
  73     * @return QString Loaded username
  74     */
  75     const QString loadUsername();
  76
  77     /**
  78     * @brief Saves username to settings
  79     *
  80     * @param username Username to be saved
  81     */
  82     void saveUsername(const QString &username);
  83
  84     /**
  85     * @brief Shows the m_webView and loads page that is specified in the m_facebookLoginPage
  86     *        variable. Specifies font size for the page.
  87     *
  88     */
  89     void start();
  90
  91 private:
  92
  93     /**
  94     * @brief Creates login url with given parameters
  95     *
  96     * @param urlParts Url parts
  97     * @return QUrl Login page url
  98     */
  99     QUrl formLoginPageUrl(const QStringList & urlParts) const;
 100
 101 private slots:
 102
 103     /**
 104     * @brief  Search credentials from URL that is given as parameter.
 105     *         If credentials are found thay are stored to loginCredentials variable.
 106     *
 107     * @param url URL where this method tries to find credentials.
 108     * @return bool if credentials are found returns true,
 109     *               if credentials are not found returns false.
 110     */
 111     bool updateCredentials(const QUrl & url);
 112
 113 /*******************************************************************************
 114  * SIGNALS
 115  ******************************************************************************/
 116
 117 signals:
 118
 119     /**
 120     * @brief This signal is emitted if updateCredentials method finds credentials from URL.
 121     *        Signal is also emitted at the beginning of the program if there is valid credentials
 122     *        in the file.
 123     *
 124     * @param credentials New credentials
 125     */
 126     void credentialsReady(const FacebookCredentials &credentials);
 127
 128     /**
 129     * @brief This signal is emitted if updateCredentials method can't find credentials from URL
 130     *
 131     */
 132     void loginFailure();
 133
 134     void loginUsingCookies();
 135
 136     /**
 137     * @brief Signals when credentials are invalid new login is needed
 138     *
 139     * @param url Login page url
 140     */
 141     void newLoginRequest(const QUrl &url);
 142
 143     void saveCookiesRequest();
 144
 145 /*******************************************************************************
 146  * DATA MEMBERS
 147  ******************************************************************************/
 148
 149 private:
 150
 151     int m_loginAttempts; ///< Indicates login attempts
 152
 153     /**
 154     * @brief Dataclass that contains authorization to use facebook. Dataclass is composed of five
 155     *        QStrings and setters and getters.
 156     *
 157     * @var m_loginCredentials
 158     */
 159     FacebookCredentials m_loginCredentials;
 160 };
 161
 162 #endif // FACEBOOKAUTHENTICATION_H