/src/FreeRDP/winpr/libwinpr/utils/wlog/ConsoleAppender.c

Source (jump to first uncovered line)
/**
 * WinPR: Windows Portable Runtime
 * WinPR Logger
 *
 * Copyright 2013 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <winpr/config.h>

#include "ConsoleAppender.h"
#include "Message.h"

#ifdef ANDROID
#include <android/log.h>
#endif

#define WLOG_CONSOLE_DEFAULT 0
#define WLOG_CONSOLE_STDOUT 1
#define WLOG_CONSOLE_STDERR 2
#define WLOG_CONSOLE_DEBUG 4

typedef struct
{
  WLOG_APPENDER_COMMON();

  int outputStream;
} wLogConsoleAppender;

static BOOL WLog_ConsoleAppender_Open(WINPR_ATTR_UNUSED wLog* log,
                                      WINPR_ATTR_UNUSED wLogAppender* appender)
{
  return TRUE;
}

static BOOL WLog_ConsoleAppender_Close(WINPR_ATTR_UNUSED wLog* log,
                                       WINPR_ATTR_UNUSED wLogAppender* appender)
{
  return TRUE;
}

static BOOL WLog_ConsoleAppender_WriteMessage(wLog* log, wLogAppender* appender,
                                              wLogMessage* message)
{
  FILE* fp = NULL;
  char prefix[WLOG_MAX_PREFIX_SIZE] = { 0 };
  wLogConsoleAppender* consoleAppender = NULL;
  if (!appender)
    return FALSE;

  consoleAppender = (wLogConsoleAppender*)appender;

  message->PrefixString = prefix;
  WLog_Layout_GetMessagePrefix(log, appender->Layout, message);

#ifdef _WIN32
  if (consoleAppender->outputStream == WLOG_CONSOLE_DEBUG)
  {
    OutputDebugStringA(message->PrefixString);
    OutputDebugStringA(message->TextString);
    OutputDebugStringA("\n");

    return TRUE;
  }
#endif
#ifdef ANDROID
  (void)fp;
  android_LogPriority level;
  switch (message->Level)
  {
    case WLOG_TRACE:
      level = ANDROID_LOG_VERBOSE;
      break;
    case WLOG_DEBUG:
      level = ANDROID_LOG_DEBUG;
      break;
    case WLOG_INFO:
      level = ANDROID_LOG_INFO;
      break;
    case WLOG_WARN:
      level = ANDROID_LOG_WARN;
      break;
    case WLOG_ERROR:
      level = ANDROID_LOG_ERROR;
      break;
    case WLOG_FATAL:
      level = ANDROID_LOG_FATAL;
      break;
    case WLOG_OFF:
      level = ANDROID_LOG_SILENT;
      break;
    default:
      level = ANDROID_LOG_FATAL;
      break;
  }

  if (level != ANDROID_LOG_SILENT)
    __android_log_print(level, log->Name, "%s%s", message->PrefixString, message->TextString);

#else
  switch (consoleAppender->outputStream)
  {
    case WLOG_CONSOLE_STDOUT:
      fp = stdout;
      break;
    case WLOG_CONSOLE_STDERR:
      fp = stderr;
      break;
    default:
      switch (message->Level)
      {
        case WLOG_TRACE:
        case WLOG_DEBUG:
        case WLOG_INFO:
          fp = stdout;
          break;
        default:
          fp = stderr;
          break;
      }
      break;
  }

  if (message->Level != WLOG_OFF)
    (void)fprintf(fp, "%s%s\n", message->PrefixString, message->TextString);
#endif
  return TRUE;
}

static int g_DataId = 0;

static BOOL WLog_ConsoleAppender_WriteDataMessage(WINPR_ATTR_UNUSED wLog* log,
                                                  WINPR_ATTR_UNUSED wLogAppender* appender,
                                                  wLogMessage* message)
{
#if defined(ANDROID)
  return FALSE;
#else
  int DataId = 0;
  char* FullFileName = NULL;

  DataId = g_DataId++;
  FullFileName = WLog_Message_GetOutputFileName(DataId, "dat");

  WLog_DataMessage_Write(FullFileName, message->Data, message->Length);

  free(FullFileName);

  return TRUE;
#endif
}

static int g_ImageId = 0;

static BOOL WLog_ConsoleAppender_WriteImageMessage(WINPR_ATTR_UNUSED wLog* log,
                                                   WINPR_ATTR_UNUSED wLogAppender* appender,
                                                   wLogMessage* message)
{
#if defined(ANDROID)
  return FALSE;
#else
  int ImageId = 0;
  char* FullFileName = NULL;

  ImageId = g_ImageId++;
  FullFileName = WLog_Message_GetOutputFileName(ImageId, "bmp");

  WLog_ImageMessage_Write(FullFileName, message->ImageData, message->ImageWidth,
                          message->ImageHeight, message->ImageBpp);

  free(FullFileName);

  return TRUE;
#endif
}

static int g_PacketId = 0;

static BOOL WLog_ConsoleAppender_WritePacketMessage(WINPR_ATTR_UNUSED wLog* log,
                                                    wLogAppender* appender, wLogMessage* message)
{
#if defined(ANDROID)
  return FALSE;
#else
  char* FullFileName = NULL;

  g_PacketId++;

  if (!appender->PacketMessageContext)
  {
    FullFileName = WLog_Message_GetOutputFileName(-1, "pcap");
    appender->PacketMessageContext = (void*)Pcap_Open(FullFileName, TRUE);
    free(FullFileName);
  }

  if (appender->PacketMessageContext)
    return WLog_PacketMessage_Write((wPcap*)appender->PacketMessageContext, message->PacketData,
                                    message->PacketLength, message->PacketFlags);

  return TRUE;
#endif
}
static BOOL WLog_ConsoleAppender_Set(wLogAppender* appender, const char* setting, void* value)
{
  wLogConsoleAppender* consoleAppender = (wLogConsoleAppender*)appender;

  /* Just check the value string is not empty */
  if (!value || (strnlen(value, 2) == 0))
    return FALSE;

  if (strcmp("outputstream", setting) != 0)
    return FALSE;

  if (!strcmp("stdout", value))
    consoleAppender->outputStream = WLOG_CONSOLE_STDOUT;
  else if (!strcmp("stderr", value))
    consoleAppender->outputStream = WLOG_CONSOLE_STDERR;
  else if (!strcmp("default", value))
    consoleAppender->outputStream = WLOG_CONSOLE_DEFAULT;
  else if (!strcmp("debug", value))
    consoleAppender->outputStream = WLOG_CONSOLE_DEBUG;
  else
    return FALSE;

  return TRUE;
}

