Ticket #1519: filezilla_3_rc1_keepalive.patch

src/engine/ControlSocket.h

@@ -115 +115 @@
     virtual int Chmod(const CChmodCommand& command) { return FZ_REPLY_NOTSUPPORTED; }
     virtual bool Connected() const = 0;
 
+    virtual int KeepAlive(const CKeepAliveCommand& command) { return FZ_REPLY_OK; }
+
     // If m_pCurrentOpData is zero, this function returns the current command
     // from the engine.
     enum Command GetCurrentCommandId() const;

src/engine/FileZillaEngine.cpp

@@ -70 +70 @@
     case cmd_chmod:
         res = Chmod(reinterpret_cast<const CChmodCommand&>(command));
         break;
+    case cmd_keepalive:
+        res = KeepAlive(reinterpret_cast<const CKeepAliveCommand &>(command));
+        break;
     default:
         return FZ_REPLY_SYNTAXERROR;
     }

src/engine/engineprivate.cpp

@@ -525 +525 @@
     return m_pControlSocket->Chmod(command);
 }
 
+int CFileZillaEnginePrivate::KeepAlive(const CKeepAliveCommand& command)
+{
+    if (!IsConnected())
+        return FZ_REPLY_NOTCONNECTED;
+
+    if (IsBusy())
+        return FZ_REPLY_BUSY;
+
+    m_pCurrentCommand = command.Clone();
+    return m_pControlSocket->KeepAlive(command);
+}
+
 void CFileZillaEnginePrivate::SendDirectoryListingNotification(const CServerPath& path, bool onList, bool modified, bool failed)
 {
     wxASSERT(m_pControlSocket);

src/engine/ftpcontrolsocket.cpp

@@ -147 +147 @@
 {
     LogMessage(Debug_Verbose, _T("CFtpControlSocket::OnReceive()"));
 
+    m_stopWatch.Start();
+
     m_pBackend->Read(m_receiveBuffer + m_bufferLen, RECVBUFFERSIZE - m_bufferLen);
     
     if (m_pBackend->Error())
@@ -386 +388 @@
     case cmd_rawtransfer:
         TransferParseResponse();
         break;
+    case cmd_keepalive:
+        KeepAliveParseResponse();
+        break;
     case cmd_none:
         LogMessage(Debug_Verbose, _T("Out-of-order reply, ignoring."));
         break;
@@ -798 +803 @@
         LogMessage(::Error, _T("Failed to convert command to 8 bit charset"));
         return false;
     }
+    m_stopWatch.Start();
     unsigned int len = (unsigned int)strlen(buffer);
     bool res = CRealControlSocket::Send(buffer, len);
     if (res)
@@ -1254 +1260 @@
         return DeleteSend(prevResult);
     case cmd_removedir:
         return RemoveDirSend(prevResult);
+    case cmd_keepalive:
+        return KeepAliveSend();
     default:
         LogMessage(__TFILE__, __LINE__, this, ::Debug_Warning, _T("Unknown opID (%d) in SendNextCommand"), m_pCurOpData->opId);
         ResetOperation(FZ_REPLY_INTERNALERROR);
@@ -3007 +3015 @@
 
     return FZ_REPLY_WOULDBLOCK;
 }
+
+class CKeepAliveOpData : public COpData
+{
+public:
+    CKeepAliveOpData(const wxString& command)
+        : COpData(cmd_keepalive)
+    {
+        m_command = command;
+    }
+
+    wxString m_command;
+};
+
+int CFtpControlSocket::KeepAlive(const CKeepAliveCommand& command)
+{
+    LogMessage(Debug_Verbose, _("CFtpControlSocket::KeepAlive"));
+
+    // ignore keepalive for last I/O for socket less than 15 seconds
+    if (m_stopWatch.Time() < 15000)
+        return FZ_REPLY_OK;
+    // choose any command
+    wxString commands[4] = {_T("PWD"),_T("REST 0"), _T("TYPE A"), _T("TYPE I") };
+    int choice=(rand()*4)/(RAND_MAX+1);
+    m_pCurOpData = new CKeepAliveOpData(commands[choice]);
+
+    return SendNextCommand();
+}
+
+int CFtpControlSocket::KeepAliveSend()
+{
+    LogMessage(Debug_Verbose, _T("CFtpControlSocket::KeepAliveSend"));
+
+    if (!m_pCurOpData)
+    {
+        LogMessage(__TFILE__, __LINE__, this, Debug_Info, _T("Empty m_pCurOpData"));
+        ResetOperation(FZ_REPLY_INTERNALERROR);
+        return FZ_REPLY_ERROR;
+    }
+
+    CDirectoryCache cache;
+    cache.InvalidateServer(*m_pCurrentServer);
+    m_CurrentPath = CServerPath();
+
+    CKeepAliveOpData *pData = static_cast<CKeepAliveOpData *>(m_pCurOpData);
+
+    if (!Send(pData->m_command))
+        return FZ_REPLY_ERROR;
+
+    return FZ_REPLY_WOULDBLOCK;
+}
+
+int CFtpControlSocket::KeepAliveParseResponse()
+{
+    LogMessage(Debug_Verbose, _T("CFtpControlSocket::KeepAliveParseResponse"));
+
+    int code = GetReplyCode();
+    if (code == 2 || code == 3)
+    {
+        ResetOperation(FZ_REPLY_OK);
+        return FZ_REPLY_OK;
+    }
+    else
+    {
+        ResetOperation(FZ_REPLY_ERROR);
+        return FZ_REPLY_ERROR;
+    }
+}
+
 
 bool CFtpControlSocket::IsMisleadingListResponse() const
 {

src/engine/ftpcontrolsocket.h

@@ -24 +24 @@
 
 protected:
     
+    wxStopWatch m_stopWatch;
+    virtual int KeepAlive(const CKeepAliveCommand& command);
+    int KeepAliveParseResponse();
+    int KeepAliveSend();
+
     virtual int ResetOperation(int nErrorCode);
 
     virtual int Connect(const CServer &server);

src/include/commands.h

@@ -19 +19 @@
     cmd_rename,
     cmd_chmod,
     cmd_raw,
+    cmd_keepalive,
 
     // Only used internally
     cmd_cwd,
@@ -76 +77 @@
     CServer m_Server;
 };
 
