documentation/exclude.txt

   1 /*! \file exclude.c
   2 \brief Handle exclusion of sites and users from the report.
   3 */
   4
   5
   6
   7
   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.
  11
  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)
  63 Tell if the site accessed by the user is excluded from the report.
  64
  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
  75 /*! \fn int vuexclude(const char *user)
  76 Tell if the user is excluded from the report.
  77
  78 \param user The user to check.
  79
  80 \retval 1 The user is not excluded.
  81 \retval 0 The user is excluded.
  82 */
  83
  84
  85
  86
  87
  88 /*! \fn bool is_indexonly(void)
  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 */