Be sure no return codes from getword and friends are ignored (thanks to Markus Elfring)

[thirdparty/sarg.git] / include / defs.h

/*!\file
\brief Declaration of the structures and functions.
*/

struct getwordstruct
{
   const char *current;
   const char *beginning;
   int modified;
};

struct longlinestruct
{
   //! The buffer to store the data read from the log file.
   char *buffer;
   //! The size of the buffer.
   size_t size;
   //! The number of bytes stored in the buffer.
   size_t length;
   //! The position of the beginning of the current string.
   size_t start;
   //! The position of the end of the current string.
   size_t end;
};

struct generalitemstruct
{
   //! \c True if the entry is for the total of the file or \c false if it is a single line.
   int total;
   //! The user to which the entry apply. The length is limited to ::MAX_USER_LEN.
   char *user;
   //! The number of accesses performed by the user.
   long long nacc;
   //! The number of bytes transfered.
   long long nbytes;
   //! The URL accessed by the user. The length is not limited.
   char *url;
   //! The source IP address of the user. The length is limited to ::MAX_IP_LEN.
   char *ip;
   //! The time of the access. The length is limited to ::MAX_DATETIME_LEN.
   char *time;
   //! The date of the access. The length is limited to ::MAX_DATETIME_LEN.
   char *date;
   //! The number of milliseconds spend processing the request.
   long long nelap;
   //! The number of bytes fetched from the cache of the proxy (cache hit).
   long long incache;
   //! The number of bytes fetched from the site (cache miss).
   long long oucache;
};

struct userinfostruct
{
   //! The ID of the user as found in the input file.
   char id[MAX_USER_LEN];
   //! \c True if the ID is in fact the IP address from which the user connected.
   int id_is_ip;
   //! The name of the user to display in the report.
   char label[MAX_USER_LEN];
   //! The mangled name to use in file names of that user.
   char filename[MAX_USER_FNAME_LEN];
};

// auth.c
void htaccess(const struct userinfostruct *uinfo);

// authfail.c
void authfail_report(void);

// charset.c
void ccharset(char *CharSet);

// convlog.c
void convlog(const char *arq, char *df, int dfrom, int duntil);

// css.c
void css(FILE *fp_css);

// dansguardian_log.c
void dansguardian_log(void);

// dansguardian_report.c
void dansguardian_report(void);

// datafile.c
void data_file(char *tmp);

// decomp.c
void decomp(char *arq, char *zip, const char *tmp);
void recomp(const char *arq, const char *zip) ;

// denied.c
void gen_denied_report(void);

// download.c
void download_report(void);
void free_download(void);
void set_download_suffix(const char *list);
int is_download_suffix(const char *url);

// email.c
int geramail(const char *dirname, int debug, const char *outdir, int userip, const char *email, const char *TempDir);

// exclude.c
void gethexclude(const char *hexfile, int debug);
void getuexclude(const char *uexfile, int debug);
int vhexclude(const char *url);
int vuexclude(const char *user);
int is_indexonly(void);
void free_exclude(void);

// getconf.c
void getconf(void);

// grepday.c
void greport_day(const struct userinfostruct *user);
void greport_cleanup(void);

// html.c
void htmlrel(void);

// indexonly.c
void index_only(const char *dirname,int debug);

// ip2name.c
void ip2name(char *ip,int ip_len);
void name2ip(char *name);

// lastlog.c
void mklastlog(const char *outdir);

// index.c
void make_index(void);

// realtime.c
void realtime(void);

// repday.c
void report_day(const struct userinfostruct *user);

// report.c
void gravatmp(const struct userinfostruct *uinfo, const char *oldurl, long long int nacc, long long int nbytes, const char *oldmsg, long long int nelap, int indexonly, long long int incache, long long int oucache);
void gerarel(void);
int ger_read(char *buffer,struct generalitemstruct *item,const char *filename);

// siteuser.c
void siteuser(void);

// smartfilter.c
void smartfilter_report(void);

// sort.c
void sort_users_log(const char *tmp, int debug);
void tmpsort(void);

// splitlog.c
void splitlog(const char *arq, char *df, int dfrom, int duntil, char *convert);

// squidguard_log.c
void squidguard_log(void);

