-
Notifications
You must be signed in to change notification settings - Fork 0
/
error.c
1653 lines (1437 loc) · 46.3 KB
/
error.c
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*****
** ** Module Header ******************************************************* **
** **
** Modules Revision 3.0 **
** Providing a flexible user environment **
** **
** File: error.c **
** First Edition: 1991/10/23 **
** **
** Authors: Jens Hamisch, jens@Strawberry.COM **
** **
** Description: The modules error logger **
** **
** Exports: Module_Error **
** GetFacilityPtr **
** CheckFacility **
** Enable_Error **
** Disable_Error **
** Restore_Error **
** **
** Notes: **
** **
** ************************************************************************ **
****/
/** ** Copyright *********************************************************** **
** **
** Copyright 1991-1994 by John L. Furlan. **
** see LICENSE.GPL, which must be provided, for details **
** **
** ************************************************************************ **/
static char Id[] = "@(#)$Id: 9f494464b6c815a95b0566b7d69c09cab7aee19f $";
static void *UseId[] = { &UseId, Id };
/** ************************************************************************ **/
/** HEADERS **/
/** ************************************************************************ **/
#include "modules_def.h"
#if HAVE_STDARG_H
# include <stdarg.h>
#else
# error "You need an ANSI C compiler"
#endif
#if defined(HAVE_SYSLOG) && defined(WITH_LOGGING)
# include <syslog.h>
#endif
#include <pwd.h>
#include <grp.h>
/** ************************************************************************ **/
/** LOCAL DATATYPES **/
/** ************************************************************************ **/
/**
** Error weights
**/
typedef enum _err_weights {
WGHT_NONE=0, /** Dummy value: No error **/
WGHT_VERBOSE, /** Verbose messages **/
WGHT_INFO=3, /** Informal message **/
WGHT_DEBUG=5, /** Debugger output **/
WGHT_TRACE, /** Tracing output **/
WGHT_WARN=10, /** Warning: Prog. flow not affected **/
WGHT_PROB=20, /** Problem: Prog. flow cond. aff. **/
WGHT_ERROR=25, /** Error and Fatal: Prog. flow aff. **/
WGHT_FATAL=27, /** Return to the caller **/
WGHT_PANIC=29 /** Panic: Exit program immediatelly **/
} ErrWeights;
/**
** Log facilities
**/
typedef struct _err_facility {
ErrWeights Weight; /** Error weight **/
char *facility; /** Log facility **/
char *def_facility; /** Default facility (facility undef)**/
} ErrFacilities;
typedef struct _facil_names {
char *name; /** Name of a facility **/
int token; /** Assigned token **/
} FacilityNames;
/**
** Error measurement table
**/
typedef struct {
ErrWeights error_weight; /** The weight itsself **/
char *message; /** Message to be printed **/
ErrCode ret_nov, /** Return code **/
ret_adv,
ret_exp;
} ErrMeasr;
/**
** Error code translation table
**/
typedef struct {
ErrType error_type; /** The error type as specified by **/
/** the caller **/
ErrWeights error_weight; /** The weight of this error **/
char *messages; /** List of messages to be printed **/
} ErrTransTab;
/** ************************************************************************ **/
/** CONSTANTS **/
/** ************************************************************************ **/
#define ARGLIST_SIZE 10
#define ERR_LINELEN 80 /** internal buffer size **/
#define ERR_BUFSIZE 4096 /** buffer for the whole error msg. **/
/** ************************************************************************ **/
/** MACROS **/
/** ************************************************************************ **/
/** not applicable **/
/** ************************************************************************ **/
/** LOCAL DATA **/
/** ************************************************************************ **/
static char module_name[] = "error.c"; /** File name of this module **/
/**
** Local flags
**/
static int quiet_on_error = 0;
/**
** Local strings
**/
static char unknown[] = "unknown"; /** If something's unknown **/
static char buffer[ ERR_LINELEN]; /** Internal string buffer **/
char *error_line = NULL;
static int strsize = 0;
/**
** Log facility table
**/
static char _stderr[] = "stderr";
static char _stdout[] = "stdout";
static char _null[] = "null";
static char _none[] = "none";
static char _unknown[] = "unknown";
static ErrFacilities Facilities[] = {
{ WGHT_NONE, NULL, NULL },
{ WGHT_VERBOSE, NULL, DEF_FACILITY_VERBOSE },
{ WGHT_INFO, NULL, DEF_FACILITY_INFO },
{ WGHT_DEBUG, NULL, DEF_FACILITY_DEBUG },
{ WGHT_TRACE, NULL, DEF_FACILITY_TRACE },
{ WGHT_WARN, NULL, DEF_FACILITY_WARN },
{ WGHT_PROB, NULL, DEF_FACILITY_PROB },
{ WGHT_ERROR, NULL, DEF_FACILITY_ERROR },
{ WGHT_FATAL, NULL, DEF_FACILITY_FATAL },
{ WGHT_PANIC, NULL, DEF_FACILITY_PANIC }
};
/**
** Syslog facility names
**/
static FacilityNames facility_names[] = {
#if defined(HAVE_SYSLOG) && defined(WITH_LOGGING)
{ "auth", LOG_AUTH },
{ "cron", LOG_CRON },
{ "daemon", LOG_DAEMON },
{ "kern", LOG_KERN },
{ "local0", LOG_LOCAL0 },
{ "local1", LOG_LOCAL1 },
{ "local2", LOG_LOCAL2 },
{ "local3", LOG_LOCAL3 },
{ "local4", LOG_LOCAL4 },
{ "local5", LOG_LOCAL5 },
{ "local6", LOG_LOCAL6 },
{ "local7", LOG_LOCAL7 },
{ "lpr", LOG_LPR },
{ "mail", LOG_MAIL },
{ "news", LOG_NEWS },
{ "user", LOG_USER },
{ "uucp", LOG_UUCP }
#else
{ "none", 0 }
#endif
};
/**
** Syslog level names
**/
static FacilityNames level_names[] = {
#if defined(HAVE_SYSLOG) && defined(WITH_LOGGING)
{ "alert", LOG_ALERT },
{ "crit", LOG_CRIT },
{ "debug", LOG_DEBUG },
{ "emerg", LOG_EMERG },
{ "err", LOG_ERR },
{ "info", LOG_INFO },
{ "notice", LOG_NOTICE },
{ "warning", LOG_WARNING }
#else
{ "none", 0 }
#endif
};
/**
** Error measurement table
** Take care that this list is sorted in ascending order concerning the error
** weights
**/
#define MEAS_VERB_NDX 1 /** Index of the 'VERBOSE' entry **/
static ErrMeasr Measurements[] = {
{ WGHT_NONE, "" , OK, OK, OK },
{ WGHT_VERBOSE,"VERB" , OK, OK, OK },
{ WGHT_INFO, "INFO" , OK, OK, OK },
{ WGHT_DEBUG, "DEBUG", OK, OK, OK },
{ WGHT_TRACE, "TRACE", OK, OK, OK },
{ WGHT_WARN, "WARN" , PROBLEM, WARN, OK },
{ WGHT_PROB, "PROB" , ERROR, PROBLEM, OK },
{ WGHT_ERROR, "ERROR", ERROR, ERROR, ERROR },
{ WGHT_FATAL, "FATAL", FATAL, FATAL, FATAL },
{ WGHT_PANIC, "PANIC", PANIC, PANIC, PANIC },
};
/**
** Error code translation table
** Take care that this list is sorted in ascending order concerning the error
** types
**/
static ErrTransTab TransTab[] = {
{ NO_ERR, WGHT_NONE, NULL },
{ NO_ERR_DEBUG, WGHT_DEBUG, "$*" },
{ NO_ERR_START, WGHT_DEBUG, "Starting $*" },
{ NO_ERR_END, WGHT_DEBUG, "Exit $*" },
{ NO_ERR_VERBOSE, WGHT_VERBOSE, NULL },
{ ERR_PARAM, WGHT_ERROR, "Parameter error concerning '$1'" },
{ ERR_USAGE, WGHT_ERROR, "Usage is '$*'" },
{ ERR_ARGSTOLONG, WGHT_ERROR, "'$1': Arguments too long. Max. is '$2'" },
{ ERR_OPT_AMBIG, WGHT_ERROR, "Option '$1' is ambiguous" },
{ ERR_OPT_NOARG, WGHT_ERROR, "Option '$1' allows no argument" },
{ ERR_OPT_REQARG, WGHT_ERROR, "Option '$1' requires an argument" },
{ ERR_OPT_UNKNOWN, WGHT_ERROR, "Unrecognized option '$1'" },
{ ERR_OPT_ILL, WGHT_ERROR, "Illegal option '$1'" },
{ ERR_OPT_INV, WGHT_ERROR, "Invalid option '$1'" },
{ ERR_USERLVL, WGHT_ERROR, "Undefined userlevel '$1'" },
{ ERR_GETOPT, WGHT_FATAL, "getopt() failed" },
{ ERR_OPEN, WGHT_ERROR, "Cannot open file '$1' for '$2'" },
{ ERR_POPEN, WGHT_ERROR, "Cannot open pipe '$1' for '$2'" },
{ ERR_OPENDIR, WGHT_ERROR, "Cannot open directory '$1' for reading" },
{ ERR_CLOSE, WGHT_WARN, "Cannot close file '$1'" },
{ ERR_PCLOSE, WGHT_WARN, "Cannot close pipe '$1'" },
{ ERR_CLOSEDIR, WGHT_WARN, "Cannot close directory '$1'" },
{ ERR_READ, WGHT_ERROR, "Error while reading file '$1'" },
{ ERR_READDIR, WGHT_ERROR, "Error while reading directory '$1'" },
{ ERR_WRITE, WGHT_ERROR, "Error while writing file '$1'" },
{ ERR_SEEK, WGHT_ERROR, "Seek error on file '$1'" },
{ ERR_FLUSH, WGHT_WARN, "Flush error on file '$1'" },
{ ERR_DUP, WGHT_WARN, "Cannot duplicate handle of file '$1'" },
{ ERR_DIRNAME, WGHT_ERROR, "Cannot build directory name" },
{ ERR_NAMETOLONG, WGHT_ERROR, "Requested directory name to long: "
"dir='$1',file='$2'" },
{ ERR_DIRNOTFOUND, WGHT_ERROR, "Directory '$1' not found" },
{ ERR_FILEINDIR, WGHT_ERROR, "File '$1' not found in directory '$2'" },
{ ERR_NODIR, WGHT_ERROR, "'$1' is not a directory" },
{ ERR_UNLINK, WGHT_WARN, "Cannot unlink '$1'" },
{ ERR_RENAME, WGHT_PROB, "Cannot rename '$1' to '$2'" },
{ ERR_ALLOC, WGHT_FATAL, "Out of memory." },
{ ERR_SOURCE, WGHT_WARN, "Error sourcing file '$1'" },
{ ERR_UNAME, WGHT_FATAL, "'uname (2)' failed." },
{ ERR_GETHOSTNAME, WGHT_FATAL, "'gethostname (2)' failed." },
{ ERR_GETDOMAINNAME,WGHT_FATAL, "'getdomainname (2)' failed." },
{ ERR_STRING, WGHT_FATAL, "string error" },
{ ERR_DISPLAY, WGHT_ERROR, "Cannot open display" },
{ ERR_PARSE, WGHT_ERROR, "Parse error" },
{ ERR_EXEC, WGHT_ERROR, "Tcl command execution failed: $1" },
{ ERR_EXTRACT, WGHT_ERROR, "Cannot extract X11 resources" },
{ ERR_COMMAND, WGHT_ERROR, "'$1' is an unrecognized subcommand" },
{ ERR_LOCATE, WGHT_ERROR, "Unable to locate a modulefile for '$1'" },
{ ERR_MAGIC, WGHT_ERROR, "Magic cookie '#%Module' missing in '$1'" },
{ ERR_MODULE_PATH, WGHT_ERROR, "'MODULEPATH' not set" },
{ ERR_HOME, WGHT_ERROR, "'HOME' not set" },
{ ERR_SHELL, WGHT_ERROR, "Unknown shell type '$1'" },
{ ERR_DERELICT, WGHT_ERROR, "Unknown shell derelict '$1'" },
{ ERR_CONFLICT, WGHT_ERROR, "Module '$1' conflicts with the currently "
"loaded module(s) '$2*'" },
{ ERR_PREREQ, WGHT_ERROR, "Module '$1' depends on one of the "
"module(s) '$2*'" },
{ ERR_NOTLOADED, WGHT_ERROR, "Module '$1' is currently not loaded" },
{ ERR_DUP_SYMVERS, WGHT_PROB, "Duplicate version symbol '$1' found" },
{ ERR_SYMLOOP, WGHT_ERROR, "Version symbol '$1' loops" },
{ ERR_BADMODNAM, WGHT_PROB, "Invalid modulename '$1' found" },
{ ERR_DUP_ALIAS, WGHT_WARN, "Duplicate alias '$1' found" },
{ ERR_CACHE_INVAL, WGHT_ERROR, "Invalid cache version '$1' found" },
{ ERR_CACHE_LOAD, WGHT_WARN, "Couldn't load the cache properly" },
{ ERR_BEGINENV, WGHT_WARN, "Invalid update subcommand - "
#ifdef BEGINENV
# if BEGINENV == 99
"No _MODULESBEGINENV_ file"
# else
"No .modulesbeginenv file"
# endif
#else
".modulesbeginenv not supported"
#endif
},
{ ERR_BEGINENVX, WGHT_WARN,
"Invalid update subcommand - No MODULESBEGINENV - hence not supported"},
{ ERR_INIT_TCL, WGHT_ERROR, "Cannot initialize TCL" },
{ ERR_INIT_TCLX, WGHT_WARN, "Cannot initialize TCLX modules using "
"extended commands might fail" },
{ ERR_INIT_ALPATH, WGHT_WARN, "Could not extend auto_path variable. "
"Module using autoloadable functions might "
"fail" },
{ ERR_INIT_STUP, WGHT_WARN, "Cannot find a 'module load' command in "
"any of the '$1' startup files" },
{ ERR_SET_VAR, WGHT_WARN, "Cannot set TCL variable '$1'" },
{ ERR_INFO_DESCR, WGHT_ERROR, "Unrecognized module info descriptor '$1'" },
{ ERR_INVWGHT_WARN, WGHT_WARN, "Invalid error weight '$1' found" },
{ ERR_INVFAC_WARN, WGHT_WARN, "Invalid log facility '$1'" },
{ ERR_COLON, WGHT_WARN, "Spurious colon in pattern '$1'" },
{ ERR_INTERAL, WGHT_PANIC, "Internal error in the alias handler" },
{ ERR_INTERRL, WGHT_PANIC, "Internal error in the error logger" },
{ ERR_INVAL, WGHT_PANIC, "Invalid error type '$1' found" },
{ ERR_INVWGHT, WGHT_PANIC, "Invalid error weight '$1' found" },
{ ERR_INVFAC, WGHT_PANIC, "Invalid log facility '$1'" },
{ ERR_ENVVAR, WGHT_FATAL, "The environment variables LOADEDMODULES and _LMFILES_ have inconsistent lengths." }
};
/** ************************************************************************ **/
/** PROTOTYPES **/
/** ************************************************************************ **/
static ErrTransTab *ErrorLookup( ErrType error_type );
static ErrMeasr *MeasLookup( ErrWeights weigth );
static int FlushError( ErrType Type,
char *module,
int lineno,
ErrWeights Weight,
char *WeightMsg,
char *ErrMsgs,
int argc,
char **argv);
static int PrintError( char *buffer,
ErrType Type,
char *module,
int lineno,
ErrWeights Weight,
char *WeightMsg,
char *ErrMsgs,
int argc,
char **argv);
static char *ErrorString( char *ErrMsgs,
int argc,
char **argv);
static void add_param( char **Control,
char **Target,
int *Length,
int argc,
char **argv);
static int scan_facility( char *s,
FacilityNames *table,
int size);
static char *GetFacility( ErrWeights Weight);
static ErrFacilities *GetFacility_sub( ErrWeights Weight);
static void Print_Tracing( char *buffer,
int result,
int argc,
char **argv);
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: Module_Tracing **
** Print_Tracing **
** Module_Verbosity **
** **
** Description: Display a tracing or verbose message **
** **
** First Edition: 1995/12/27 **
** **
** Parameters: int result Result code of th module command **
** int argc Number od arguments to the module **
** command **
** char **argv Argument array **
** char *buffer Print buffer **
** **
** Result: - **
** **
** Attached Globals: g_current_module The module which is handled **
** by the current command **
** **
** ************************************************************************ **
++++*/
void Module_Tracing( int result,
int argc,
char **argv)
{
if( !FlushError( NO_ERR, (char *) NULL, result, WGHT_TRACE, (char *) NULL,
(char *) NULL, argc, argv)) {
ErrorLogger( ERR_INTERRL, LOC, NULL);
}
} /** End of 'Module_Tracing' **/
void Module_Verbosity(int argc, char **argv)
{
if (sw_verbose && argc && *argv) {
if (!FlushError(NO_ERR_VERBOSE, g_current_module, linenum,
WGHT_VERBOSE, Measurements[MEAS_VERB_NDX].message,
*argv, argc, argv)) {
ErrorLogger(ERR_INTERRL, LOC, NULL);
}
}
} /** End of 'Module_Verbosity' **/
static void Print_Tracing(char *buffer_for_string, int result, int argc,
char **argv)
{
char *s = buffer_for_string;
struct passwd *pwent;
struct group *grpent;
uid_t uid;
gid_t gid;
/**
** Print the arguments
**/
while (argc--) {
#if 0
sprintf(s, "%s ", *argv++);
#endif /* 0 */
strcpy(s, *argv++);
strcat(s, " ");
s += strlen(s);
}
/**
** Add the real and effective user- and group-id
**/
pwent = getpwuid( uid = getuid());
sprintf( s, " [%s(%d)", (pwent ? pwent->pw_name : _unknown), uid);
s += strlen( s);
grpent = getgrgid( gid = getgid());
sprintf( s, ".%s(%d)]", (grpent ? grpent->gr_name : _unknown), gid);
s += strlen( s);
pwent = getpwuid( uid = geteuid());
sprintf( s, " [%s(%d)", (pwent ? pwent->pw_name : _unknown), uid);
s += strlen( s);
grpent = getgrgid( gid = getegid());
sprintf( s, ".%s(%d)] = ", (grpent ? grpent->gr_name : _unknown), gid);
s += strlen( s);
/**
** Add the commands result
**/
switch( result) {
case TCL_OK:
strcpy( s, "TCL_OK");
break;
case TCL_ERROR:
strcpy( s, "TCL_ERROR");
break;
case TCL_RETURN:
strcpy( s, "TCL_RETURN");
break;
case TCL_BREAK:
strcpy( s, "TCL_BREAK");
break;
case TCL_CONTINUE:
strcpy( s, "TCL_CONTINUE");
break;
default:
strcpy( s, "UNKNOWN");
break;
}
s += strlen( s);
sprintf( s, "(%d)", result);
} /** End of 'Module_Tracing' **/
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: Enable_Error, Disable_Error, Restore_Error **
** **
** Description: Enables, disables, or restores error logging **
** Sometimes an error isn't really an error **
** **
** First Edition: 1999/11/11 **
** **
** Parameters: none **
** **
** Result: none **
** **
** ************************************************************************ **
++++*/
static void save_error_state(int reset) {
static int in_effect = 0;
static int saved_state = 0;
if (reset && in_effect ) {
quiet_on_error = saved_state;
in_effect = 0;
} else if (!reset && !in_effect ) {
saved_state = quiet_on_error;
in_effect = 1;
}
}
void Enable_Error(void) {
save_error_state(0);
quiet_on_error = 0;
}
void Disable_Error(void) {
save_error_state(0);
quiet_on_error = 1;
}
void Restore_Error(void) {
quiet_on_error = 0; /* the default is to output errors */
save_error_state(1);
}
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: Module_Error **
** **
** Description: Error handling for the modules package **
** **
** First Edition: 1995/08/06 **
** **
** Parameters: ErrType error_type Type of the error **
** char *module Affected module **
** int lineo Line number **
** ... Argument list **
** **
** Result: ErrCode OK No error **
** PROBLEM Problem. Program may **
** continue running **
** ERROR Caller should try to **
** exit gracefully **
** **
** Attached Globals: **
** **
** ************************************************************************ **
++++*/
int Module_Error(ErrType error_type, char *module, int lineno, ...)
{
int listsize = ARGLIST_SIZE, /** Initial size of the argument list **/
argc = 0; /** Actual number of args **/
char **argv, /** Argument array **/
*arg; /** A single argument **/
va_list parptr; /** Varargs scan pointer **/
ErrTransTab *TransPtr; /** Error transtab entry **/
ErrMeasr *MeasPtr; /** Measurement pointer **/
ErrCode ret_code;
int NoArgs = (error_type == ERR_ALLOC);
if (quiet_on_error) {
return OK; /* do nothing - just OK */
}
/**
** Argument check:
**/
if ((NO_ERR_VERBOSE == error_type) && !sw_verbose) {
return (OK);
}
if (!module) {
module = unknown;
}
/**
** Build the argument array at first
**/
if (NULL == (argv = (char **)module_malloc((size_t)((unsigned long)listsize * sizeof(char *))))) {
module = module_name;
error_type = ERR_ALLOC;
NoArgs = 1;
}
va_start(parptr, lineno);
while (!NoArgs && (NULL != (arg = va_arg(parptr, char *)))) {
/**
** Conditionally realloc:
**/
while (argc >= listsize) {
listsize += ARGLIST_SIZE;
if (!(argv = (char **)module_realloc(argv,
(size_t)((unsigned long)listsize * sizeof(char *))))) {
module = module_name;
error_type = ERR_ALLOC;
NoArgs = 1;
break;
}
} /* end inner while-loop */
argv[argc++] = arg;
} /** end outer while-loop **/
if ((NO_ERR_VERBOSE == error_type) && !argc) {
return (OK);
}
/**
** Locate the error translation table entry according to the
** passed error type:
**/
if (NULL == (TransPtr = ErrorLookup(error_type))) {
if (argv) {
null_free((void *) &argv);
}
return (ErrorLogger(ERR_INVAL, LOC, (sprintf(buffer, "%d", error_type),
buffer), NULL));
}
/**
** Now locate the assigned error weight ...
**/
if (NULL == (MeasPtr = MeasLookup(TransPtr->error_weight))) {
if (argv) {
null_free((void *) &argv);
}
argc = 0;
/* dummy condition to use value stored to 'argc': */
if (argc == 0) {
;
}
return (ErrorLogger(ERR_INVWGHT, LOC,
(sprintf(buffer, "%d", TransPtr->error_weight),
buffer), NULL));
}
/**
** Use the return code as defined for the current user level:
**/
switch (sw_userlvl) {
case UL_NOVICE:
ret_code = MeasPtr->ret_nov;
break;
case UL_ADVANCED:
ret_code = MeasPtr->ret_adv;
break;
case UL_EXPERT:
ret_code = MeasPtr->ret_exp;
break;
default:
ret_code = OK;
break;
}
/**
** Print the error message:
**/
if ((TransPtr->error_weight <= WGHT_TRACE) || (ret_code != OK)) {
if (!FlushError(error_type, module, lineno, TransPtr->error_weight,
MeasPtr->message, TransPtr->messages, argc, argv)) {
if (argv) {
null_free((void *) &argv);
}
argc = 0;
/* dummy condition to use value stored to 'argc': */
if (argc == 0) {
;
}
return (ErrorLogger(ERR_INTERRL, LOC, NULL));
}
}
/**
** Return to the caller ... conditionally ...
**/
if (WARN == ret_code) {
ret_code = OK;
}
if (argv) {
null_free((void *)&argv);
}
argc = 0;
/* dummy condition to use value stored to 'argc': */
if (argc == 0) {
;
}
if (ret_code > ERROR) {
exit((int)ret_code);
}
return (ret_code);
} /** End of 'Module_Error' **/
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: ErrorLookup **
** **
** Description: Look up the passed error type in the translation tab.**
** **
** First Edition: 1995/08/06 **
** **
** Parameters: ErrType error_type Type of the error **
** **
** Result: ErrTransTab* NULL Not found **
** else Pointer to the acc. entry **
** **
** Attached Globals: **
** **
** ************************************************************************ **
++++*/
static ErrTransTab *ErrorLookup( ErrType error_type )
{
ErrTransTab *low, *mid, *high, *save; /** Search pointers **/
/**
** Init serach pointers
**/
low = TransTab;
high = TransTab + (sizeof( TransTab) / sizeof( TransTab[0]) -1);
mid = (ErrTransTab *) NULL;
/**
** Search loop
**/
while( low < high) {
save = mid;
mid = low + ((high - low) / 2);
if( save == mid)
low = mid = high; /** Just for safety ... **/
if( mid->error_type < error_type ) {
low = mid;
} else if( mid->error_type > error_type ) {
high = mid;
} else
return( mid); /** Yep! Got it! **/
} /** while **/
/**
** Maybe the loop has been finished before the comparison took place
** (low == high) and hit!
**/
if( mid->error_type == error_type )
return( mid); /** Yep! Got it! **/
/**
** If this point is reached, nothing has been found ...
**/
return( NULL);
} /** End of 'ErrorLookup' **/
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: MeasLookup **
** **
** Description: Look up the passed error weight in the measurement **
** table **
** **
** First Edition: 1995/08/06 **
** **
** Parameters: ErrWeights weigth Weight of the error **
** **
** Result: ErrMeasr* NULL Not found **
** else Pointer to the acc. entry **
** **
** Attached Globals: **
** **
** ************************************************************************ **
++++*/
static ErrMeasr *MeasLookup(ErrWeights weigth)
{
ErrMeasr *low, *mid, *high, *save; /** Search pointers **/
/**
** Init serach pointers
**/
low = Measurements;
high = (Measurements + ((sizeof(Measurements) / sizeof(Measurements[0])) - 1));
save = (ErrMeasr *)NULL;
mid = save; /* was just the same thing we had stored to 'save', so just
* assign the value of 'save' to it instead so that it will be
* used */
/**
** Search loop
**/
while (low < high) {
save = mid;
mid = (low + ((high - low) / 2));
if (save == mid) {
low = mid = high; /** Just to be sure ... **/
}
if (mid->error_weight < weigth) {
low = mid;
} else if (mid->error_weight > weigth) {
high = mid;
} else {
return (mid); /** Yep! Got it! **/
}
} /** end while-loop **/
/**
** Maybe the loop has been finished before the comparison took place
** (low == high) and hit!
**/
if (mid->error_weight == weigth) {
return (mid); /** Yep! Got it! **/
}
/**
** If this point is reached, nothing has been found ...
**/
return (NULL);
} /** End of 'MeasLookup' **/
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: FlushError **
** **
** Description: Print the error message. Decide which facility to **
** use and schedule the according logger routine **
** **
** First Edition: 1995/12/21 **
** **
** Parameters: ErrType Type Error type as passed **
** char *module Module name **
** int lineno Line number **
** ErrWeights Weight Error Weight **
** char *WeightMsg Printable Weight **
** char *ErrMsgs Error message **
** int argc Number of arguments **
** char **argv Argument array **
** **
** Result: int 1 Everything OK **
** 0 Error occured while printing **
** **
** ************************************************************************ **
++++*/
static int FlushError(ErrType Type, char *module, int lineno,
ErrWeights Weight, char *WeightMsg, char *ErrMsgs,
int argc, char **argv)
{
char *facilities, *buffer;
char *fac;
FILE *facfp;
char *errmsg_buffer;
int fac_alloc = 0;
/**
** get the error facilities at first. If no such facilities exist, then
** we may return on success immediatelly.
**/
if ((char *)NULL == (facilities = GetFacility(Weight))) {
goto success0;
}
/**
** PANIC and FATAL error messages ought to be on stderr at least!
**/
if ((WGHT_FATAL == Weight) || (WGHT_PANIC == Weight))
if (!strstr( facilities, _stderr)) {
if((char *) NULL == (buffer = stringer(NULL,0,
_stderr,":", facilities, NULL))) {
ErrorLogger( ERR_STRING, LOC, NULL);
goto unwind0;
}
facilities = buffer;
fac_alloc = 1;
}
/**
** Print the error message into the buffer
**/
if((char *) NULL == (errmsg_buffer = stringer(NULL, ERR_BUFSIZE, NULL))) {
ErrorLogger( ERR_ALLOC, LOC, NULL);
goto unwind1;
}
/**
** In case of verbosity, the first argument is the ErrMsgs format string
**/
if( WGHT_VERBOSE == Weight) {
ErrMsgs = *argv++;
--argc;
}
if( WGHT_TRACE == Weight)
Print_Tracing( errmsg_buffer, lineno, argc, argv);
else if( !PrintError( errmsg_buffer, Type, module, lineno, Weight,
WeightMsg, ErrMsgs, argc, argv))
goto unwind2;
/**
** Now tokenize the facilities string and schedule the error messge
** for every single facility
**/
for( fac = xstrtok( facilities, ":");
fac;
fac = xstrtok( (char *) NULL, ":") ) {
/**
** Check for filenames. Two specials are defined: stderr and stdout
** Otherwise filenames are expected to begin on '.' or '/'.
** Everthing not recognized as a filename is assumed to be a
** syslog facility
** 'null' and 'none' are known as 'no logging'
**/
if( !strcmp( fac, _null) || !strcmp( fac, _none))
continue;
else if( !strcmp( fac, _stderr))
fprintf( stderr, "%s", errmsg_buffer);
else if( !strcmp( fac, _stdout))
fprintf( stdout, "%s", errmsg_buffer);
/**
** Syslog
**/
else if( '.' != *fac && '/' != *fac) {
#if defined(HAVE_SYSLOG) && defined(WITH_LOGGING)
int syslog_fac, syslog_lvl;
/* error output to stderr too if an error or verbose */
if (Type >= NO_ERR_VERBOSE)
fprintf( stderr, "%s", errmsg_buffer);
/* now send to syslog */
if( CheckFacility( fac, &syslog_fac, &syslog_lvl)) {
openlog( "modulecmd", LOG_PID, syslog_fac);
setlogmask( LOG_UPTO( syslog_lvl));
syslog( (syslog_fac | syslog_lvl), "%s", errmsg_buffer);
closelog();
/**
** Invalid facilities ... take care not to end up in
** infinite loops
**/
} else if( Type == ERR_INVFAC ||
OK == ErrorLogger( ERR_INVFAC, LOC, fac, NULL))
continue;
#else
# ifdef SYSLOG_DIR
/* this is an intentional memory leak */