summaryrefslogtreecommitdiffstats
path: root/source/utils/debug2html.c
blob: ef7201168fa97c1f87a4f206bddacce630d9a941 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
/* ========================================================================== **
 *                                debug2html.c
 *
 * Copyright (C) 1998 by Christopher R. Hertel
 *
 * Email: crh@ubiqx.mn.org
 *
 * -------------------------------------------------------------------------- **
 * Parse Samba debug logs (2.0 & greater) and output the results as HTML.
 * -------------------------------------------------------------------------- **
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * -------------------------------------------------------------------------- **
 * This program provides an example of the use of debugparse.c, and also
 * does a decent job of converting Samba logs into HTML.
 * -------------------------------------------------------------------------- **
 *
 * $Revision: 1.9 $
 *
 * ========================================================================== **
 */

#include "includes.h"

/* -------------------------------------------------------------------------- **
 * Global values.
 */

FILE *infile;
FILE *outfile;

/* -------------------------------------------------------------------------- **
 * The size of the read buffer.
 */

#define DBG_BSIZE 1024

/* -------------------------------------------------------------------------- **
 * Functions...
 */

static dbg_Token modechange( dbg_Token new, dbg_Token mode )
  /* ------------------------------------------------------------------------ **
   * Handle a switch between header and message printing.
   *
   *  Input:  new   - The token value of the current token.  This indicates
   *                  the lexical item currently being recognized.
   *          mode  - The current mode.  This is either dbg_null or
   *                  dbg_message.  It could really be any toggle
   *                  (true/false, etc.)
   *
   *  Output: The new mode.  This will be the same as the input mode unless
   *          there was a transition in or out of message processing.
   *
   *  Notes:  The purpose of the mode value is to mark the beginning and end
   *          of the message text block.  In order to show the text in its
   *          correct format, it must be included within a <PRE></PRE> block.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  switch( new )
    {
    case dbg_null:
    case dbg_ignore:
      return( mode );
    case dbg_message:
      if( dbg_message != mode )
        {
        /* Switching to message mode. */
        (void)fprintf( outfile, "<PRE>\n" );
        return( dbg_message );
        }
      break;
    default:
      if( dbg_message == mode )
        {
        /* Switching out of message mode. */
        (void)fprintf( outfile, "</PRE>\n\n" );
        return( dbg_null );
        }
    }

  return( mode );
  } /* modechange */

static void newblock( dbg_Token old, dbg_Token new )
  /* ------------------------------------------------------------------------ **
   * Handle the transition between tokens.
   *
   *  Input:  old - The previous token.
   *          new - The current token.
   *
   *  Output: none.
   *
   *  Notes:  This is called whenever there is a transition from one token
   *          type to another.  It first prints the markup tags that close
   *          the previous token, and then the markup tags for the new
   *          token.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  switch( old )
    {
    case dbg_timestamp:
      (void)fprintf( outfile, ",</B>" );
      break;
    case dbg_level:
      (void)fprintf( outfile, "</FONT>]</B>\n   " );
      break;
    case dbg_sourcefile:
      (void)fprintf( outfile, ":" );
      break;
    case dbg_lineno:
      (void)fprintf( outfile, ")" );
      break;
    default:
      break;
    }

  switch( new )
    {
    case dbg_timestamp:
      (void)fprintf( outfile, "<B>[" );
      break;
    case dbg_level:
      (void)fprintf( outfile, " <B><FONT COLOR=MAROON>" );
      break;
    case dbg_lineno:
      (void)fprintf( outfile, "(" );
      break;
    default:
      break;
    }
  } /* newblock */

static void charprint( dbg_Token tok, int c )
  /* ------------------------------------------------------------------------ **
   * Filter the input characters to determine what goes to output.
   *
   *  Input:  tok - The token value of the current character.
   *          c   - The current character.
   *
   *  Output: none.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  switch( tok )
    {
    case dbg_ignore:
    case dbg_header:
      break;
    case dbg_null:
    case dbg_eof:
      (void)putc( '\n', outfile );
      break;
    default:
      switch( c )
        {
        case '<':
          (void)fprintf( outfile, "&lt;" );
          break;
        case '>':
          (void)fprintf( outfile, "&gt;" );
          break;
        case '&':
          (void)fprintf( outfile, "&amp;" );
          break;
        case '\"':
          (void)fprintf( outfile, "&#34;" );
          break;
        default:
          (void)putc( c, outfile );
          break;
        }
    }
  } /* charprint */

