include/defs.h

   1 /*!\file
   2 \brief Declaration of the structures and functions.
   3 */
   4
   5 struct getwordstruct
   6 {
   7    const char *current;
   8    const char *beginning;
   9    int modified;
  10 };
  11
  12 typedef struct longlinestruct *longline;
  13
  14 struct generalitemstruct
  15 {
  16    //! \c True if the entry is for the total of the file or \c false if it is a single line.
  17    int total;
  18    //! The user to which the entry apply. The length is limited to ::MAX_USER_LEN.
  19    char *user;
  20    //! The number of accesses performed by the user.
  21    long long nacc;
  22    //! The number of bytes transfered.
  23    long long nbytes;
  24    //! The URL accessed by the user. The length is not limited.
  25    char *url;
  26    //! The source IP address of the user. The length is limited to ::MAX_IP_LEN.
  27    char *ip;
  28    //! The time of the access. The length is limited to ::MAX_DATETIME_LEN.
  29    char *time;
  30    //! The date of the access. The length is limited to ::MAX_DATETIME_LEN.
  31    char *date;
  32    //! The number of milliseconds spend processing the request.
  33    long long nelap;
  34    //! The number of bytes fetched from the cache of the proxy (cache hit).
  35    long long incache;
  36    //! The number of bytes fetched from the site (cache miss).
  37    long long oucache;
  38 };
  39
  40 struct userinfostruct
  41 {
  42    //! The ID of the user as found in the input file.
  43    char id[MAX_USER_LEN];
  44    //! \c True if the ID is in fact the IP address from which the user connected.
  45    bool id_is_ip;
  46    //! The name of the user to display in the report.
  47    char label[MAX_USER_LEN];
  48    //! The mangled name to use in file names of that user.
  49    char filename[MAX_USER_FNAME_LEN];
  50 };
  51
  52 // auth.c
  53 void htaccess(const struct userinfostruct *uinfo);
  54
  55 // authfail.c
  56 void authfail_report(void);
  57
  58 // charset.c
  59 void ccharset(char *CharSet);
  60
  61 // convlog.c
  62 void convlog(const char *arq, char *df, int dfrom, int duntil);
  63
  64 // css.c
  65 void css(FILE *fp_css);
  66
  67 // dansguardian_log.c
  68 void dansguardian_log(void);
  69
  70 // dansguardian_report.c
  71 void dansguardian_report(void);
  72
  73 // datafile.c
  74 void data_file(char *tmp);
  75
  76 // decomp.c
  77 void decomp(char *arq, char *zip, const char *tmp);
  78 void recomp(const char *arq, const char *zip) ;
  79
  80 // denied.c
  81 void gen_denied_report(void);
  82
  83 // download.c
  84 void download_report(void);
  85 void free_download(void);
  86 void set_download_suffix(const char *list);
  87 bool is_download_suffix(const char *url);
  88
  89 // email.c
  90 int geramail(const char *dirname, int debug, const char *outdir, const char *email, const char *TempDir);
  91
  92 // exclude.c
  93 void gethexclude(const char *hexfile, int debug);
  94 void getuexclude(const char *uexfile, int debug);
  95 int vhexclude(const char *url);
  96 int vuexclude(const char *user);
  97 bool is_indexonly(void);
  98 void free_exclude(void);
  99
 100 // getconf.c
 101 void getconf(void);
 102
 103 // grepday.c
 104 void greport_day(const struct userinfostruct *user);
 105 void greport_cleanup(void);
 106
 107 // html.c
 108 void htmlrel(void);
 109
 110 // indexonly.c
 111 void index_only(const char *dirname,int debug);
 112
 113 // ip2name.c
 114 void ip2name(char *ip,int ip_len);
 115 void name2ip(char *name);
 116
 117 // lastlog.c
 118 void mklastlog(const char *outdir);
 119
 120 // longline.c
 121 __attribute__((warn_unused_result)) /*@null@*//*@only@*/longline longline_create(void);
 122 void longline_reset(longline line);
 123 /*@null@*/char *longline_read(FILE *fp_in,/*@null@*/longline line);
 124 void longline_destroy(/*@out@*//*@only@*//*@null@*/longline *line_ptr);
 125
 126 // index.c
 127 void make_index(void);
 128
 129 // realtime.c
 130 void realtime(void);
 131
 132 // repday.c
 133 void report_day(const struct userinfostruct *user);
 134
 135 // report.c
 136 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);
 137 void gerarel(void);
 138 int ger_read(char *buffer,struct generalitemstruct *item,const char *filename);
 139
 140 // siteuser.c
 141 void siteuser(void);
 142
 143 // smartfilter.c
 144 void smartfilter_report(void);
 145
 146 // sort.c
 147 void sort_users_log(const char *tmp, int debug);
 148 void tmpsort(void);
 149
 150 // splitlog.c
 151 void splitlog(const char *arq, char *df, int dfrom, int duntil, char *convert);
 152
 153 // squidguard_log.c
 154 void squidguard_log(void);
 155
 156 // squidguard_report.c
 157 void squidguard_report(void);
 158
 159 // topsites.c
 160 void topsites(void);
 161
 162 // topuser.c
 163 void topuser(void);
 164
 165 // totday.c
 166 void day_totalize(const char *tmp, const struct userinfostruct *uinfo, int indexonly);
 167
 168 // totger.c
 169 int totalger(const char *dirname, int debug, const char *outdir);
 170
 171 // usage.c
 172 void usage(const char *prog);
 173
 174 // useragent.c
 175 void useragent(void);
 176
 177 // userinfo.c
 178 /*@shared@*/struct userinfostruct *userinfo_create(const char *userid);
 179 void userinfo_free(void);
 180 /*@shared@*/struct userinfostruct *userinfo_find_from_file(const char *filename);
 181 /*@shared@*/struct userinfostruct *userinfo_find_from_id(const char *id);
 182
 183 // usertab.c
 184 void init_usertab(const char *UserTabFile);
 185 void user_find(char *mappedname, int namelen, const char *userlogin);
 186 void close_usertab(void);
 187
 188 // util.c
 189 void getword_start(/*@out@*/struct getwordstruct *gwarea, const char *line);
 190 void getword_restart(struct getwordstruct *gwarea);
 191 __attribute__((warn_unused_result)) int getword(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
 192 __attribute__((warn_unused_result)) int getword_limit(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
 193 __attribute__((warn_unused_result)) int getword_multisep(/*@out@*/char *word, int limit, struct getwordstruct *gwarea, char stop);
 194 __attribute__((warn_unused_result)) int getword_skip(int limit, struct getwordstruct *gwarea, char stop);
 195 __attribute__((warn_unused_result)) int getword_atoll(/*@out@*/long long int *number, struct getwordstruct *gwarea, char stop);
 196 __attribute__((warn_unused_result)) int getword_ptr(char *orig_line,/*@out@*/char **word, struct getwordstruct *gwarea, char stop);
 197 long long int my_atoll (const char *nptr);
 198 int is_absolute(const char *path);
 199 int getnumlist(char *, numlist *, const int, const int);
 200 void name_month(char *month,int month_len);
 201 int conv_month(const char *month);
 202 const char *conv_month_name(int month);
 203 void buildymd(const char *dia, const char *mes, const char *ano, char *wdata);
 204 void date_from(char *date, int *dfrom, int *duntil);
 205 char *fixnum(long long int value, int n);
 206 char *fixnum2(long long int value, int n);
 207 void fixnone(char *str);
 208 char *fixtime(long int elap);
 209 void fixendofline(char *str);
 210 void show_info(FILE *fp_ou);
 211 void show_sarg(FILE *fp_ou, int depth);
 212 void write_logo_image(FILE *fp_ou);
 213 void write_html_header(FILE *fp_ou, int depth, const char *title);
 214 void close_html_header(FILE *fp_ou);
 215 __attribute__((warn_unused_result)) int write_html_trailer(FILE *fp_ou);
 216 void output_html_string(FILE *fp_ou,const char *str,int maxlen);
 217 void output_html_url(FILE *fp_ou,const char *url);
 218 void debuga(const char *msg,...) __attribute__((format(printf,1,2)));
 219 void debugaz(const char *head, const char *msg);
 220 void my_lltoa(unsigned long long int n, char *s, int ssize, int len);
 221 char *get_size(const char *path, const char *file);
 222 void url_hostname(const char *url,char *hostname,int hostsize);
 223 void url_module(const char *url, char *w2);
 224 void url_to_file(const char *url,char *file,int filesize);
 225 void strip_latin(char *line);
 226 char *buildtime(long long int elap);
 227 void obtdate(const char *dirname, const char *name, char *data);
 228 void formatdate(char *date,int date_size,int year,int month,int day,int hour,int minute,int second,int dst);
 229 void computedate(int year,int month,int day,struct tm *t);
 230 int obtuser(const char *dirname, const char *name);
 231 void obttotal(const char *dirname, const char *name, char *tbytes, int nuser, char *media);
 232 void version(void);
 233 int vercode(const char *code);
 234 void load_excludecodes(const char *ExcludeCodes);
 235 void free_excludecodes(void);
 236 void my_mkdir(const char *name);
 237 int testvaliduserchar(const char *user);
 238 char *strlow(char *string);
 239 char *strup(char *string);
 240 int month2num(const char *month);
 241 int builddia(int day, int month, int year);
 242 int vrfydir(const struct periodstruct *per1, const char *addr, const char *site, const char *us, const char *form);
 243 int getperiod_fromsarglog(const char *arqtt,struct periodstruct *period);
 244 void getperiod_fromrange(struct periodstruct *period,int dfrom,int duntil);
 245 int getperiod_buildtext(struct periodstruct *period);
 246 void removetmp(const char *outdir);
 247 void zdate(char *ftime,int ftimesize, const char *DateFormat);
 248 void baddata(void);
 249 char *get_param_value(const char *param,char *line);
 250 int compar( const void *, const void * );
 251 void unlinkdir(const char *dir,int contentonly);