Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added wxProtocolLog class for logging network requests/responses (closes #7464)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59404 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2009-03-07 13:58:39 +00:00
parent fdb45ab7e9
commit 0576cd9ebe
17 changed files with 253 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.in
View File

@@ -451,6 +451,7 @@ ALL_BASE_HEADERS = \
wx/protocol/file.h \
wx/protocol/ftp.h \
wx/protocol/http.h \
wx/protocol/log.h \
wx/protocol/protocol.h \
wx/sckaddr.h \
wx/sckipc.h \
@@ -647,6 +648,7 @@ ALL_PORTS_BASE_HEADERS = \
wx/protocol/file.h \
wx/protocol/ftp.h \
wx/protocol/http.h \
wx/protocol/log.h \
wx/protocol/protocol.h \
wx/sckaddr.h \
wx/sckipc.h \

1
build/bakefiles/files.bkl
View File

@@ -580,6 +580,7 @@ IMPORTANT: please read docs/tech/tn0016.txt before modifying this file!
wx/protocol/file.h
wx/protocol/ftp.h
wx/protocol/http.h
wx/protocol/log.h
wx/protocol/protocol.h
wx/sckaddr.h
wx/sckipc.h

4
build/msw/wx_net.dsp
View File

@@ -598,6 +598,10 @@ SOURCE=..\..\include\wx\protocol\http.h
# End Source File
# Begin Source File
SOURCE=..\..\include\wx\protocol\log.h
# End Source File
# Begin Source File
SOURCE=..\..\include\wx\protocol\protocol.h
# End Source File
# Begin Source File

3
build/msw/wx_vc7_net.vcproj
View File

@@ -818,6 +818,9 @@
<File
RelativePath="..\..\include\wx\protocol\http.h">
</File>
<File
RelativePath="..\..\include\wx\protocol\log.h">
</File>
<File
RelativePath="..\..\include\wx\protocol\protocol.h">
</File>

4
build/msw/wx_vc8_net.vcproj
View File

@@ -1114,6 +1114,10 @@
RelativePath="..\..\include\wx\protocol\http.h"
>
</File>
<File
RelativePath="..\..\include\wx\protocol\log.h"
>
</File>
<File
RelativePath="..\..\include\wx\protocol\protocol.h"
>

4
build/msw/wx_vc9_net.vcproj
View File

@@ -1110,6 +1110,10 @@
RelativePath="..\..\include\wx\protocol\http.h"
>
</File>
<File
RelativePath="..\..\include\wx\protocol\log.h"
>
</File>
<File
RelativePath="..\..\include\wx\protocol\protocol.h"
>

1
docs/changes.txt
View File

@@ -370,6 +370,7 @@ All:
- Added wxStrnlen() for safe computation of string length.
- Added wxImage::Clear() (troelsk).
- Added wxLog::Log().
- Added wxProtocolLog and use it in wxFTP.
- Added wxXmlResource::GetResourceNode().
All (Unix):

55
include/wx/protocol/log.h Normal file
View File

@@ -0,0 +1,55 @@
///////////////////////////////////////////////////////////////////////////////
// Name: wx/protocol/log.h
// Purpose: wxProtocolLog class for logging network exchanges
// Author: Troelsk, Vadim Zeitlin
// Created: 2009-03-06
// RCS-ID: $Id$
// Copyright: (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_PROTOCOL_LOG_H_
#define _WX_PROTOCOL_LOG_H_
#include "wx/string.h"
// ----------------------------------------------------------------------------
// wxProtocolLog: simple class for logging network requests and responses
// ----------------------------------------------------------------------------
class WXDLLIMPEXP_NET wxProtocolLog
{
public:
// Create object doing the logging using wxLogTrace() with the specified
// trace mask.
wxProtocolLog(const wxString& traceMask)
: m_traceMask(traceMask)
{
}
// Virtual dtor for the base class
virtual ~wxProtocolLog() { }
// Called by wxProtocol-derived classes to actually log something
virtual void LogRequest(const wxString& str)
{
DoLogString("==> " + str);
}
virtual void LogResponse(const wxString& str)
{
DoLogString("<== " + str);
}
protected:
// Can be overridden by the derived classes.
virtual void DoLogString(const wxString& str);
private:
const wxString m_traceMask;
wxDECLARE_NO_COPY_CLASS(wxProtocolLog);
};
#endif // _WX_PROTOCOL_LOG_H_

29
include/wx/protocol/protocol.h
View File

@@ -24,6 +24,8 @@
#include "wx/socket.h"
#endif
class WXDLLIMPEXP_FWD_NET wxProtocolLog;
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
@@ -55,6 +57,7 @@ class WXDLLIMPEXP_NET wxProtocol
{
public:
wxProtocol();
virtual ~wxProtocol();
#if wxUSE_SOCKETS
bool Reconnect();
@@ -89,6 +92,30 @@ public:
{ SetDefaultTimeout(seconds); }
// logging support: each wxProtocol object may have the associated logger
// (by default there is none) which is used to log network requests and
// responses
// set the logger, deleting the old one and taking ownership of this one
void SetLog(wxProtocolLog *log);
// return the current logger, may be NULL
wxProtocolLog *GetLog() const { return m_log; }
// detach the existing logger without deleting it, the caller is
// responsible for deleting the returned pointer if it's non-NULL
wxProtocolLog *DetachLog()
{
wxProtocolLog * const log = m_log;
m_log = NULL;
return log;
}
// these functions forward to the same functions with the same names in
// wxProtocolLog if we have a valid logger and do nothing otherwise
void LogRequest(const wxString& str);
void LogResponse(const wxString& str);
protected:
// the timeout associated with the protocol:
wxUint32 m_uiDefaultTimeout;
@@ -100,6 +127,8 @@ protected:
wxProtocolError m_lastError;
private:
wxProtocolLog *m_log;
DECLARE_DYNAMIC_CLASS_NO_COPY(wxProtocol)
};

61
interface/wx/protocol/log.h Normal file
View File

@@ -0,0 +1,61 @@
///////////////////////////////////////////////////////////////////////////////
// Name: wx/protocol/log.h
// Purpose: interface of wxProtocolLog
// Author: Vadim Zeitlin
// Created: 2009-03-06
// RCS-ID: $Id$
// Copyright: (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/**
Class allowing to log network operations performed by wxProtocol.
@library{wxnet}
@category{net}
@see wxProtocol
*/
class wxProtocolLog
{
public:
/**
Create object doing the logging using wxLogTrace() with the specified
trace mask.
If you override DoLogString() in your class the @a traceMask may be
left empty but it must have a valid value if you rely on the default
DoLogString() implementation.
*/
wxProtocolLog(const wxString& traceMask);
/**
Called by wxProtocol-derived objects to log strings sent to the server.
Default implementation prepends a client-to-server marker to @a str and
calls DoLogString().
*/
virtual void LogRequest(const wxString& str);
/**
Called by wxProtocol-derived objects to log strings received from the
server.
Default implementation prepends a server-to-client marker to @a str and
calls DoLogString().
*/
virtual void LogResponse(const wxString& str);
protected:
/**
Log the given string.
This function is called from LogRequest() and LogResponse() and by
default uses wxLogTrace() with the trace mask specified in the
constructor but can be overridden to do something different by the
derived classes.
*/
virtual void DoLogString(const wxString& str);
};

47
interface/wx/protocol/protocol.h
View File

@@ -1,5 +1,5 @@
/////////////////////////////////////////////////////////////////////////////
// Name: protocol/protocol.h
// Name: wx/protocol/protocol.h
// Purpose: interface of wxProtocol
// Author: wxWidgets team
// RCS-ID: $Id$
@@ -107,5 +107,50 @@ public:
@see wxSocketBase::SetTimeout
*/
void SetDefaultTimeout(wxUint32 Value);
/**
@name Logging support.
Each wxProtocol object may have the associated logger (by default there
is none) which is used to log network requests and responses.
@see wxProtocolLog
*/
//@{
/**
Set the logger, deleting the old one and taking ownership of this one.
@param log
New logger allocated on the heap or @NULL.
*/
void SetLog(wxProtocolLog *log);
/**
Return the current logger, may be @NULL.
*/
wxProtocolLog *GetLog() const { return m_log; }
/**
Detach the existing logger without deleting it.
The caller is responsible for deleting the returned pointer if it's
non-@c NULL.
*/
wxProtocolLog *DetachLog();
/**
Call wxProtocolLog::LogRequest() if we have a valid logger or do
nothing otherwise.
*/
void LogRequest(const wxString& str);
/**
Call wxProtocolLog::LogResponse() if we have a valid logger or do
nothing otherwise.
*/
void LogResponse(const wxString& str);
//@}
};