static void convert( void )
  /* ------------------------------------------------------------------------ **
   * Read the input logfile, converting the entries to HTML.
   *
   *  Input:  none.
   *  output: none.
   *  Notes:  Reads from the global infile, writes to the global outfile.
   *          These default to stdin and stdout, respectively.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  int       i;
  int       len;
  char      bufr[DBG_BSIZE];
  dbg_Token old   = dbg_null,
            new   = dbg_null,
            state = dbg_null,
            mode  = dbg_null;

  while( (!feof( infile ))
      && ((len = fread( bufr, 1, DBG_BSIZE, infile )) > 0) )
    {
    for( i = 0; i < len; i++ )
      {
      old = new;
      new = dbg_char2token( &state, bufr[i] );
      if( new != old )
        {
        mode = modechange( new, mode );
        newblock( old, new );
        }
      charprint( new, bufr[i] );
      }
    }
  (void)modechange( dbg_eof, mode );

  } /* convert */

static void usage( void )
  /* ------------------------------------------------------------------------ **
   * Prints a usage message on stderr, then gently exits.
   *
   *  Input:  none.
   *  Output: none.  Exits with return code of 0.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  fprintf( stderr, "This utility converts Samba log files " );
  fprintf( stderr, "into HTML documents.\n" );
  fprintf( stderr, "Usage:\n" );
  fprintf( stderr, "  debug2html <infile> <outfile>\n" );
  exit( 0 );
  } /* usage */

static FILE *carefull_fopen( const char *path, const char *type )
  /* ------------------------------------------------------------------------ **
   * Checks for leading '-' characters, which are generically regarded as
   * flags.  Also exits the program gracefully should the file fail to open.
   *
   *  Input:  path  - pathname of the file to open.
   *          type  - open mode.  See fopen(3S).
   *
   *  Output: Pointer to open file.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  FILE *tmp;

  if( '-' == path[0] || '\0' == path[0] )
    usage();

  tmp = sys_fopen( path, type );
  if( NULL == tmp )
    {
    fprintf( stderr, "Error opening file %s: %s\n", path, strerror(errno) );
    exit( 1 );
    }
  return( tmp );
  } /* carefull_fopen */

int main( int argc, char *argv[] )
  /* ------------------------------------------------------------------------ **
   * This simple program scans and parses Samba debug logs, and produces HTML
   * output.
   *
   *  Input:  argc    - Argument count.
   *          argv[1] - Input file name.
   *          argv[2] - Output file name.
   *                    A '-' character by itself means use defaults (i.e.,
   *                    <stdin> or <stdout> depending upon the argument.
   *                    A string beginning with '-' and containing more than
   *                    that one character will generate a usage message.
   *
   *  Output: An exit value of 1 is returned if an error was encountered
   *          while opening a file, else 0.
   *
   *  Notes:  The HTML output is sent to stdout.
   *
   * ------------------------------------------------------------------------ **
   */
  {
  if( argc > 3 )
    usage();

  infile = stdin;
  outfile = stdout;

  if( argc > 1 && 0 != strcmp( argv[1], "-" ) )
    infile = carefull_fopen( argv[1], "r" );

  if( argc > 2 && 0 != strcmp( argv[2], "-" ) )
    infile = carefull_fopen( argv[2], "w" );

  (void)fprintf( outfile,
                 "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2//EN\">\n" );
  (void)fprintf( outfile, "<HTML>\n<HEAD>\n" );
  (void)fprintf( outfile,
                 "  <TITLE>Samba Log</TITLE>\n</HEAD>\n\n<BODY>\n" );

  convert();

  (void)fprintf( outfile, "</BODY>\n</HTML>\n" );

  return( 0 );
  } /* main */