src/exim_monitor/em_hdr.h

   1 /*************************************************
   2 *                 Exim Monitor                   *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2009 */
   6 /* Copyright (c) The Exim Maintainers 2021 - 2022 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9
  10 /* This is the general header file for all the modules that comprise
  11 the exim monitor program. */
  12
  13 /* If this macro is defined, Eximon will anonymize all email addresses. This
  14 feature is just so that screen shots can be obtained for documentation
  15 purposes! */
  16
  17 /* #define ANONYMIZE */
  18
  19 /* System compilation parameters */
  20
  21 #define queue_index_size  10      /* Size of index into queue */
  22
  23 /* Assume most systems have statfs() unless os.h undefines this macro */
  24
  25 #define HAVE_STATFS
  26
  27 /* Bring in the system-dependent stuff */
  28
  29 #include "os.h"
  30
  31
  32 /* ANSI C includes */
  33
  34 #include <ctype.h>
  35 #include <setjmp.h>
  36 #include <signal.h>
  37 #include <stdarg.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <time.h>
  42
  43 /* Not-fully-ANSI systems (e.g. SunOS4 are missing some things) */
  44
  45 #ifndef SEEK_SET
  46 #define SEEK_SET 0
  47 #define SEEK_CUR 1
  48 #define SEEK_END 2
  49 #endif
  50
  51 /* Unix includes */
  52
  53 #include <sys/types.h>
  54 #include <errno.h>
  55 #include <dirent.h>
  56 #include <fcntl.h>
  57 #include <pwd.h>
  58 #include <grp.h>
  59 #include <sys/param.h>
  60 #include <sys/stat.h>
  61 #include <unistd.h>
  62
  63 /* The new standard is statvfs; some OS have statfs. Also arrange
  64 to be able to cut it out altogether for way-out OS that don't have
  65 anything. */
  66
  67 #ifdef HAVE_STATFS
  68 #ifdef HAVE_SYS_STATVFS_H
  69 #include <sys/statvfs.h>
  70
  71 #else
  72   #define statvfs statfs
  73   #ifdef HAVE_SYS_VFS_H
  74     #include <sys/vfs.h>
  75     #ifdef HAVE_SYS_STATFS_H
  76     #include <sys/statfs.h>
  77     #endif
  78   #endif
  79   #ifdef HAVE_SYS_MOUNT_H
  80   #include <sys/mount.h>
  81   #endif
  82 #endif
  83 #endif
  84
  85 #include <sys/wait.h>
  86
  87 /* Regular expression include */
  88
  89 #define PCRE2_CODE_UNIT_WIDTH 8
  90 #include <pcre2.h>
  91
  92 /* Includes from the main source of Exim.  One of these days I should tidy up
  93 this interface so that this kind of kludge isn't needed. */
  94
  95 #ifndef NS_MAXMSG
  96 # define NS_MAXMSG 65535
  97 #endif
  98 typedef void * hctx;
  99
 100 #include "local_scan.h"
 101 #include "macros.h"
 102 #include "structs.h"
 103 #include "blob.h"
 104 #include "globals.h"
 105 #include "hintsdb.h"
 106 #include "hintsdb_structs.h"
 107 #include "functions.h"
 108 #include "osfunctions.h"
 109
 110 /* The sys/resource.h header on SunOS 4 causes trouble with the gcc
 111 compiler. Just stuff the bit we want in here; pragmatic easy way out. */
 112
 113 #ifdef NO_SYS_RESOURCE_H
 114 #define RLIMIT_NOFILE   6               /* maximum descriptor index + 1 */
 115 struct rlimit {
 116         int     rlim_cur;               /* current (soft) limit */
 117         int     rlim_max;               /* maximum value for rlim_cur */
 118 };
 119 #else
 120 #include <sys/time.h>
 121 #include <sys/resource.h>
 122 #endif
 123
 124 /* X11 includes */
 125
 126 #include <X11/Xlib.h>
 127 #include <X11/Intrinsic.h>
 128 #include <X11/StringDefs.h>
 129 #include <X11/cursorfont.h>
 130 #include <X11/keysym.h>
 131 #include <X11/Shell.h>
 132 #include <X11/Xaw/AsciiText.h>
 133 #include <X11/Xaw/Command.h>
 134 #include <X11/Xaw/Form.h>
 135 #include <X11/Xaw/Dialog.h>
 136 #include <X11/Xaw/Label.h>
 137 #include <X11/Xaw/SimpleMenu.h>
 138 #include <X11/Xaw/SmeBSB.h>
 139 #include <X11/Xaw/SmeLine.h>
 140 #include <X11/Xaw/TextSrc.h>
 141 #include <X11/Xaw/TextSink.h>
 142
 143 /* These are required because exim monitor has its own munged
 144 version of the stripchart widget. */
 145
 146 #include <X11/IntrinsicP.h>
 147 #include <X11/StringDefs.h>
 148 #include <X11/Xaw/XawInit.h>
 149 #include <X11/Xaw/StripCharP.h>
 150
 151 extern WidgetClass mystripChartWidgetClass;
 152
 153
 154
 155 /*************************************************
 156 *               Enumerations                     *
 157 *************************************************/
 158
 159 /* Operations on the in-store message queue */
 160
 161 enum { queue_noop, queue_add };
 162
 163 /* Operations on the destinations queue */
 164
 165 enum { dest_noop, dest_add, dest_remove };
 166
 167
 168 /*************************************************
 169 *          Structure for destinations            *
 170 *************************************************/
 171
 172 typedef struct dest_item {
 173   struct dest_item *next;
 174   struct dest_item *parent;
 175   uschar address[1];
 176 } dest_item;
 177
 178
 179
 180 /*************************************************
 181 *           Structure for queue items            *
 182 *************************************************/
 183
 184 typedef struct queue_item {
 185   struct queue_item *next;
 186   struct queue_item *prev;
 187   struct dest_item  *destinations;
 188   int  input_time;
 189   int  update_time;
 190   int  size;
 191   uschar *sender;
 192   uschar name[17];
 193   uschar seen;
 194   uschar frozen;
 195   uschar dir_char;
 196 } queue_item;
 197
 198
 199 /*************************************************
 200 *          Structure for queue skip items        *
 201 *************************************************/
 202
 203 typedef struct skip_item {
 204   struct skip_item *next;
 205   time_t reveal;
 206   uschar text[1];
 207 } skip_item;
 208
 209
 210 /*************************************************
 211 *           Structure for delivery displays      *
 212 *************************************************/
 213
 214 typedef struct pipe_item {
 215   struct pipe_item *next;
 216   int fd;
 217   Widget widget;
 218 } pipe_item;
 219
 220
 221
 222 /*************************************************
 223 *                Global variables                *
 224 *************************************************/
 225
 226 extern Display *X_display;         /* Current display */
 227 extern XtAppContext X_appcon;      /* Application context */
 228 extern XtActionsRec actionTable[]; /* Actions table */
 229
 230 extern XtTranslations queue_trans; /* translation table for queue text widget */
 231 extern XtTranslations text_trans;  /* translation table for other text widgets */
 232
 233 extern Widget  dialog_ref_widget;   /* for positioning dialog box */
 234 extern Widget  toplevel_widget;
 235 extern Widget  log_widget;          /* widget for tail display */
 236 extern Widget  queue_widget;        /* widget for queue display */
 237 extern Widget  unhide_widget;       /* widget for unhide button */
 238
 239 extern FILE   *LOG;
 240
 241 extern int     action_output;       /* TRUE when wanting action command output */
 242 extern int     action_queue_update; /* controls auto updates */
 243 extern int     actionTableSize;     /* # entries in actionTable */
 244 extern uschar  actioned_message[];  /* For menu handling */
 245 extern uschar *action_required;
 246 extern uschar *alternate_config;    /* Alternate Exim configuration file */
 247
 248 extern int     body_max;            /* Max size of body to display */
 249
 250 extern int     eximon_initialized;  /* TRUE when initialized */
 251
 252 extern int     log_buffer_size;     /* size of log buffer */
 253 extern BOOL    log_datestamping;    /* TRUE if logs are datestamped */
 254 extern int     log_depth;           /* depth of log tail window */
 255 extern uschar *log_display_buffer;  /* to hold display text */
 256 extern uschar *log_file;            /* supplied name of exim log file */
 257 extern uschar  log_file_open[256];  /* actual open file */
 258 extern uschar *log_font;            /* font for log display */
 259 extern ino_t   log_inode;           /* the inode of the log file */
 260 extern long int log_position;      /* position in log file */
 261 extern int     log_width;           /* width of log tail window */
 262
 263 extern uschar *menu_event;          /* name of menu event */
 264 extern int     menu_is_up;          /* TRUE when menu displayed */
 265 extern int     min_height;          /* min window height */
 266 extern int     min_width;           /* min window width */
 267
 268 extern pipe_item *pipe_chain;      /* for delivery displays */
 269
 270 extern uschar *qualify_domain;
 271 extern int     queue_depth;         /* depth of queue window */
 272 extern uschar *queue_font;          /* font for queue display */
 273 extern int     queue_max_addresses; /* limit on per-message list */
 274 extern skip_item *queue_skip;      /* for hiding bits of queue */
 275 extern uschar *queue_stripchart_name; /* sic */
 276 extern int     queue_update;        /* update interval */
 277 extern int     queue_width;         /* width of queue window */
 278
 279 extern pcre2_code   *yyyymmdd_regex;    /* for matching yyyy-mm-dd */
 280
 281 extern uschar *size_stripchart;     /* path for size monitoring */
 282 extern uschar *size_stripchart_name; /* name for size stripchart */
 283 extern uschar *spool_directory;     /* Name of exim spool directory */
 284 extern int     spool_is_split;      /* True if detected split spool */
 285 extern int     start_small;         /* True to start with small window */
 286 extern int     stripchart_height;   /* height of stripcharts */
 287 extern int     stripchart_number;   /* number of stripcharts */
 288 extern pcre2_code  **stripchart_regex;  /* vector of regexps */
 289 extern uschar **stripchart_title;    /* vector of titles */
 290 extern int    *stripchart_total;    /* vector of accumulating values */
 291 extern int     stripchart_update;   /* update interval */
 292 extern int     stripchart_width;    /* width of stripcharts */
 293 extern int     stripchart_varstart; /* starting number for variable charts */
 294
 295 extern int     text_depth;          /* depth of text windows */
 296 extern int     tick_queue_accumulator; /* For timing next auto update */
 297
 298 extern uschar *window_title;        /* title of the exim monitor window */
 299
 300
 301 /*************************************************
 302 *                Global functions                *
 303 *************************************************/
 304
 305 extern XtActionProc dialogAction(Widget, XEvent *, String *, Cardinal *);
 306
 307 extern uschar *copystring(uschar *);
 308 extern void    create_dialog(uschar *, uschar *);
 309 extern void    create_stripchart(Widget, uschar *);
 310 extern void    debug(char *, ...);
 311 extern dest_item *find_dest(queue_item *, uschar *, int, BOOL);
 312 extern queue_item *find_queue(uschar *, int, int);
 313 extern void    init(int, uschar **);
 314 extern void    menu_create(Widget, XEvent *, String *, Cardinal *);
 315 extern void    NonMessageDialogue(uschar *);
 316 extern void    queue_display(void);
 317 extern void    read_log(void);
 318 extern int     read_spool(uschar *);
 319 extern int     read_spool_init(uschar *);
 320 extern void    read_spool_tidy(void);
 321 extern int     repaint_window(StripChartWidget, int, int);
 322 extern void    scan_spool_input(int);
 323 extern void    stripchart_init(void);
 324 extern void    text_empty(Widget);
 325 extern void    text_show(Widget, uschar *);
 326 extern void    text_showf(Widget, char *, ...);
 327 extern void    xs_SetValues(Widget, Cardinal, ...);
 328
 329 /* End of em_hdr.h */