]>
git.ipfire.org Git - thirdparty/sarg.git/blob - include/defs.h
2 \brief Declaration of the structures and functions.
12 typedef struct longlinestruct
*longline
;
14 struct generalitemstruct
16 //! \c True if the entry is for the total of the file or \c false if it is a single line.
18 //! The user to which the entry apply. The length is limited to ::MAX_USER_LEN.
20 //! The number of accesses performed by the user.
22 //! The number of bytes transfered.
24 //! The URL accessed by the user. The length is not limited.
26 //! The source IP address of the user. The length is limited to ::MAX_IP_LEN.
28 //! The time of the access. The length is limited to ::MAX_DATETIME_LEN.
30 //! The date of the access. The length is limited to ::MAX_DATETIME_LEN.
32 //! The number of milliseconds spend processing the request.
34 //! The number of bytes fetched from the cache of the proxy (cache hit).
36 //! The number of bytes fetched from the site (cache miss).
40 /*! \brief What is known about a user.
44 //! The ID of the user as found in the input file.
45 char id
[MAX_USER_LEN
];
46 //! \c True if the ID is in fact the IP address from which the user connected.
48 //! \c True if the user doesn't have a report file.
50 //! The name of the user to display in the report.
51 char label
[MAX_USER_LEN
];
52 //! The mangled name to use in file names of that user.
53 char filename
[MAX_USER_FNAME_LEN
];
54 //! \c True if this user is in the topuser list.
56 //! A general purpose flag that can be set when scanning the user's list.
58 #ifdef ENABLE_DOUBLE_CHECK_DATA
59 //! Total number of bytes.
61 //! Total time spent processing the requests.
66 //! Scan through the known users.
67 typedef struct userscanstruct
*userscan
;
69 /*! \brief Global statistics
71 struct globalstatstruct
73 //! Total number of accesses.
75 //! Total number of bytes.
77 //! Total time spent processing the requests.
79 //! Amount of data fetched from the cache.
80 long long int incache
;
81 //! Amount of data not fetched from the cache.
82 long long int oucache
;
83 //! The number of users in the topuser list.
87 //! The object to store the daily statistics.
88 typedef struct DayStruct
*DayObject
;
91 void htaccess(const struct userinfostruct
*uinfo
);
94 void authfail_report(void);
97 void ccharset(char *CharSet
);
100 void convlog(const char *arq
, char *df
, int dfrom
, int duntil
);
103 void css_content(FILE *fp_css
);
104 void css(FILE *fp_css
);
106 // dansguardian_log.c
107 void dansguardian_log(void);
109 // dansguardian_report.c
110 void dansguardian_report(void);
113 void data_file(char *tmp
);
116 FILE *decomp(const char *arq
, bool *pipe
);
119 void gen_denied_report(void);
122 void download_report(void);
123 void free_download(void);
124 void set_download_suffix(const char *list
);
125 bool is_download_suffix(const char *url
);
128 int geramail(const char *dirname
, int debug
, const char *outdir
, const char *email
, const char *TempDir
);
131 void gethexclude(const char *hexfile
, int debug
);
132 void getuexclude(const char *uexfile
, int debug
);
133 int vhexclude(const char *url
);
134 int vuexclude(const char *user
);
135 bool is_indexonly(void);
136 void free_exclude(void);
142 void greport_prepare(void);
143 void greport_day(const struct userinfostruct
*user
);
144 void greport_cleanup(void);
150 void index_only(const char *dirname
,int debug
);
153 int ip2name_config(const char *param
);
154 void ip2name_forcedns(void);
155 void ip2name(char *ip
,int ip_len
);
156 void ip2name_cleanup(void);
157 void name2ip(char *name
,int name_size
);
160 void mklastlog(const char *outdir
);
163 __attribute__((warn_unused_result
)) /*@null@*//*@only@*/longline
longline_create(void);
164 void longline_reset(longline line
);
165 /*@null@*/char *longline_read(FILE *fp_in
,/*@null@*/longline line
);
166 void longline_destroy(/*@out@*//*@only@*//*@null@*/longline
*line_ptr
);
169 void make_index(void);
175 void redirector_log(void);
176 void redirector_report(void);
179 void report_day(const struct userinfostruct
*user
);
183 int ger_read(char *buffer
,struct generalitemstruct
*item
,const char *filename
);
184 void totalger(FILE *fp_gen
,const char *filename
);
190 void smartfilter_report(void);
193 void sort_users_log(const char *tmp
, int debug
,struct userinfostruct
*uinfo
);
194 void tmpsort(const struct userinfostruct
*uinfo
);
195 void sort_labels(const char **label
,const char **order
);
198 void splitlog(const char *arq
, const char *df
, int dfrom
, int duntil
, int convert
, const char *splitprefix
);
207 DayObject
day_prepare(void);
208 void day_cleanup(DayObject ddata
);
209 void day_newuser(DayObject ddata
);
210 void day_addpoint(DayObject ddata
,const char *date
, const char *time
, long long int elap
, long long int bytes
);
211 void day_totalize(DayObject ddata
,const char *tmp
, const struct userinfostruct
*uinfo
);
214 void read_hostalias(const char *Filename
);
215 void free_hostalias(void);
216 const char *skip_scheme(const char *url
);
217 const char *process_url(char *url
,bool full_url
);
218 void url_hostname(const char *url
,char *hostname
,int hostsize
);
221 void usage(const char *prog
);
224 void useragent(void);
227 /*@shared@*/struct userinfostruct
*userinfo_create(const char *userid
);
228 void userinfo_free(void);
229 /*@shared@*/struct userinfostruct
*userinfo_find_from_file(const char *filename
);
230 /*@shared@*/struct userinfostruct
*userinfo_find_from_id(const char *id
);
231 userscan
userinfo_startscan(void);
232 void userinfo_stopscan(userscan uscan
);
233 struct userinfostruct
*userinfo_advancescan(userscan uscan
);
234 void userinfo_clearflag(void);
237 void init_usertab(const char *UserTabFile
);
238 void user_find(char *mappedname
, int namelen
, const char *userlogin
);
239 void close_usertab(void);
242 void getword_start(/*@out@*/struct getwordstruct
*gwarea
, const char *line
);
243 void getword_restart(struct getwordstruct
*gwarea
);
244 __attribute__((warn_unused_result
)) int getword(/*@out@*/char *word
, int limit
, struct getwordstruct
*gwarea
, char stop
);
245 __attribute__((warn_unused_result
)) int getword_limit(/*@out@*/char *word
, int limit
, struct getwordstruct
*gwarea
, char stop
);
246 __attribute__((warn_unused_result
)) int getword_multisep(/*@out@*/char *word
, int limit
, struct getwordstruct
*gwarea
, char stop
);
247 __attribute__((warn_unused_result
)) int getword_skip(int limit
, struct getwordstruct
*gwarea
, char stop
);
248 __attribute__((warn_unused_result
)) int getword_atoll(/*@out@*/long long int *number
, struct getwordstruct
*gwarea
, char stop
);
249 __attribute__((warn_unused_result
)) int getword_atoi(/*@out@*/int *number
, struct getwordstruct
*gwarea
, char stop
);
250 __attribute__((warn_unused_result
)) int getword_ptr(char *orig_line
,/*@out@*/char **word
, struct getwordstruct
*gwarea
, char stop
);
251 long long int my_atoll (const char *nptr
);
252 int is_absolute(const char *path
);
253 int getnumlist(char *, numlist
*, const int, const int);
254 void name_month(char *month
,int month_len
);
255 int conv_month(const char *month
);
256 const char *conv_month_name(int month
);
257 void buildymd(const char *dia
, const char *mes
, const char *ano
, char *wdata
);
258 void date_from(char *date
, int *dfrom
, int *duntil
);
259 char *fixnum(long long int value
, int n
);
260 char *fixnum2(long long int value
, int n
);
261 void fixnone(char *str
);
262 char *fixtime(long long int elap
);
263 void fixendofline(char *str
);
264 void show_info(FILE *fp_ou
);
265 void show_sarg(FILE *fp_ou
, int depth
);
266 void write_logo_image(FILE *fp_ou
);
267 void write_html_head(FILE *fp_ou
, int depth
, const char *page_title
,int javascript
);
268 void write_html_header(FILE *fp_ou
, int depth
, const char *title
,int javascript
);
269 void close_html_header(FILE *fp_ou
);
270 __attribute__((warn_unused_result
)) int write_html_trailer(FILE *fp_ou
);
271 void output_html_string(FILE *fp_ou
,const char *str
,int maxlen
);
272 void output_html_url(FILE *fp_ou
,const char *url
);
273 void output_html_link(FILE *fp_ou
,const char *url
,int maxlen
);
274 void debuga(const char *msg
,...) __attribute__((format(printf
,1,2)));
275 void debugaz(const char *msg
,...) __attribute__((format(printf
,1,2)));
276 void my_lltoa(unsigned long long int n
, char *s
, int ssize
, int len
);
277 char *get_size(const char *path
, const char *file
);
278 void url_module(const char *url
, char *w2
);
279 void url_to_file(const char *url
,char *file
,int filesize
);
280 void safe_strcpy(char *dest
,const char *src
,int length
);
281 void strip_latin(char *line
);
282 char *buildtime(long long int elap
);
283 int obtdate(const char *dirname
, const char *name
, char *data
);
284 void formatdate(char *date
,int date_size
,int year
,int month
,int day
,int hour
,int minute
,int second
,int dst
);
285 void computedate(int year
,int month
,int day
,struct tm
*t
);
286 int obtuser(const char *dirname
, const char *name
);
287 void obttotal(const char *dirname
, const char *name
, int nuser
, long long int *tbytes
, long long int *media
);
289 int vercode(const char *code
);
290 void load_excludecodes(const char *ExcludeCodes
);
291 void free_excludecodes(void);
292 void my_mkdir(const char *name
);
293 int testvaliduserchar(const char *user
);
294 char *strlow(char *string
);
295 char *strup(char *string
);
296 int month2num(const char *month
);
297 int builddia(int day
, int month
, int year
);
298 int vrfydir(const struct periodstruct
*per1
, const char *addr
, const char *site
, const char *us
, const char *form
);
299 int getperiod_fromsarglog(const char *arqtt
,struct periodstruct
*period
);
300 void getperiod_fromrange(struct periodstruct
*period
,int dfrom
,int duntil
);
301 int getperiod_buildtext(struct periodstruct
*period
);
302 void removetmp(const char *outdir
);
303 void zdate(char *ftime
,int ftimesize
, const char *DateFormat
);
304 char *get_param_value(const char *param
,char *line
);
305 int compar( const void *, const void * );
306 void unlinkdir(const char *dir
,int contentonly
);
307 int extract_address_mask(const char *buf
,const char **text
,unsigned char *ipv4
,unsigned short int *ipv6
,int *nbits
,const char **next
);