Ticket #90: reconnect.patch

src/network/msnsocketbase.h

@@ -56 +56 @@
     , ERROR_DROP                   /// The connection was dropped
     , ERROR_DATA                   /// An error within the data was received
     , ERROR_CONNECTION_TIME_LIMIT  /// The connection was not successful within the time limit
+    , ERROR_CONNECTION_OTHER       /// The current account has connected from elsewhere, disconnecting us
     , ERROR_AUTH_TIME_LIMIT        /// The authentication/login was not successful within the time limit
+    , ERROR_AUTH_LOGIN             /// The authentication/login failed due to wrong username or password
     /// The next are server-reported errors
     , ERROR_USER                   /// An error caused by the user
     , ERROR_SERVER                 /// Server error

src/network/msnsockettcp.cpp

@@ -22 +22 @@
 #include <QHostAddress>
 
 #include <KLocale>
-#include <KMessageBox>
 
 #include "../currentaccount.h"
 #include "../kmessdebug.h"
@@ -384 +383 @@
   // Assume the connection was lost when 3 pings are missed.
   if ( missedPings_ == 3 )
   {
-    KMessageBox::error( 0, i18n("The connection to the server was lost.") );
-    disconnectFromServer( false );
+    // Bounce back to the unified error handler to disconnect and give the user a message
+    emit error( i18n( "The connection to the server was lost" ), MsnSocketBase::ERROR_DROP );
   }
 
   writeData( "PNG\r\n" );

src/network/msnnotificationconnection.cpp

@@ -1308 +1308 @@
 
 
 
-// Received notice of disconnetion from the server
+// Received notice of disconnection from the server
 void MsnNotificationConnection::gotOut(const QStringList& command)
 {
-  // If the first word is "OTH", it means that this user connected from elsewhere.
-  if ( command[1] == "OTH" )
+  // If the first command parameter is "OTH", it means that this account has connected from elsewhere.
+  if( command[1] == "OTH" )
   {
-    KMessageBox::error( 0, i18n("<p>You have been disconnected!</p><p>You connected with this account from another Messenger client, or from another location.</p>") );
+    slotError( i18n( "<p>You have been disconnected!</p>"
+                     "<p>You connected with this account from another Messenger client,"
+                     "or from another location.</p>" ),
+               MsnSocketBase::ERROR_CONNECTION_OTHER );
+
+    // Don't try reconnecting when connected from elsewhere.
   }
+  else
+  {
+    closeConnection();
 
-  closeConnection();
+    // Try connecting again
+    emit reconnect( currentAccount_->getHandle() );
+  }
 }
 
 
@@ -1890 +1900 @@
   // NOTE: a similar thing also happens in soapRequestFailed(),
   // but for fatal SOAP errors.
 
-  // Show a message to the user, before deleting the object!
-  KMessageBox::error( 0, i18n("Authentication failed, please verify your account name and password.") );
-
-  // Close the connection attempt.
-  closeConnection();
+  slotError( i18n("<p>Authentication has failed, please verify your account name and password.</p>"), MsnSocketBase::ERROR_AUTH_LOGIN );
 }
 
 
@@ -3210 +3216 @@
   kWarning() << "KMess Error ( type" << type << "):" << error << "!";
 
   int result;
+  bool tryReconnecting = true;
   QString additionalInfo;
   QString dialogTitle = i18nc( "Error dialog box title", "MSN error" );
 
@@ -3232 +3239 @@
   // Then decide what kind of message to show
   switch( type )
   {
+      // Notify that connecting has failed due to a wrong handle or password
+    case MsnSocketBase::ERROR_CONNECTION_OTHER:
+    case MsnSocketBase::ERROR_AUTH_LOGIN:
+      KMessageBox::error( 0, i18nc( "Connection error dialog box", "%1", error ), dialogTitle );
+      // Do not attempt to reconnect
+      tryReconnecting = false;
+      break;
+
     case MsnSocketBase::ERROR_CONNECTION_TIME_LIMIT:
     case MsnSocketBase::ERROR_CONNECTING:
       // Continue as for authentication errors if the switch to HTTP had failed
@@ -3266 +3281 @@
     case MsnSocketBase::ERROR_DATA:
     case MsnSocketBase::ERROR_UNKNOWN:
     default:
-      KMessageBox::error(0, i18nc( "Connection error message, with more details for developer versions",
-                                   "<p>Connection to the MSN server has been lost.%1</p>", additionalInfo ), dialogTitle );
+      KMessageBox::error( 0, i18nc( "Connection error message, with more details for developer versions",
+                                    "<p>Connection to the MSN server has been lost.%1</p>", additionalInfo ), dialogTitle );
       break;
   }
