/*
 * FCRON - periodic command scheduler 
 *
 *  Copyright 2000-2001 Thibault Godouet <fcron@free.fr>
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 *  The GNU General Public License can also be found in the file
 *  `LICENSE' that comes with the fcron source distribution.
 */

 /* $Id: global.h,v 1.26 2001-05-17 00:57:26 thib Exp $ */


/* 
   WARNING : this file should not be modified.
   Compilation's options are in config.h
*/

#ifndef __GLOBAL_H__
#define __GLOBAL_H__

/* config.h must be included before every other includes 
 * (contains the compilation options) */
#include "config.h"


#include <ctype.h>

#ifdef HAVE_ERRNO_H
#include <errno.h>
#endif

#ifdef HAVE_GETOPT_H
#include <getopt.h>
#endif

#include <pwd.h>
#include <signal.h>

#ifdef HAVE_STDARG_H
#include <stdarg.h>
#endif

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#ifdef HAVE_SYS_FILE_H
#include <sys/file.h>
#endif

#include <sys/stat.h>
#include <sys/types.h>

#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif

#ifdef HAVE_SYSLOG_H
#include <syslog.h>
#endif

#ifdef TIME_WITH_SYS_TIME
#include <time.h>
#elif HAVE_SYS_TIME_H
#include <sys/time.h>
#endif

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#elif HAVE_SYS_FCNTL_H
#include <sys/fcntl.h>
#endif

#ifdef HAVE_LIMITS_H
#include <limits.h>
#endif


#include "bitstring.h"     /* bit arrays */
#include "option.h"        /* manage fcrontab's options */

/* constants for fcrontabs needed to load and save the fcrontabs to disk */
#include "save.h"
/* log part */
#include "log.h"
/* functions used by both fcrontab and fcron */
#include "subs.h"

/* you should not change this (nor need to do it) */
#define ERR     -1           
#define OK       0

/* options for local functions */
#define STD 0

/* macros */
#define Alloc(ptr, type) \
        if( (ptr = calloc(1, sizeof(type))) == NULL ) \
            die_e("Could not calloc.");

#define debug if(debug_opt) Debug

typedef struct env_t {
    char         *e_val;        /* env value                            */
    struct env_t *e_next;
} env_t ;

typedef struct CF {
    struct CF    *cf_next;
    struct CL    *cf_line_base;
    char	 *cf_user;	/* user-name			        */
    struct env_t *cf_env_base;  /* list of all env variables to set     */
    int		 cf_running;	/* number of jobs running               */
} CF;


#define OPTION_SIZE 3
#define LAVG_SIZE 3
/* warning : do not change the order of the members of this structure
 *   because some tests made are dependent to that order */
/* warning : if you change a field type, you may have to also make some changes
 *   in the save/load binary fcrontab functions */
typedef struct CL {
    struct CL     *cl_next;
    struct CF     *cl_file;       /* the file in which the line is        */
    unsigned char  cl_option[OPTION_SIZE]; /* line's option (see option.h)*/
    char	  *cl_shell;      /* shell command			  */
    unsigned char  cl_numexe;     /* num of entries in lavg/serial queue  */
    unsigned char  cl_lavg[LAVG_SIZE];/*load averages needed (1,5,15 mins)*/
    time_t         cl_until;      /* timeout of the wait for a lavg value */
    char           cl_nice;       /* nice value to control priority       */
    char          *cl_runas;      /* determine permissions of the job     */
    char          *cl_mailto;     /* mail output to cl_mailto             */
    time_t         cl_nextexe;    /* time and date of the next execution  */
    unsigned short cl_remain;     /* remaining until next execution       */
    time_t         cl_timefreq;   /* Run every n seconds                  */
    unsigned short cl_runfreq;    /* Run once every n matches             */
    /* see bitstring(3) man page for more details */
    bitstr_t	   bit_decl(cl_mins, 60); /* 0-59		          */
    bitstr_t	   bit_decl(cl_hrs, 24);  /* 0-23			  */
    bitstr_t	   bit_decl(cl_days, 32); /* 1-31			  */
    bitstr_t	   bit_decl(cl_mons, 12); /* 0-11                	  */
    bitstr_t	   bit_decl(cl_dow, 8);	  /* 0-7, 0 and 7 are both Sunday */
} CL;

typedef struct job {
    struct CL    *j_line;
    struct job   *j_next;
} job;

typedef struct lavg {
    struct CL  *l_line;  
    time_t      l_until;   /* the timeout of the wait for load averages */
} lavg;

typedef struct exe {
    struct CL  *e_line;
    pid_t       e_pid;
} exe;

#endif /* __GLOBAL_H__ */