static void WLog_ConsoleAppender_Free(wLogAppender* appender)
{
  if (appender)
  {
    if (appender->PacketMessageContext)
    {
      Pcap_Close((wPcap*)appender->PacketMessageContext);
    }

    free(appender);
  }
}

wLogAppender* WLog_ConsoleAppender_New(WINPR_ATTR_UNUSED wLog* log)
{
  wLogConsoleAppender* ConsoleAppender = NULL;

  ConsoleAppender = (wLogConsoleAppender*)calloc(1, sizeof(wLogConsoleAppender));

  if (!ConsoleAppender)
    return NULL;

  ConsoleAppender->Type = WLOG_APPENDER_CONSOLE;

  ConsoleAppender->Open = WLog_ConsoleAppender_Open;
  ConsoleAppender->Close = WLog_ConsoleAppender_Close;
  ConsoleAppender->WriteMessage = WLog_ConsoleAppender_WriteMessage;
  ConsoleAppender->WriteDataMessage = WLog_ConsoleAppender_WriteDataMessage;
  ConsoleAppender->WriteImageMessage = WLog_ConsoleAppender_WriteImageMessage;
  ConsoleAppender->WritePacketMessage = WLog_ConsoleAppender_WritePacketMessage;
  ConsoleAppender->Set = WLog_ConsoleAppender_Set;
  ConsoleAppender->Free = WLog_ConsoleAppender_Free;

  ConsoleAppender->outputStream = WLOG_CONSOLE_DEFAULT;

#ifdef _WIN32
  if (IsDebuggerPresent())
    ConsoleAppender->outputStream = WLOG_CONSOLE_DEBUG;
#endif

  return (wLogAppender*)ConsoleAppender;
}

Coverage Report

Created: 2025-07-01 06:46