2
samples/console/console.cpp
View File

@@ -2455,6 +2455,7 @@ static void TestSocketClient()
#ifdef TEST_FTP
#include "wx/protocol/ftp.h"
#include "wx/protocol/log.h"
#define FTP_ANONYMOUS
@@ -4403,6 +4404,7 @@ int main(int argc, char **argv)
// wxFTP cannot be a static variable as its ctor needs to access
// wxWidgets internals after it has been initialized
ftp = new wxFTP;
ftp->SetLog(new wxProtocolLog(FTP_TRACE_MASK));
if ( TestFtpConnect() )
{

26
src/common/ftp.cpp
View File

@@ -257,7 +257,7 @@ char wxFTP::SendCommand(const wxString& command)
cmd = command;
}
wxLogTrace(FTP_TRACE_MASK, _T("==> %s"), cmd.c_str());
LogRequest(cmd);
#endif // __WXDEBUG__
m_lastError = wxPROTO_NOERR;
@@ -301,6 +301,8 @@ char wxFTP::GetResult()
return 0;
}
LogResponse(line);
if ( !m_lastResult.empty() )
{
// separate from last line
@@ -317,11 +319,6 @@ char wxFTP::GetResult()
{
badReply = true;
}
else
{
wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
code.c_str(), line.c_str());
}
}
else // line has at least 4 chars
{
@@ -331,8 +328,6 @@ char wxFTP::GetResult()
if ( firstLine )
{
code = wxString(line, LEN_CODE);
wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
code.c_str(), line.c_str() + LEN_CODE + 1);
switch ( chMarker )
{
@@ -357,15 +352,6 @@ char wxFTP::GetResult()
{
endOfReply = true;
}
wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
code.c_str(), line.c_str() + LEN_CODE + 1);
}
else
{
// just part of reply
wxLogTrace(FTP_TRACE_MASK, _T("<== %s %s"),
code.c_str(), line.c_str());
}
}
}
@@ -1008,8 +994,7 @@ int wxFTP::GetFileSize(const wxString& fileName)
&filesize) != 9 )
{
// Hmm... Invalid response
wxLogTrace(FTP_TRACE_MASK,
_T("Invalid LIST response"));
wxLogDebug(wxT("Invalid LIST response"));
}
}
else // Windows-style response (?)
@@ -1019,8 +1004,7 @@ int wxFTP::GetFileSize(const wxString& fileName)
&filesize) != 4 )
{
// something bad happened..?
wxLogTrace(FTP_TRACE_MASK,
_T("Invalid or unknown LIST response"));
wxLogDebug(wxT("Invalid or unknown LIST response"));
}
}
}

