initial check-in of file logger module from anthonyl branch, reworked for…

initial check-in of file logger module from anthonyl branch, reworked for current module interface and cleaned up debugging code.  More to come on this module.

git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@6414 d0543943-73ff-0310-b7d9-9358b9ac24b2

conf/autoload_configs/logfile.conf.xml

+<configuration name="logfile.conf" description="File Logging">
+  <settings>
+   <!-- File to log to -->
+   <param name="logfile" value="/var/log/freeswitch.log"/>
+   <!-- At this length in bytes rotate the log file -->
+   <param name="rollover" value="12000"/>
+   <!-- The level of the message to log -->
+   <!--<param name="level" value="debug,info,warning,notice,error,crit,alert"/>-->
+    <param name="level" value="all"/>
+    <!-- Format of the log messages -->
+  <!-- ${time} ${file} ${func} ${message} -->
+  <param name="format"   value="${time} ${file} ${func} ${message}"/>  
+</settings>
+</configuration>
+

src/include/switch_apr.h

@@ -602,6 +602,21 @@ SWITCH_DECLARE(switch_status_t) switch_queue_trypush(switch_queue_t * queue, voi
 	 typedef int32_t switch_fileperms_t;
 	 typedef int switch_seek_where_t;
 
+	 /**
+ * @defgroup apr_file_seek_flags File Seek Flags
+ * @{
+ */
+
+/* flags for apr_file_seek */
+/** Set the file position */
+#define SWITCH_SEEK_SET SEEK_SET
+/** Current */
+#define SWITCH_SEEK_CUR SEEK_CUR
+/** Go to end of file */
+#define SWITCH_SEEK_END SEEK_END
+/** @} */
+
+
 /**
  * @defgroup switch_file_permissions File Permissions flags 
  * @ingroup switch_file_io

src/mod/loggers/mod_logfile/mod_logfile.c

+/* 
+ * FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ *
+ * Version: MPL 1.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (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.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is FreeSWITCH Modular Media Switching Software Library / Soft-Switch Application
+ *
+ * The Initial Developer of the Original Code is
+ * Anthony Minessale II <anthmct@yahoo.com>
+ * Portions created by the Initial Developer are Copyright (C)
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * 
+ * Anthony LaMantia <anthony@petabit.net>
+ * Michael Jerris <mike@jerris.com>
+ *
+ *
+ * mod_logfile.c -- Filesystem Logging
+ *
+ */
+
+#include <switch.h>
+
+SWITCH_MODULE_LOAD_FUNCTION(mod_logfile_load);
+SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_logfile_shutdown);
+SWITCH_MODULE_DEFINITION(mod_logfile, mod_logfile_load, mod_logfile_shutdown, NULL);
+
+#define DEFAULT_FORMAT   "${data}" 
+#define DEFAULT_LIMIT    0x7FFFFFFF
+#define WARM_FUZZY_OFFSET 64
+#define MAX_ROT 4096 /* why not */
+static const uint8_t STATIC_LEVELS[] = {0, 1, 2, 3, 4, 5, 6, 7, 8};
+
+static switch_status_t load_config(void);
+static switch_status_t mod_logfile_check(void);
+static switch_memory_pool_t *module_pool = NULL;
+
+static struct {
+	unsigned int log_fd;
+	switch_size_t log_size;   /* keep the log size in check for rotation */
+	switch_size_t roll_size;  /* the size that we want to rotate the file at */
+	char *logfile;
+	char *format;
+	switch_file_t    *log_afd;
+} globals;
+
+SWITCH_DECLARE_GLOBAL_STRING_FUNC(set_global_logfile, globals.logfile);
+SWITCH_DECLARE_GLOBAL_STRING_FUNC(set_global_format, globals.format);
+
+/* i know this is strange but it's the fastest way i could think of managing log levels. */
+/* i'd rather not try to search something each time we get a message to log */
+struct level_set {
+	int level;
+	int on;
+} static levels[] = {
+	{SWITCH_LOG_CONSOLE, 0},   /* 0 */
+	{SWITCH_LOG_ALERT,   0},   /* 1 */
+	{SWITCH_LOG_CRIT,    0},   /* 2 */
+	{SWITCH_LOG_ERROR,   0},   /* 3 */
+	{SWITCH_LOG_WARNING, 0},   /* 4 */
+	{SWITCH_LOG_NOTICE,  0},   /* 5 */
+	{SWITCH_LOG_INFO,    0},   /* 6 */
+	{SWITCH_LOG_DEBUG,   0},   /* 7 */
+};
+
+void process_levels(char *p)
+{
+	int x, argc = 0;
+	char *argv[10] = { 0 };
+
+	if ((argc = switch_separate_string(p, ',', argv, (sizeof(argv) / sizeof(argv[0]))))) {
+		for (x = 0; x < argc; x++) {
+			if (!strncasecmp(argv[x], "alert", strlen(argv[x]))) {
+				levels[SWITCH_LOG_ALERT].on = 1;
+			} else if (!strncasecmp(argv[x], "crit", strlen(argv[x]))) {
+				levels[SWITCH_LOG_CRIT].on = 1;
+			} else if (!strncasecmp(argv[x], "error", strlen(argv[x]))) {
+				levels[SWITCH_LOG_ERROR].on = 1;
+			} else if (!strncasecmp(argv[x], "warn", strlen(argv[x]))) {
+				levels[SWITCH_LOG_WARNING].on = 1;
+			} else if (!strncasecmp(argv[x], "notice", strlen(argv[x]))) {
+				levels[SWITCH_LOG_NOTICE].on = 1;
+			} else if (!strncasecmp(argv[x], "info", strlen(argv[x]))) {
+				levels[SWITCH_LOG_INFO].on = 1;
+			} else if (!strncasecmp(argv[x], "debug", strlen(argv[x]))) {
+				levels[SWITCH_LOG_DEBUG].on = 1;
+			} else if (!strncasecmp(argv[x], "console", strlen(argv[x]))) {
+				levels[SWITCH_LOG_CONSOLE].on = 1;
+			} else if (!strncasecmp(argv[x], "all", strlen(argv[x]))) {
+				int i;
+				for (i=0; i < (sizeof(levels) / sizeof(struct level_set)); i++) {
+					levels[i].on = 1;
+				}
+			}
+		}
+	}
+	return;
+}
+
+/* rotate the log file */
+static switch_status_t mod_logfile_rotate(void)
+{
+	unsigned int i = 0;
+	unsigned int flags = 0;
+	char *p = NULL;
+	char *q = NULL;
+	switch_status_t stat = 0;
+	switch_size_t   nbytes = 1024;
+	switch_file_t *l_afd = NULL;
+	switch_memory_pool_t *pool = NULL;
+	int64_t offset = 0;
+
+	globals.log_size = 0;
+	switch_core_new_memory_pool(&pool);   
+
+	stat = switch_file_seek(globals.log_afd, SWITCH_SEEK_SET, &offset);
+
+	if (stat != SWITCH_STATUS_SUCCESS)
+		return SWITCH_STATUS_FALSE;
+
+	p = malloc(strlen(globals.logfile)+WARM_FUZZY_OFFSET);
+	if (!p) {
+		return SWITCH_STATUS_FALSE;
+	}
+
+	q = malloc(1024);
+	if (!q) {
+		free(p);
+		return SWITCH_STATUS_FALSE;
+	}
+
+	memset(p, '\0', strlen(globals.logfile)+WARM_FUZZY_OFFSET);
+
+	for (i=1; i < MAX_ROT; i++) {
+		sprintf((char *)p, "%s.%i", globals.logfile, i);
+
+		stat = switch_file_open(&l_afd, p, SWITCH_FOPEN_READ, SWITCH_FPROT_UREAD, pool);
+
+		if (stat == SWITCH_STATUS_SUCCESS) {
+			switch_file_close(l_afd);
+			continue;
+		}
+		flags |= SWITCH_FOPEN_READ;
+		flags |= SWITCH_FOPEN_WRITE;
+		flags |= SWITCH_FOPEN_CREATE;
+
+		stat = switch_file_open(&l_afd, p, flags , SWITCH_FPROT_UREAD | SWITCH_FPROT_UWRITE ,pool);
+		if (stat == SWITCH_STATUS_SUCCESS)
+			break;
+	}
+
+	while ((stat = switch_file_read(globals.log_afd, q, &nbytes)) == SWITCH_STATUS_SUCCESS) {
+		switch_file_write(l_afd, q, &nbytes);
+		memset(q, '\0', 1024);
+		nbytes = 1024;
+	}
+
+	offset = 0;
+	stat = switch_file_seek(globals.log_afd, SWITCH_SEEK_SET, &offset);
+	free(p);
+	free(q);
+	return SWITCH_STATUS_SUCCESS;
+}
+
+static switch_status_t mod_logfile_openlogfile(void)
+{
+	unsigned int flags = 0;
+	switch_file_t *afd;
+	switch_status_t stat;
+	switch_memory_pool_t *pool;
+
+	flags |= SWITCH_FOPEN_CREATE;
+	flags |= SWITCH_FOPEN_READ;
+	flags |= SWITCH_FOPEN_WRITE;
+	flags |= SWITCH_FOPEN_APPEND;
+
+	switch_core_new_memory_pool(&pool);       
+	stat = switch_file_open(&afd, globals.logfile,flags,SWITCH_FPROT_UREAD|SWITCH_FPROT_UWRITE, pool);
+	if (stat != SWITCH_STATUS_SUCCESS) {
+		return SWITCH_STATUS_FALSE;
+	}
+
+	globals.log_afd = afd;
+
+	globals.log_size = switch_file_get_size(globals.log_afd);
+
+	if (globals.log_size >= globals.roll_size) {
+		mod_logfile_rotate();
+	}
+
+	return SWITCH_STATUS_SUCCESS;
+}
+
+/* write to the actual logfile */
+static switch_status_t mod_logfile_write(char *fmt, ...) 
+{
+	char *log_data;
+	switch_status_t stat;
+	switch_size_t len;
+	va_list args;
+	va_start(args, fmt);
+
+	len = switch_vasprintf(&log_data, fmt, args);
+
+	if (len <= 0)
+		return SWITCH_STATUS_FALSE;
+
+	stat = switch_file_write(globals.log_afd, log_data, &len);
+
+	globals.log_size += len;
+
+	/* we may want to hold back on this for preformance reasons */
+	if (globals.log_size >= globals.roll_size) {
+		mod_logfile_rotate();
+	}
+
+	return SWITCH_STATUS_SUCCESS;
+}
+
+static switch_status_t mod_logfile_logger(const switch_log_node_t *node, switch_log_level_t level)
+{
+	char line_no[sizeof(int)*8+1];
+	char date[80] = "";
+	switch_time_exp_t time;
+	switch_size_t retsize;
+	char *message = NULL;
+
+	if (!levels[node->level].on) {
+		return SWITCH_STATUS_SUCCESS;
+	}
+
+	message = (char *)malloc(strlen(globals.format)+2);
+	switch_copy_string(message, globals.format, strlen(globals.format)+1);
+
+	message = switch_string_replace(message, "${message}", node->content);
+
+	if (switch_time_exp_lt(&time, node->timestamp) != SWITCH_STATUS_SUCCESS) {
+		return SWITCH_STATUS_FALSE;
+	}
+
+	switch_strftime(date, &retsize, sizeof(date), "%Y-%m-%d %T", &time);
+
+	message = switch_string_replace(message, "${time}", date);
+	message = switch_string_replace(message, "${file}", node->file);
+	message = switch_string_replace(message, "${func}", node->func);
+
+	snprintf(line_no, sizeof(line_no), "%d", node->line);
+	message = switch_string_replace(message, "${line}", line_no);
+
+	if (!switch_strlen_zero(message)) {
+		mod_logfile_write("%s", message);
+	}
+
+	return SWITCH_STATUS_SUCCESS;
+}
+
+static switch_status_t load_config(void)
+{
+	char *cf = "logfile.conf";
+	switch_xml_t cfg, xml, settings, param;
+
+	if (!(xml = switch_xml_open_cfg(cf, &cfg, NULL))) {
+		switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "open of %s failed\n", cf);
+	} else {
+		if ((settings = switch_xml_child(cfg, "settings"))) {
+			for (param = switch_xml_child(settings, "param"); param; param = param->next) {
+				char *var = (char *) switch_xml_attr_soft(param, "name");
+				char *val = (char *) switch_xml_attr_soft(param, "value");
+				if (!strcmp(var, "logfile")) {
+					set_global_logfile(val);
+				} else if (!strcmp(var, "format")) {
+					set_global_format(val);
+				} else if (!strcmp(var, "level")) {
+					process_levels(val);
+				} else if (!strcmp(var, "rollover")) {
+					globals.roll_size = atoi(val);
+				}  
+			}
+		}
+		switch_xml_free(xml);
+	}
+	if (globals.roll_size == 0) {
+		globals.roll_size = DEFAULT_LIMIT;
+	}
+	if (switch_strlen_zero(globals.logfile)) {
+		char logfile[512];
+		snprintf(logfile, sizeof(logfile), "%s%s%s", SWITCH_GLOBAL_dirs.log_dir, SWITCH_PATH_SEPARATOR, "freeswitch.log");
+		set_global_logfile(logfile);
+	}
+	if (switch_strlen_zero(globals.format)) {
+		set_global_format(DEFAULT_FORMAT);
+	}
+	return 0;
+}
+
+SWITCH_MODULE_LOAD_FUNCTION(mod_logfile_load)
+{
+	switch_status_t status;
+
+	module_pool = pool;
+
+	/* connect my internal structure to the blank pointer passed to me */
+	*module_interface = switch_loadable_module_create_module_interface(pool, modname);
+
+	if ((status=load_config()) != SWITCH_STATUS_SUCCESS) {
+		return status;
+	}
+
+	mod_logfile_openlogfile();
+
+	switch_log_bind_logger(mod_logfile_logger, SWITCH_LOG_DEBUG);
+
+	return SWITCH_STATUS_SUCCESS;
+}
+
+SWITCH_MODULE_SHUTDOWN_FUNCTION(mod_logfile_shutdown)
+{
+	/* TODO:  Need to finish processing pending log messages before we close the file handle */
+
+	//switch_file_close(globals.log_afd);	
+	return SWITCH_STATUS_SUCCESS;
+}
+
+/* For Emacs:
+* Local Variables:
+* mode:c
+* indent-tabs-mode:nil
+* tab-width:4
+* c-basic-offset:4
+* End:
+* For VIM:
+* vim:set softtabstop=4 shiftwidth=4 tabstop=4 expandtab:
+*/