// squidguard_report.c
void squidguard_report(void);

// topsites.c
void topsites(void);

// topuser.c
void topuser(void);

// totday.c
void day_totalize(const char *tmp, const struct userinfostruct *uinfo, int indexonly);

// totger.c
int totalger(const char *dirname, int debug, const char *outdir);

// usage.c
void usage(const char *prog);

// useragent.c
void useragent(void);

// userinfo.c
struct userinfostruct *userinfo_create(const char *userid);
void userinfo_free(void);
struct userinfostruct *userinfo_find_from_file(const char *filename);
struct userinfostruct *userinfo_find_from_id(const char *id);

// usertab.c
void init_usertab(const char *UserTabFile);
void user_find(char *mappedname, int namelen, const char *userlogin);
void close_usertab(void);

// util.c
void getword_start(/*@out@*/struct getwordstruct *gwarea, const char *line);
void getword_restart(struct getwordstruct *gwarea);
__attribute__((warn_unused_result)) int getword(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
__attribute__((warn_unused_result)) int getword_limit(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
__attribute__((warn_unused_result)) int getword_multisep(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
__attribute__((warn_unused_result)) int getword_skip(int limit, struct getwordstruct *gwarea, char stop);
__attribute__((warn_unused_result)) int getword_atoll(/*@out@*/long long int *number, struct getwordstruct *gwarea, char stop);
__attribute__((warn_unused_result)) int getword_ptr(char *orig_line,/*@out@*/char **word, struct getwordstruct *gwarea, char stop);
long long int my_atoll (const char *nptr);
int is_absolute(const char *path);
int getnumlist(char *, numlist *, const int, const int);
void name_month(char *month,int month_len);
void conv_month_name(char *month);
void buildymd(const char *dia, const char *mes, const char *ano, char *wdata);
void date_from(char *date, char *dfrom, char *duntil);
char *fixnum(long long int value, int n);
char *fixnum2(long long int value, int n);
void fixnone(char *str);
void fixper(char *tbuf, char *period, const char *duntil);
char *fixtime(long int elap);
void fixendofline(char *str);
void show_info(FILE *fp_ou);
void show_sarg(FILE *fp_ou, int depth);
void write_logo_image(FILE *fp_ou);
void write_html_header(FILE *fp_ou, int depth, const char *title);
void close_html_header(FILE *fp_ou);
void write_html_trailer(FILE *fp_ou);
void output_html_string(FILE *fp_ou,const char *str,int maxlen);
void output_html_url(FILE *fp_ou,const char *url);
void conv_month(char *month);
void debuga(const char *msg,...);
void debugaz(const char *head, const char *msg);
void my_lltoa(unsigned long long int n, char *s, int ssize, int len);
char *get_size(const char *path, const char *file);
void url_hostname(const char *url,char *hostname,int hostsize);
void url_module(const char *url, char *w2);
void url_to_file(const char *url,char *file,int filesize);
void strip_latin(char *line);
char *buildtime(long long int elap);
void obtdate(const char *dirname, const char *name, char *data);
void formatdate(char *date,int date_size,int year,int month,int day,int hour,int minute,int second,int dst);
time_t computedate(const char *year,const char *month,const char *day);
int obtuser(const char *dirname, const char *name);
void obttotal(const char *dirname, const char *name, char *tbytes, int nuser, char *media);
void version(void);
int vercode(const char *code);
void load_excludecodes(const char *ExcludeCodes);
void free_excludecodes(void);
void my_mkdir(const char *name);
int testvaliduserchar(const char *user);
char *strlow(char *string);
char *strup(char *string);
void builddia(char *dia, const char *mes, const char *ano, const char *df, char *wdata);
void vrfydir(const char *per1, const char *addr, const char *site, const char *us, const char *form);
void gperiod(const char *dirname, const char *period);
void removetmp(const char *outdir);
void zdate(char *ftime,int ftimesize, const char *DateFormat);
void baddata(void);
char *get_param_value(const char *param,char *line);
int compar( const void *, const void * );
void unlinkdir(const char *dir,int contentonly);
int longline_prepare(/*@out@*/struct longlinestruct *line);
char *longline_read(FILE *fp_in,struct longlinestruct *line);
void longline_free(struct longlinestruct *line);