[thirdparty/sarg.git] / documentation / exclude.txt

/*! \file exclude.c
\brief Handle exclusion of sites and users from the report.
*/


/*!\fn static void store_exclude_ip4(unsigned short int *addr,int mask)
Store an IPv4 address to exclude from the report. A mask may be provided
to exclude a subnet.

\param addr The numbers of the IP address.
\param mask The number of bits to mask when matching the IP address.
*/


/*! \fn static void store_exclude_url(char *url,int length)
Store an URL to exclude from the report.

If the URL contains a wildcard (*), only the part of the URL after
the first dot encountered after the wildcard is stored. It serves
to exclude a subdomain.

\param url The URL to exclude.
\param length The length of the URL in bytes.
*/


/*!\fn static void gethexclude(const char *hexfile, int debug)
Get the list of the hosts to exclude from the report.

You must call free_exclude() to free the memory allocated by this function.

\param hexfile The name of the file to read. There is one host per line. Any line
containing a # anywhere in the line is a comment.
\param debug Set to \c true to print debug informations.
*/


/*! \fn static void getuexclude(const char *uexfile, int debug)
Get the list of the users to exclude from the report.

You must call free_exclude() to free the memory allocated by this function.

\param uexfile The name of the file to read. There is one user per line. Any line
containing a # anywhere in the line is a comment.
\param debug Set to \c true to print debug informations.
*/


/*! \fn int vhexclude(const char *url)
Tell if the site accessed by the user is excluded from the report.

\param url The URL to check.

\retval 1 The site is not excluded.
\retval 0 The site is excluded.
*/


/*! \fn int vuexclude(const char *user)
Tell if the user is excluded from the report.

\param user The user to check.

\retval 1 The user is not excluded.
\retval 0 The user is excluded.
*/


/*! \fn bool is_indexonly(void)
Tell if the exclusion list of the users mention the word "indexonly" meaning that
the user only want to produce the index.html.

\return \c True if only the index is requested or \c false if normal processing is requested.
*/


/*! \fn void free_exclude(void)
Free the memory allocated by gethexclude() and getuexclude().
*/
Commit	Line	Data
2357ef77 FM	1	/*! \file exclude.c
	2	\brief Handle exclusion of sites and users from the report.
	3	*/
	4
	5
	6
	7
43f18f45 FM	8	/!\fn static void store_exclude_ip4(unsigned short int addr,int mask)
	9	Store an IPv4 address to exclude from the report. A mask may be provided
	10	to exclude a subnet.
2357ef77	11
43f18f45 FM	12	\param addr The numbers of the IP address.
	13	\param mask The number of bits to mask when matching the IP address.
	14	*/
	15
	16
	17
	18
	19	/! \fn static void store_exclude_url(char url,int length)
	20	Store an URL to exclude from the report.
	21
	22	If the URL contains a wildcard (*), only the part of the URL after
	23	the first dot encountered after the wildcard is stored. It serves
	24	to exclude a subdomain.
	25
	26	\param url The URL to exclude.
	27	\param length The length of the URL in bytes.
	28	*/
	29
	30
	31
	32
	33
	34	/!\fn static void gethexclude(const char hexfile, int debug)
	35	Get the list of the hosts to exclude from the report.
	36
	37	You must call free_exclude() to free the memory allocated by this function.
	38
	39	\param hexfile The name of the file to read. There is one host per line. Any line
	40	containing a # anywhere in the line is a comment.
	41	\param debug Set to \c true to print debug informations.
	42	*/
	43
	44
	45
	46
	47
	48	/! \fn static void getuexclude(const char uexfile, int debug)
	49	Get the list of the users to exclude from the report.
	50
	51	You must call free_exclude() to free the memory allocated by this function.
	52
	53	\param uexfile The name of the file to read. There is one user per line. Any line
	54	containing a # anywhere in the line is a comment.
	55	\param debug Set to \c true to print debug informations.
	56	*/
	57
	58
	59
	60
	61
	62	/! \fn int vhexclude(const char url)
2357ef77 FM	63	Tell if the site accessed by the user is excluded from the report.
2357ef77 FM	64
2357ef77 FM	65	\param url The URL to check.
	66
	67	\retval 1 The site is not excluded.
	68	\retval 0 The site is excluded.
	69	*/
	70
	71
	72
	73
	74
43f18f45	75	/! \fn int vuexclude(const char user)
2357ef77 FM	76	Tell if the user is excluded from the report.
2357ef77 FM	77
2357ef77 FM	78	\param user The user to check.
	79
	80	\retval 1 The user is not excluded.
	81	\retval 0 The user is excluded.
	82	*/
43f18f45 FM	83
	84
	85
	86
	87
2824ec9b	88	/*! \fn bool is_indexonly(void)
43f18f45 FM	89	Tell if the exclusion list of the users mention the word "indexonly" meaning that
	90	the user only want to produce the index.html.
	91
	92	\return \c True if only the index is requested or \c false if normal processing is requested.
	93	*/
	94
	95
	96
	97
	98
	99	/*! \fn void free_exclude(void)
	100	Free the memory allocated by gethexclude() and getuexclude().
	101	*/