pgadmin3/utils/sysLogger.cpp

//////////////////////////////////////////////////////////////////////////
//
// pgAdmin III - PostgreSQL Tools
//
// Copyright (C) 2002 - 2016, The pgAdmin Development Team
// This software is released under the PostgreSQL Licence
//
// sysLogger.cpp - Log handling class
//
//////////////////////////////////////////////////////////////////////////

#include "pgAdmin3.h"

// wxWindows headers
#include <wx/wx.h>
#include <wx/ffile.h>
#include <wx/datetime.h>
#include <wx/log.h>

// App headers
#if !defined(PGSCLI)
#include "copyright.h"      // needed for APPNAME_L caption
#endif // PGSCLI

#include "utils/sysLogger.h"

wxLogLevel sysLogger::logLevel = LOG_ERRORS;
wxString sysLogger::logFile = wxT("debug.log");

#if !wxCHECK_VERSION(2, 9, 0)

// IMPLEMENT_LOG_FUNCTION(Sql) from wx../common/log.c
void wxVLogQuietError(const wxChar *szFormat, va_list argptr)
{
	static wxChar s_szBuf[8192];

	if (sysLogger::logLevel >= LOG_ERRORS)
	{
		wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
		wxLog::OnLog(wxLOG_QuietError, s_szBuf, time(NULL));

	}
}

void wxLogQuietError(const wxChar *szFormat, ...)
{
	va_list argptr;
	va_start(argptr, szFormat);
	wxVLogQuietError(szFormat, argptr);
	va_end(argptr);
}


void wxVLogSql(const wxChar *szFormat, va_list argptr)
{
	static wxChar s_szBuf[8192];

	if (sysLogger::logLevel >= LOG_SQL)
	{
		wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
		wxLog::OnLog(wxLOG_Sql, s_szBuf, time(NULL));

	}
}

void wxLogSql(const wxChar *szFormat, ...)
{
	va_list argptr;
	va_start(argptr, szFormat);
	wxVLogSql(szFormat, argptr);
	va_end(argptr);
}



void wxVLogNotice(const wxChar *szFormat, va_list argptr)
{
	static wxChar s_szBuf[8192];

	if (sysLogger::logLevel >= LOG_NOTICE)
	{
		wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
		wxLog::OnLog(wxLOG_Notice, s_szBuf, time(NULL));
	}
}

void wxLogNotice(const wxChar *szFormat, ...)
{
	va_list argptr;
	va_start(argptr, szFormat);
	wxVLogNotice(szFormat, argptr);
	va_end(argptr);
}

void wxVLogScript(const wxChar *szFormat, va_list argptr)
{
	static wxChar s_szBuf[8192];

	if (sysLogger::logLevel >= LOG_SQL)
	{
		wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
		wxLog::OnLog(wxLOG_Script, s_szBuf, time(NULL));
	}
}

void wxLogScript(const wxChar *szFormat, ...)
{
	va_list argptr;
	va_start(argptr, szFormat);
	wxVLogScript(szFormat, argptr);
	va_end(argptr);
}

void wxVLogScriptVerbose(const wxChar *szFormat, va_list argptr)
{
	static wxChar s_szBuf[8192];

	if (sysLogger::logLevel >= LOG_DEBUG)
	{
		wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
		wxLog::OnLog(wxLOG_ScriptVerbose, s_szBuf, time(NULL));
	}
}

void wxLogScriptVerbose(const wxChar *szFormat, ...)
{
	va_list argptr;
	va_start(argptr, szFormat);
	wxVLogScriptVerbose(szFormat, argptr);
	va_end(argptr);
}

#endif