33
src/common/protocol.cpp
View File

@@ -19,6 +19,7 @@
#if wxUSE_PROTOCOL
#include "wx/protocol/protocol.h"
#include "wx/protocol/log.h"
#ifndef WX_PRECOMP
#include "wx/module.h"
@@ -64,6 +65,7 @@ wxProtocol::wxProtocol()
#endif
{
m_lastError = wxPROTO_NOERR;
m_log = NULL;
SetDefaultTimeout(60); // default timeout is 60 seconds
}
@@ -95,6 +97,10 @@ void wxProtocol::SetDefaultTimeout(wxUint32 Value)
#endif
}
wxProtocol::~wxProtocol()
{
delete m_log;
}
// ----------------------------------------------------------------------------
// Read a line from socket
@@ -179,4 +185,31 @@ wxProtocolError wxProtocol::ReadLine(wxString& result)
#endif // wxUSE_SOCKETS
// ----------------------------------------------------------------------------
// logging
// ----------------------------------------------------------------------------
void wxProtocol::SetLog(wxProtocolLog *log)
{
delete m_log;
m_log = log;
}
void wxProtocol::LogRequest(const wxString& str)
{
if ( m_log )
m_log->LogRequest(str);
}
void wxProtocol::LogResponse(const wxString& str)
{
if ( m_log )
m_log->LogResponse(str);
}
void wxProtocolLog::DoLogString(const wxString& WXUNUSED_UNLESS_DEBUG(str))
{
wxLogTrace(m_traceMask, "%s", str);
}
#endif // wxUSE_PROTOCOL

1
wxGTK.spec
View File

@@ -360,6 +360,7 @@ wx/fs_inet.h
wx/protocol/file.h
wx/protocol/ftp.h
wx/protocol/http.h
wx/protocol/log.h
wx/protocol/protocol.h
wx/sckaddr.h
wx/sckipc.h

1
wxMotif.spec
View File

@@ -265,6 +265,7 @@ wx/fs_inet.h
wx/protocol/file.h
wx/protocol/ftp.h
wx/protocol/http.h
wx/protocol/log.h
wx/protocol/protocol.h
wx/sckaddr.h
wx/sckipc.h

1
wxX11.spec
View File

@@ -289,6 +289,7 @@ wx/fs_inet.h
wx/protocol/file.h
wx/protocol/ftp.h
wx/protocol/http.h
wx/protocol/log.h
wx/protocol/protocol.h
wx/sckaddr.h
wx/sckipc.h