Line	Count	Source (jump to first uncovered line)
1		/**
2		* WinPR: Windows Portable Runtime
3		* WinPR Logger
4		*
5		* Copyright 2013 Marc-Andre Moreau <marcandre.moreau@gmail.com>
6		*
7		* Licensed under the Apache License, Version 2.0 (the "License");
8		* you may not use this file except in compliance with the License.
9		* You may obtain a copy of the License at
10		*
11		* http://www.apache.org/licenses/LICENSE-2.0
12		*
13		* Unless required by applicable law or agreed to in writing, software
14		* distributed under the License is distributed on an "AS IS" BASIS,
15		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16		* See the License for the specific language governing permissions and
17		* limitations under the License.
18		*/
19
20		#include <winpr/config.h>
21
22		#include "ConsoleAppender.h"
23		#include "Message.h"
24
25		#ifdef ANDROID
26		#include <android/log.h>
27		#endif
28
29	1	#define WLOG_CONSOLE_DEFAULT 0
30	0	#define WLOG_CONSOLE_STDOUT 1
31	0	#define WLOG_CONSOLE_STDERR 2
32	0	#define WLOG_CONSOLE_DEBUG 4
33
34		typedef struct
35		{
36		WLOG_APPENDER_COMMON();
37
38		int outputStream;
39		} wLogConsoleAppender;
40
41		static BOOL WLog_ConsoleAppender_Open(WINPR_ATTR_UNUSED wLog* log,
42		WINPR_ATTR_UNUSED wLogAppender* appender)
43	1	{
44	1	return TRUE;
45	1	}
46
47		static BOOL WLog_ConsoleAppender_Close(WINPR_ATTR_UNUSED wLog* log,
48		WINPR_ATTR_UNUSED wLogAppender* appender)
49	0	{
50	0	return TRUE;
51	0	}
52
53		static BOOL WLog_ConsoleAppender_WriteMessage(wLog* log, wLogAppender* appender,
54		wLogMessage* message)
55	1.01k	{
56	1.01k	FILE* fp = NULL;
57	1.01k	char prefix[WLOG_MAX_PREFIX_SIZE] = { 0 };
58	1.01k	wLogConsoleAppender* consoleAppender = NULL;
59	1.01k	if (!appender)
60	0	return FALSE;
61
62	1.01k	consoleAppender = (wLogConsoleAppender*)appender;
63
64	1.01k	message->PrefixString = prefix;
65	1.01k	WLog_Layout_GetMessagePrefix(log, appender->Layout, message);
66
67		#ifdef _WIN32
68		if (consoleAppender->outputStream == WLOG_CONSOLE_DEBUG)
69		{
70		OutputDebugStringA(message->PrefixString);
71		OutputDebugStringA(message->TextString);
72		OutputDebugStringA("\n");
73
74		return TRUE;
75		}
76		#endif
77		#ifdef ANDROID
78		(void)fp;
79		android_LogPriority level;
80		switch (message->Level)
81		{
82		case WLOG_TRACE:
83		level = ANDROID_LOG_VERBOSE;
84		break;
85		case WLOG_DEBUG:
86		level = ANDROID_LOG_DEBUG;
87		break;
88		case WLOG_INFO:
89		level = ANDROID_LOG_INFO;
90		break;
91		case WLOG_WARN:
92		level = ANDROID_LOG_WARN;
93		break;
94		case WLOG_ERROR:
95		level = ANDROID_LOG_ERROR;
96		break;
97		case WLOG_FATAL:
98		level = ANDROID_LOG_FATAL;
99		break;
100		case WLOG_OFF:
101		level = ANDROID_LOG_SILENT;
102		break;
103		default:
104		level = ANDROID_LOG_FATAL;
105		break;
106		}
107
108		if (level != ANDROID_LOG_SILENT)
109		__android_log_print(level, log->Name, "%s%s", message->PrefixString, message->TextString);
110
111		#else
112	1.01k	switch (consoleAppender->outputStream)
113	1.01k	{
114	0	case WLOG_CONSOLE_STDOUT:
115	0	fp = stdout;
116	0	break;
117	0	case WLOG_CONSOLE_STDERR:
118	0	fp = stderr;
119	0	break;
120	1.01k	default:
121	1.01k	switch (message->Level)
122	1.01k	{
123	0	case WLOG_TRACE:
124	0	case WLOG_DEBUG:
125	0	case WLOG_INFO:
126	0	fp = stdout;
127	0	break;
128	1.01k	default:
129	1.01k	fp = stderr;
130	1.01k	break;
131	1.01k	}
132	1.01k	break;
133	1.01k	}
134
135	1.01k	if (message->Level != WLOG_OFF)
136	1.01k	(void)fprintf(fp, "%s%s\n", message->PrefixString, message->TextString);
137	1.01k	#endif
138	1.01k	return TRUE;
139	1.01k	}
140
141		static int g_DataId = 0;
142
143		static BOOL WLog_ConsoleAppender_WriteDataMessage(WINPR_ATTR_UNUSED wLog* log,
144		WINPR_ATTR_UNUSED wLogAppender* appender,
145		wLogMessage* message)
146	0	{
147		#if defined(ANDROID)
148		return FALSE;
149		#else
150	0	int DataId = 0;
151	0	char* FullFileName = NULL;
152
153	0	DataId = g_DataId++;
154	0	FullFileName = WLog_Message_GetOutputFileName(DataId, "dat");
155
156	0	WLog_DataMessage_Write(FullFileName, message->Data, message->Length);
157
158	0	free(FullFileName);
159
160	0	return TRUE;
161	0	#endif
162	0	}
163
164		static int g_ImageId = 0;
165
166		static BOOL WLog_ConsoleAppender_WriteImageMessage(WINPR_ATTR_UNUSED wLog* log,
167		WINPR_ATTR_UNUSED wLogAppender* appender,
168		wLogMessage* message)
169	0	{
170		#if defined(ANDROID)
171		return FALSE;
172		#else
173	0	int ImageId = 0;
174	0	char* FullFileName = NULL;
175
176	0	ImageId = g_ImageId++;
177	0	FullFileName = WLog_Message_GetOutputFileName(ImageId, "bmp");
178
179	0	WLog_ImageMessage_Write(FullFileName, message->ImageData, message->ImageWidth,
180	0	message->ImageHeight, message->ImageBpp);
181
182	0	free(FullFileName);
183
184	0	return TRUE;
185	0	#endif
186	0	}
187
188		static int g_PacketId = 0;
189
190		static BOOL WLog_ConsoleAppender_WritePacketMessage(WINPR_ATTR_UNUSED wLog* log,
191		wLogAppender* appender, wLogMessage* message)
192	0	{
193		#if defined(ANDROID)
194		return FALSE;
195		#else
196	0	char* FullFileName = NULL;
197
198	0	g_PacketId++;
199
200	0	if (!appender->PacketMessageContext)
201	0	{
202	0	FullFileName = WLog_Message_GetOutputFileName(-1, "pcap");
203	0	appender->PacketMessageContext = (void*)Pcap_Open(FullFileName, TRUE);
204	0	free(FullFileName);
205	0	}
206
207	0	if (appender->PacketMessageContext)
208	0	return WLog_PacketMessage_Write((wPcap*)appender->PacketMessageContext, message->PacketData,
209	0	message->PacketLength, message->PacketFlags);
210
211	0	return TRUE;
212	0	#endif
213	0	}
214		static BOOL WLog_ConsoleAppender_Set(wLogAppender* appender, const char* setting, void* value)
215	0	{
216	0	wLogConsoleAppender* consoleAppender = (wLogConsoleAppender*)appender;
217
218		/* Just check the value string is not empty */
219	0	if (!value \|\| (strnlen(value, 2) == 0))
220	0	return FALSE;
221
222	0	if (strcmp("outputstream", setting) != 0)
223	0	return FALSE;
224
225	0	if (!strcmp("stdout", value))
226	0	consoleAppender->outputStream = WLOG_CONSOLE_STDOUT;
227	0	else if (!strcmp("stderr", value))
228	0	consoleAppender->outputStream = WLOG_CONSOLE_STDERR;
229	0	else if (!strcmp("default", value))
230	0	consoleAppender->outputStream = WLOG_CONSOLE_DEFAULT;
231	0	else if (!strcmp("debug", value))
232	0	consoleAppender->outputStream = WLOG_CONSOLE_DEBUG;
233	0	else
234	0	return FALSE;
235
236	0	return TRUE;
237	0	}
238
239		static void WLog_ConsoleAppender_Free(wLogAppender* appender)
240	1	{
241	1	if (appender)
242	1	{
243	1	if (appender->PacketMessageContext)
244	0	{
245	0	Pcap_Close((wPcap*)appender->PacketMessageContext);
246	0	}
247
248	1	free(appender);
249	1	}
250	1	}
251
252		wLogAppender* WLog_ConsoleAppender_New(WINPR_ATTR_UNUSED wLog* log)
253	1	{
254	1	wLogConsoleAppender* ConsoleAppender = NULL;
255
256	1	ConsoleAppender = (wLogConsoleAppender*)calloc(1, sizeof(wLogConsoleAppender));
257
258	1	if (!ConsoleAppender)
259	0	return NULL;
260
261	1	ConsoleAppender->Type = WLOG_APPENDER_CONSOLE;
262
263	1	ConsoleAppender->Open = WLog_ConsoleAppender_Open;
264	1	ConsoleAppender->Close = WLog_ConsoleAppender_Close;
265	1	ConsoleAppender->WriteMessage = WLog_ConsoleAppender_WriteMessage;
266	1	ConsoleAppender->WriteDataMessage = WLog_ConsoleAppender_WriteDataMessage;
267	1	ConsoleAppender->WriteImageMessage = WLog_ConsoleAppender_WriteImageMessage;
268	1	ConsoleAppender->WritePacketMessage = WLog_ConsoleAppender_WritePacketMessage;
269	1	ConsoleAppender->Set = WLog_ConsoleAppender_Set;
270	1	ConsoleAppender->Free = WLog_ConsoleAppender_Free;
271
272	1	ConsoleAppender->outputStream = WLOG_CONSOLE_DEFAULT;
273
274		#ifdef _WIN32
275		if (IsDebuggerPresent())
276		ConsoleAppender->outputStream = WLOG_CONSOLE_DEBUG;
277		#endif
278
279	1	return (wLogAppender*)ConsoleAppender;
280	1	}