#if wxCHECK_VERSION(2, 9, 0)
void sysLogger::DoLogTextAtLevel(wxLogLevel level, const wxString &msg)
#else
void sysLogger::DoLog(wxLogLevel level, const wxChar *msg, time_t timestamp)
#endif
{
	wxString msgtype, preamble;
	int icon = 0;

	switch (level)
	{
		case wxLOG_FatalError:
			msgtype = wxT("FATAL  ");
			preamble = _("A fatal error has occurred:\n\n");
			icon = wxICON_ERROR;
			break;

		case wxLOG_Error:
			msgtype = wxT("ERROR  ");
			preamble = _("An error has occurred:\n\n");
			icon = wxICON_ERROR;
			break;

		case wxLOG_QuietError:
			msgtype = wxT("ERROR  ");
			break;

		case wxLOG_Warning:
			msgtype = wxT("WARNING");
			preamble = _("Warning:\n\n");
			icon = wxICON_EXCLAMATION;
			break;

		case wxLOG_Message:
			msgtype = wxT("MESSAGE");
			preamble = wxT("");
			icon = wxICON_INFORMATION;
			break;

		case wxLOG_Info:
			msgtype = wxT("INFO   ");
			break;

		case wxLOG_Status:
			msgtype = wxT("STATUS ");
			break;

		case wxLOG_Notice:
			msgtype = wxT("NOTICE ");
			break;

		case wxLOG_Sql:
			msgtype = wxT("QUERY  ");
			break;

		case wxLOG_Script:
			msgtype = wxT("SCRIPT ");
			break;

		case wxLOG_ScriptVerbose:
			msgtype = wxT("SCRIPT ");
			break;

		case wxLOG_Trace:
			msgtype = wxT("TRACE  ");
			break;

		case wxLOG_Debug:
			msgtype = wxT("DEBUG  ");
			break;

		default:
			msgtype = wxT("UNKNOWN");
			icon = wxICON_INFORMATION;
			break;
	}

	wxString fullmsg;

#if wxCHECK_VERSION(2, 9, 0)
	// Build the message.
	fullmsg << msgtype << wxT(": ") << msg;
#else
	// Convert the timestamp
	wxDateTime *time = new wxDateTime(timestamp);

	// Build the message.
	fullmsg << time->FormatISODate() << wxT(" ") <<
	        time->FormatISOTime() << wxT(" ") << msgtype << wxT(": ") << msg;

	// Make sure to delete the time that we allocated
	delete time;
#endif

	// Display the message if required
	switch (logLevel)
	{
		case LOG_NONE:
			break;

		case LOG_ERRORS:
			if (level == wxLOG_FatalError ||
			        level == wxLOG_Error ||
			        level == wxLOG_QuietError)
				WriteLog(fullmsg);
			break;

		case LOG_NOTICE:
			if (level == wxLOG_FatalError ||
			        level == wxLOG_Error ||
			        level == wxLOG_QuietError ||
			        level == wxLOG_Notice)
				WriteLog(fullmsg);
			break;

		case LOG_SQL:
			if (level == wxLOG_FatalError ||
			        level == wxLOG_Error ||
			        level == wxLOG_QuietError ||
			        level == wxLOG_Message ||
			        level == wxLOG_Status ||
			        level == wxLOG_Notice ||
			        level == wxLOG_Sql ||
			        level == wxLOG_Script)
				WriteLog(fullmsg);
			break;

		case LOG_DEBUG:
			WriteLog(fullmsg);
			break;
	}

	// Display a messagebox if required.
#if !defined(PGSCLI)
	if (icon != 0 && !SilenceMessage(msg))
		wxMessageBox(preamble + wxGetTranslation(msg), appearanceFactory->GetLongAppName(), wxOK | wxCENTRE | icon);
#endif // PGSCLI
}


void sysLogger::WriteLog(const wxString &msg)
{
	wxString pid, logfile;

	// Disable logging to prevent recursion in the event of a problem
	wxLogNull foo;

	pid.Printf(wxT("%ld"), wxGetProcessId());
	logfile.Printf(wxT("%s"), logFile.c_str());
	logfile.Replace(wxT("%ID"), pid);

	wxFFile file(logfile, wxT("a"));

#if !defined(PGSCLI)
	if (!file.IsOpened())
	{
		wxMessageBox(_("Cannot open the logfile!"), _("FATAL"), wxOK | wxCENTRE | wxICON_ERROR);
		return;
	}
#endif // PGSCLI

	file.Write(msg + wxT("\n"));
	file.Close();
}

// Check to see if a message should be silenced (because it's meaningless
// and cannot be silenced at source
bool sysLogger::SilenceMessage(const wxString &msg)
{
#ifdef __WXMAC__
	// This one crops up on the Mac and originates from the logging code
	// for no obviously apparent reason.
	if (msg.Contains(_("can't flush file descriptor")))
		return true;
#endif
	return false;
}