src/mod/loggers/mod_logfile/mod_logfile.vcproj

+<?xml version="1.0" encoding="Windows-1252"?>
+<VisualStudioProject
+	ProjectType="Visual C++"
+	Version="8.00"
+	Name="mod_logfile"
+	ProjectGUID="{D0BCAC02-D94B-46B8-9B49-CDDCC2BD7909}"
+	RootNamespace="mod_logfile"
+	Keyword="Win32Proj"
+	>
+	<Platforms>
+		<Platform
+			Name="Win32"
+		/>
+	</Platforms>
+	<ToolFiles>
+	</ToolFiles>
+	<Configurations>
+		<Configuration
+			Name="Debug|Win32"
+			ConfigurationType="2"
+			InheritedPropertySheets="..\..\..\..\w32\module_debug.vsprops"
+			CharacterSet="2"
+			>
+			<Tool
+				Name="VCPreBuildEventTool"
+			/>
+			<Tool
+				Name="VCCustomBuildTool"
+			/>
+			<Tool
+				Name="VCXMLDataGeneratorTool"
+			/>
+			<Tool
+				Name="VCWebServiceProxyGeneratorTool"
+			/>
+			<Tool
+				Name="VCMIDLTool"
+			/>
+			<Tool
+				Name="VCCLCompilerTool"
+				UsePrecompiledHeader="0"
+			/>
+			<Tool
+				Name="VCManagedResourceCompilerTool"
+			/>
+			<Tool
+				Name="VCResourceCompilerTool"
+			/>
+			<Tool
+				Name="VCPreLinkEventTool"
+			/>
+			<Tool
+				Name="VCLinkerTool"
+			/>
+			<Tool
+				Name="VCALinkTool"
+			/>
+			<Tool
+				Name="VCManifestTool"
+			/>
+			<Tool
+				Name="VCXDCMakeTool"
+			/>
+			<Tool
+				Name="VCBscMakeTool"
+			/>
+			<Tool
+				Name="VCFxCopTool"
+			/>
+			<Tool
+				Name="VCAppVerifierTool"
+			/>
+			<Tool
+				Name="VCWebDeploymentTool"
+			/>
+			<Tool
+				Name="VCPostBuildEventTool"
+			/>
+		</Configuration>
+		<Configuration
+			Name="Release|Win32"
+			ConfigurationType="2"
+			InheritedPropertySheets="..\..\..\..\w32\module_release.vsprops"
+			CharacterSet="2"
+			>
+			<Tool
+				Name="VCPreBuildEventTool"
+			/>
+			<Tool
+				Name="VCCustomBuildTool"
+			/>
+			<Tool
+				Name="VCXMLDataGeneratorTool"
+			/>
+			<Tool
+				Name="VCWebServiceProxyGeneratorTool"
+			/>
+			<Tool
+				Name="VCMIDLTool"
+			/>
+			<Tool
+				Name="VCCLCompilerTool"
+				UsePrecompiledHeader="0"
+			/>
+			<Tool
+				Name="VCManagedResourceCompilerTool"
+			/>
+			<Tool
+				Name="VCResourceCompilerTool"
+			/>
+			<Tool
+				Name="VCPreLinkEventTool"
+			/>
+			<Tool
+				Name="VCLinkerTool"
+			/>
+			<Tool
+				Name="VCALinkTool"
+			/>
+			<Tool
+				Name="VCManifestTool"
+			/>
+			<Tool
+				Name="VCXDCMakeTool"
+			/>
+			<Tool
+				Name="VCBscMakeTool"
+			/>
+			<Tool
+				Name="VCFxCopTool"
+			/>
+			<Tool
+				Name="VCAppVerifierTool"
+			/>
+			<Tool
+				Name="VCWebDeploymentTool"
+			/>
+			<Tool
+				Name="VCPostBuildEventTool"
+			/>
+		</Configuration>
+	</Configurations>
+	<References>
+	</References>
+	<Files>
+		<File
+			RelativePath=".\mod_logfile.c"
+			>
+		</File>
+	</Files>
+	<Globals>
+	</Globals>
+</VisualStudioProject>