+
+  // Try connecting again
+  if( tryReconnecting )
+  {
+    emit reconnect( currentAccount_->getHandle() );
+  }
 }
 
 

src/network/msnnotificationconnection.h

@@ -329 +329 @@
     void                 contactAddedUser(const Contact *contact);
     // Signal that a new email has been received
     void                 newEmail(QString sender, QString subject, bool inInbox, QString command, QString folder, QString url);
+    // Signal that the connection should be established again after a disconnection
+    void                 reconnect( QString handle );
     // A new switchboard with a contact has been opened
     void                 startSwitchboard( const ChatInformation &chatInfo );
 

src/kmess.cpp

@@ -1695 +1695 @@
   connect( initialView_, SIGNAL(                                  disconnectClicked() ),
            this,         SLOT  (                                  disconnectClicked() ) );
 
-  connect( msnNotificationConnection_, SIGNAL( statusMessage(QString,bool) ),
-           initialView_,               SLOT  ( statusMessage(QString)      ) );
+  connect( msnNotificationConnection_, SIGNAL(            reconnect(QString)      ),
+           initialView_,               SLOT  ( scheduleReconnection(QString)      ) );
+  connect( msnNotificationConnection_, SIGNAL(        statusMessage(QString,bool) ),
+           initialView_,               SLOT  (        statusMessage(QString)      ) );
 
 
   // Set it as the window's main widget

src/initialview.cpp

@@ -29 +29 @@
 #include <KLocale>
 #include <KStandardDirs>
 
+/**
+ * Reconnection timeout
+ *
+ * This number is the time, expressed in seconds, after which a connection is attempted again
+ */
+#ifndef RECONNECTION_TIME
+  #define RECONNECTION_TIME        30
+#endif
 
 
+
 // The constructor
 InitialView::InitialView( QWidget *parent )
  : QWidget( parent )
  , Ui::InitialView()