+DECLARE_COMMAND(CKeepAliveCommand, cmd_keepalive)
+};
 DECLARE_COMMAND(CDisconnectCommand, cmd_disconnect)
 };
 

src/include/engineprivate.h

@@ -69 +69 @@
     int Mkdir(const CMkdirCommand& command);
     int Rename(const CRenameCommand& command);
     int Chmod(const CChmodCommand& command);
+    int KeepAlive(const CKeepAliveCommand& command);
 
     int ContinueConnect();
 

src/interface/Mainfrm.cpp

@@ -43 +43 @@
 #endif
 
 #define TRANSFERSTATUS_TIMER_ID wxID_HIGHEST + 3
+#define KEEPALIVE_TIMER_ID TRANSFERSTATUS_TIMER_ID + 1
 
 static const int statbarWidths[6] = {
 #ifdef __WXMSW__
@@ -159 +160 @@
     }
 
     m_transferStatusTimer.SetOwner(this, TRANSFERSTATUS_TIMER_ID);
+    m_keepAliveTimer.SetOwner(this, KEEPALIVE_TIMER_ID);
 
     CreateMenus();
     CreateToolBar();
@@ -696 +698 @@
     if (!m_pState->m_pCommandQueue->Idle())
         return;
 
+    m_keepAliveTimer.Stop();
     m_pState->m_pCommandQueue->ProcessCommand(new CDisconnectCommand());
 }
 
@@ -769 +772 @@
     m_pSendLed = 0;
     m_pRecvLed = 0;
 
+    m_keepAliveTimer.Stop();
+
     m_transferStatusTimer.Stop();
 
     bool res = true;
@@ -826 +831 @@
     CServerPath path;
     path.SetSafePath(COptions::Get()->GetOption(OPTION_LASTSERVERPATH));
     m_pState->Connect(server, false, path);
+    // FIXME:
+    // need to read from options, do this only for KeepAlive enabled
+    m_keepAliveTimer.Start(1000);
 }
 
 void CMainFrame::OnRefresh(wxCommandEvent &event)
@@ -898 +906 @@
         else
             m_transferStatusTimer.Stop();
     }
+    else if (event.GetId() == KEEPALIVE_TIMER_ID && m_keepAliveTimer.IsRunning())
+    {
+        // make sure engine and commandqueue exist
+        if (!m_pState && !m_pState->m_pEngine && !m_pState->m_pCommandQueue)
+        {
+            m_keepAliveTimer.Stop();
+            return;
+        }
+        // just do this for idle, wait for next timer
+        if (!m_pState->m_pCommandQueue->Idle())
+            return;
+        // if not connected, stop keepalive timer
+        if (!m_pState->m_pEngine->IsConnected())
+        {
+            m_keepAliveTimer.Stop();
+            return;
+        }
+        // FIXME:
+        // need to read the values from options...
+        int min_wait = 30;
+        int max_wait = 60;
+
+        // if just connected, the interval will be 1000
+        bool first_time = (m_keepAliveTimer.GetInterval() == 1000);
+
+        int waitsecond = min_wait + (int)(rand()*(max_wait - min_wait)/(RAND_MAX+1));
+        m_keepAliveTimer.Stop();
+        m_keepAliveTimer.Start(waitsecond * 1000);
+        // skip keepalive for just connected
+        if (first_time)
+            return;
+        m_pState->m_pCommandQueue->ProcessCommand(new CKeepAliveCommand());
+    }
 }
 
 void CMainFrame::SetProgress(const CTransferStatus *pStatus)
@@ -1342 +1383 @@
     }
 
     m_pState->Connect(pData->m_server, true, pData->m_remoteDir);
+    // FIXME:
+    // need to read from options, do this only for KeepAlive enabled
+    m_keepAliveTimer.Start(1000);
 
     if (pData->m_localDir != _T(""))
         m_pState->SetLocalDir(pData->m_localDir);

src/interface/Mainfrm.h

@@ -84 +84 @@
     CLed* m_pRecvLed;
     CLed* m_pSendLed;
     wxTimer m_transferStatusTimer;
+
+    wxTimer m_keepAliveTimer;
+
     CThemeProvider* m_pThemeProvider;
 #if FZ_MANUALUPDATECHECK && FZ_AUTOUPDATECHECK
     CUpdateWizard* m_pUpdateWizard;