File indexing completed on 2024-04-21 15:32:07

 /** ===========================================================
  * @file
  *
  * This file is a part of KDE project
  * <a href="https://commits.kde.org/libmediawiki">libmediawiki</a>
  *
  * @date   2011-03-22
  * @brief  a MediaWiki C++ interface for KDE
  *
  * @author Copyright (C) 2011-2012 by Gilles Caulier
  *         <a href="mailto:caulier dot gilles at gmail dot com">caulier dot gilles at gmail dot com</a>
  * @author Copyright (C) 2011 by Manuel Campomanes
  *         <a href="mailto:campomanes dot manuel at gmail dot com">campomanes dot manuel at gmail dot com</a>
  * @author Copyright (C) 2010 by Alexandre Mendes
  *         <a href="mailto:alex dot mendes1988 at gmail dot com">alex dot mendes1988 at gmail dot com</a>
  *
  * This program is free software; you can redistribute it
  * and/or modify it under the terms of the GNU General
  * Public License as published by the Free Software Foundation;
  * either version 2, or (at your option)
  * any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
  *
  * ============================================================ */
 
 #ifndef MEDIAWIKI_LOGIN_H
 #define MEDIAWIKI_LOGIN_H
 
 // Qt includes
 
 #include <QString>
 #include <QNetworkCookieJar>
 
 // Local includes
 
 #include "job.h"
 #include "mediawiki_export.h"
 
 
 namespace mediawiki
 {
 
 class MediaWiki;
 class LoginPrivate;
 /**
  * @brief Login job.
  *
  * Uses for log in a user.
  */
 class MEDIAWIKI_EXPORT Login : public Job
 {
     Q_OBJECT
     Q_DECLARE_PRIVATE(Login)
 
 public:
 
     enum
     {
         /**
          * @brief You didn't set the login parameter
          */
         LoginMissing = Job::UserDefinedError + 1,
 
         /**
          * @brief You provided an illegal username
          */
         IllegalUsername,
 
         /**
          * @brief The username you provided doesn't exist
          */
         UsernameNotExists,
 
         /**
         * @brief You didn't set the lgpassword parameter or you left it empty
         */
         PasswordMissing,
 
         /**
         * @brief The password you provided is incorrect
         */
         WrongPassword,
 
         /**
         * @brief Same as WrongPass, returned when an authentication plugin rather than MediaWiki itself rejected the password
         */
         WrongPluginPassword,
 
         /**
         * @brief The wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation
         */
         IPAddressBlocked,
 
         /**
         * @brief You've logged in too many times in a short time.
         */
         TooManyConnections,
 
         /**
         * @brief User is blocked
         */
         UserBlocked,
 
         /**
         * @brief Either you did not provide the login token or the sessionid cookie. Request again with the token and cookie given in this response
         */
         TokenNeeded
     };
 
 public:
 
     /**
      * @brief Constructs a Login job.
      * @param mediawiki the mediawiki concerned by the job
      * @param login the QObject parent
      * @param password the QObject parent
      * @param parent the QObject parent
      */
     explicit Login(MediaWiki& mediawiki, const QString& login, const QString& password, QObject* const parent = nullptr);
 
     /**
      * @brief Destroys the Login job.
      */
     ~Login() override;
 
     /**
      * @brief Starts the job asynchronously.
      */
     void start() override;
 
 private Q_SLOTS:
 
     /**
      * @brief Send a request to get the token and the cookie.
      */
     void doWorkSendRequest();
 
     /**
      * @brief Reads the xml
      * if the attribute value is equal to "NeedToken", try to log in the user
      * else if the attribute value is equal to "Success", the user is logged in
      * @param success true if the connection was completed successfully.
      */
     void doWorkProcessReply();
 };
 
 } // namespace mediawiki
 
 #endif // LOGIN_H