+ , hasNetworkConnection_()
  , isConnecting_( false )
 {
   // Set up the UI first
@@ -110 +120 @@
   connect( AccountsManager::instance(), SIGNAL( passwordsReady() ),
            this,                        SLOT  (     updateView() ) );
 
+  // When the reconnection timer fires, update the timer in the UI or connect if it's time to
+  connect( &reconnectTimer_,            SIGNAL(   timeout() ),
+           this,                        SLOT  ( reconnect() ) );
+
   // The status is needed only later
   statusLabel_->hide();
 
@@ -195 +209 @@
 
 
 /**
+ * @brief Connect again after being disconnected
+ *
+ * This method updates the timer in the UI and connects if the time has passed
+ */
+void InitialView::reconnect()
+{
+  int elapsedTime = ( reconnectElapsedTime_.elapsed() / 1000 );
+
+  if( elapsedTime <= RECONNECTION_TIME )
+  {
+    statusMessage( i18n( "Reconnecting in %1 seconds...", ( RECONNECTION_TIME - elapsedTime ) ) );
+    return;
+  }
+
+#ifdef KMESSDEBUG_INITIALVIEW
+  kDebug() << "Starting reconnection.";
+#endif
+
+  // The time has passed, try connecting again
+  reconnectTimer_.stop();
+
+  // This is needed to force the Connect button to behave like a Connect button
+  isConnecting_ = false;
+
+  // Connect to the selected account
+  slotConnectClicked();
+}
+
+
+
+/**
+ * @brief Automatically reconnect with a specified account
+ *
+ * This method schedules a timed reconnection to an account
+ *
+ * @param handle  The email address of the account to reconnect
+ */
+void InitialView::scheduleReconnection( QString handle )
+{
+#ifdef KMESSDEBUG_INITIALVIEW
+  kDebug() << "Scheduling reconnection for account" << handle;
+#endif
+
+  Account *account = accounts_[ handle ];
+  if( account == 0 )
+  {
+#ifdef KMESSDEBUG_INITIALVIEW
+    kDebug() << "Account not found, aborting.";
+#endif
+    return;
+  }
+
+  // If the network connection goes down, reconnect after it comes back up
+  doReconnectWithAccount_ = handle;
+  if( isConnecting_ || ! hasNetworkConnection_ )
+  {
+#ifdef KMESSDEBUG_INITIALVIEW
+    kDebug() << "Cannot schedule a reconnection now, postponing the action."
+                "(is connecting:" << isConnecting_ << ",has network:" << hasNetworkConnection_ << ")";
+#endif
+    return;
+  }
+
+  // Change the UI to the connecting mode
+  startedConnecting( handle );
+
+  // Start the timed reconnection mechanism
+  reconnectElapsedTime_.start();
+  reconnectTimer_.start();
+
+  // Change the text of the Connect button
+  connectButton_->setText( i18n( "&Cancel" ) );
+}
+
+
+
+/**
  * @brief Update the view when the network connection status changes
  *
  * This method receives KDE's Solid network connection status changes, and updates the view's widgets
@@ -205 +296 @@
 void InitialView::slotConnectionStatusChanged( Solid::Networking::Status newStatus )
 {
   // If Solid is unable to retrieve the status, assume we're connected
-  bool isConnected = ( newStatus == Solid::Networking::Connected || newStatus == Solid::Networking::Unknown );
+  hasNetworkConnection_ = ( newStatus == Solid::Networking::Connected || newStatus == Solid::Networking::Unknown );
 
-  connectButton_->setEnabled( isConnected );
+#ifdef KMESSDEBUG_INITIALVIEW
+  if( newStatus == Solid::Networking::Unknown )
+  {
+    kDebug() << "Cannot determine network status from Solid, assuming we're connected.";
+  }
+  else
+  {
+    kDebug() << "The network connection is now" << (hasNetworkConnection_?"active":"disabled") << ".";
+  }
+#endif
 
-  if( isConnected && ! isConnecting_ )
+  connectButton_->setEnabled( hasNetworkConnection_ );
+
+  if( hasNetworkConnection_ )
   {
-    statusLabel_->setVisible( false );
-    statusMessage( QString() );
+    if( ! isConnecting_ )
+    {
+#ifdef KMESSDEBUG_INITIALVIEW
+      kDebug() << "Was not connecting, enabling back the UI.";
+#endif
+      setEnabled( true );
+
+      if( ! doReconnectWithAccount_.isEmpty() )
+      {
+#ifdef KMESSDEBUG_INITIALVIEW
+        kDebug() << "Reconnection was needed.";
+#endif
+        scheduleReconnection( doReconnectWithAccount_ );
+      }
+    }
   }
   else
   {
     if( isConnecting_ )
     {
+#ifdef KMESSDEBUG_INITIALVIEW
+      kDebug() << "Was trying to connect, stopping.";
+#endif
       // Force a disconnection
       connectButton_->click();
     }
 
+    // Avoid the reconnection timer to try connecting even if no connection is available
+    reconnectTimer_.stop();
+
+    setEnabled( false );
     statusLabel_->setVisible( true );
     statusMessage( i18n("Internet connection not available.") );
   }

src/initialview.h

@@ -22 +22 @@
 #include "contact/msnstatus.h"
 
 #include <QHash>
+#include <QTime>
+#include <QTimer>
 
 #include <Solid/Networking>
 
@@ -62 +64 @@
   public slots: // Public slots
     // A profile was selected from the drop-down list, or written manually.
     void                 updateView();
+    // Automatically reconnect with a specified account
+    void                 scheduleReconnection( QString handle );
     // Change the connection status text
     void                 statusMessage( QString text );
 
@@ -70 +74 @@
     QString              getSelectedHandle() const;
     // The "remember account" checkbox change its state
     void                 rememberAccountStateChanged( int state );
+    // Connect again after being disconnected
+    void                 reconnect();
     // Enable or disable the widgets when we're connecting or waiting
     void                 setEnabled( bool isEnabled );
     // The connect/disconnect button has been clicked
@@ -86 +92 @@
     KConfigGroup         config_;
     // The default handle to display
     QString              defaultHandle_;
+    // Whether a reconnection should be scheduled after a network connection comes back up
+    QString              doReconnectWithAccount_;
+    // Whether there is an active network connection or not
+    bool                 hasNetworkConnection_;
     // Whether the UI is set up for connection or waiting for the login data
     bool                 isConnecting_;
     // Loader for icons
     KIconLoader         *loader_;
+    // Time elapsed after the reconnection schedulation
+    QTime                reconnectElapsedTime_;
+    // Timer for reconnection
+    QTimer               reconnectTimer_;
 
   signals: // Public signals
     // Connect with the given account