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