vcs.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 Loads username from settings
  66     *
  67     * @return QString Loaded username
  68     */
  69     const QString loadUsername();
  70
  71     /**
  72     * @brief Saves username to settings
  73     *
  74     * @param username Username to be saved
  75     */
  76     void saveUsername(const QString &username);
  77
  78     /**
  79     * @brief Shows the m_webView and loads page that is specified in the m_facebookLoginPage
  80     *        variable. Specifies font size for the page.
  81     *
  82     */
  83     void start();
  84
  85     /**
  86     * @brief Clears account iformation from settings
  87     *
  88     */
  89     void clearAccountInformation();
  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     /**
 102     * @brief Reads previous stored credentials from file.
 103     *
 104     * @param credentialsFromFile This dataclass is the place where method stores credentials.
 105     *        Corrent parameter here is m_loginCredentials
 106     */
 107     void readCredentials(FacebookCredentials &credentialsFromFile);
 108
 109     /**
 110     * @brief Checks expiration time of credentials and compares it to current time.
 111     *
 112     * @param credentials this parameter represents credentials that will be verified.
 113     * @return bool returns true if expiration time is after current time. in other cases returns
 114     *               false.
 115     */
 116     bool verifyCredentials(const FacebookCredentials &credentials) const;
 117
 118     /**
 119     * @brief Writes credentials to File
 120     *
 121     * @param credentials Contents of this dataclass is stored to file
 122     */
 123     void writeCredentials(const FacebookCredentials &credentials);
 124
 125 private slots:
 126
 127     /**
 128     * @brief  Search credentials from URL that is given as parameter.
 129     *         If credentials are found thay are stored to loginCredentials variable.
 130     *
 131     * @param url URL where this method tries to find credentials.
 132     * @return bool if credentials are found returns true,
 133     *               if credentials are not found returns false.
 134     */
 135     bool updateCredentials(const QUrl & url);
 136
 137 /*******************************************************************************
 138  * SIGNALS
 139  ******************************************************************************/
 140
 141 signals:
 142
 143     /**
 144     * @brief This signal is emitted if updateCredentials method finds credentials from URL.
 145     *        Signal is also emitted at the beginning of the program if there is valid credentials
 146     *        in the file.
 147     *
 148     * @param freshLogin Was login done via login dialog
 149     * @param credentials New credentials
 150     */
 151     void credentialsReady(bool freshLogin, const FacebookCredentials &credentials);
 152
 153     /**
 154     * @brief Signals changed credentials
 155     *
 156     * @param credentials New credentials
 157     */
 158     void credentialsChanged(const FacebookCredentials &credentials);
 159
 160     /**
 161     * @brief This signal is emitted if updateCredentials method can't find credentials from URL
 162     *
 163     */
 164     void loginFailure();
 165
 166     /**
 167     * @brief Signals when credentials are invalid new login is needed
 168     *
 169     * @param url Login page url
 170     */
 171     void newLoginRequest(const QUrl &url);
 172
 173 /*******************************************************************************
 174  * DATA MEMBERS
 175  ******************************************************************************/
 176
 177 private:
 178
 179     int m_loginAttempts; ///< Indicates login attempts
 180
 181     /**
 182     * @brief Dataclass that contains authorization to use facebook. Dataclass is composed of five
 183     *        QStrings and setters and getters.
 184     *
 185     * @var m_loginCredentials
 186     */
 187     FacebookCredentials m_loginCredentials;
 188 };
 189
 190 #endif // FACEBOOKAUTHENTICATION_H