util.txt (sarg-2.3.11) | : | util.txt (sarg-2.4.0) | ||
---|---|---|---|---|
skipping to change at line 294 | skipping to change at line 294 | |||
\param media A variable to store the average number of bytes per entry. | \param media A variable to store the average number of bytes per entry. | |||
*/ | */ | |||
/*! \fn int getperiod_fromsarglog(const char *arqtt,struct periodstruct *period) | /*! \fn int getperiod_fromsarglog(const char *arqtt,struct periodstruct *period) | |||
Initialize the period with the content of the first line of a sarg log. | Initialize the period with the content of the first line of a sarg log. | |||
\param arqtt The text at the first line of a sarg log file. | \param arqtt The text at the first line of a sarg log file. | |||
\param period The period to initialize. | \param period The period to initialize. | |||
*/ | */ | |||
/*! \fn void getperiod_fromrange(struct periodstruct *period,int dfrom,int dunti | ||||
l) | ||||
Fill the period with the specified range. | ||||
\param period The period to change. | ||||
\param dfrom The start date in the form year*10000+month*100+day. | ||||
\param duntil The end date in the form year*10000+month*100+day. | ||||
*/ | ||||
/*! \fn int getperiod_buildtext(struct periodstruct *period) | /*! \fn int getperiod_buildtext(struct periodstruct *period) | |||
Build the text to display as the date range of the report. | Build the text to display as the date range of the report. | |||
\param period The object whose text must be contructed. | \param period The object whose text must be contructed. | |||
\retval 0 No error. | \retval 0 No error. | |||
\retval -1 Resulting text too long for buffer. | \retval -1 Resulting text too long for buffer. | |||
*/ | */ | |||
/*! \fn static void copy_images(void) | /*! \fn static void copy_images(void) | |||
Copy the images (in fact all the files) from the directory ::IMAGEDIR into the o utput directory | Copy the images (in fact all the files) from the directory ::IMAGEDIR into the o utput directory | |||
whose name is in ::outdir. | whose name is in ::outdir. | |||
*/ | */ | |||
/*! \fn void vrfydir(const char *per1, const char *addr, const char *site, const | ||||
char *us, const char *form) | ||||
Create a directory to generate a report for the specified connection data and po | ||||
pulate it with the a <tt>sarg-date</tt> file | ||||
containing the current date. | ||||
The function also create an <tt>images</tt> directory in \a dir and copy all the | ||||
files from the <tt>SYSCONFDIR/images</tt> into | ||||
that directory. | ||||
\param per1 The date range in the form: YYYYMMMDD-YYYYMMMDD or DDMMMYYYY-DDMMMYY | ||||
YY depending on the value of | ||||
::DateFormat. | ||||
\param addr The ip address or host name to which the report is limited. If the s | ||||
tring is empty, all the addresses are accepted. | ||||
\param site The destination site to which the report is limited. If the string i | ||||
s empty, all the sites are accepted. | ||||
\param us The user to whom the report is limited. It is an empty string if all t | ||||
he users are accepted. | ||||
\param form The email address to which the report is sent. It is currently unuse | ||||
d. | ||||
*/ | ||||
/*! \fn void strip_latin(char *line) | /*! \fn void strip_latin(char *line) | |||
Remove any HTML entity from the line. A HTML entity starts with an ampersand and end at the next | Remove any HTML entity from the line. A HTML entity starts with an ampersand and end at the next | |||
semicolon. | semicolon. | |||
\param line The text whose html entities are to be removed. | \param line The text whose html entities are to be removed. | |||
*/ | */ | |||
/*! \fn void zdate(char *ftime,int ftimesize, const char *DateFormat) | /*! \fn void zdate(char *ftime,int ftimesize, const char *DateFormat) | |||
Format the current date and time according to the date format. | Format the current date and time according to the date format. | |||
skipping to change at line 453 | skipping to change at line 429 | |||
Compare two integers for bsearch. | Compare two integers for bsearch. | |||
\param a A pointer to the first integer. | \param a A pointer to the first integer. | |||
\param b A pointer to the second integer. | \param b A pointer to the second integer. | |||
\retval 1 If a > b. | \retval 1 If a > b. | |||
\retval 0 If a == b. | \retval 0 If a == b. | |||
\retval -1 If a < b. | \retval -1 If a < b. | |||
*/ | */ | |||
/*! \fn int getnumlist( char *buf, numlist *list, const int len, const int maxva | ||||
lue ) | ||||
Get a comma separated list of numbers and split them into separate values taking | ||||
into account | ||||
that no value may be greater than a maximum. If a value is in fact a range, it i | ||||
s expended. | ||||
Any duplicate value is removed. | ||||
\param buf The string with the list of numbers. | ||||
\param list Where to store the numbers. | ||||
\param len The size of the list. | ||||
\param maxvalue The maximum value allowed in the list. | ||||
\retval 0 No error. | ||||
\retval -1 Error detected. | ||||
*/ | ||||
/*! \fn void show_info(FILE *fp_ou) | /*! \fn void show_info(FILE *fp_ou) | |||
Write the HTML formatted message to indicate the version of sarg that produced | Write the HTML formatted message to indicate the version of sarg that produced | |||
the report and when the report was generated. | the report and when the report was generated. | |||
\param fp_ou The HTML file to which the identification block must be appended. | \param fp_ou The HTML file to which the identification block must be appended. | |||
*/ | */ | |||
/*! \fn void show_sarg(FILE *fp_ou, int depth) | /*! \fn void show_sarg(FILE *fp_ou, int depth) | |||
Write the header of the report to tell that it was generated by sarg. | Write the header of the report to tell that it was generated by sarg. | |||
skipping to change at line 531 | skipping to change at line 492 | |||
*/ | */ | |||
/*! \fn void url_module(const char *url, char *w2) | /*! \fn void url_module(const char *url, char *w2) | |||
Copy at most 254 bytes from the end of the URL or stops at the first /. | Copy at most 254 bytes from the end of the URL or stops at the first /. | |||
\param url The URL to parse. | \param url The URL to parse. | |||
\param w2 A buffer to store the copied portion of the URL. The buffer must | \param w2 A buffer to store the copied portion of the URL. The buffer must | |||
be at least 255 characters long. | be at least 255 characters long. | |||
*/ | */ | |||
/*! \fn void url_to_file(const char *url,char *file,int filesize) | ||||
Mangle an URL to produce a part that can be included in a file. | ||||
\param url The URL to mangle. | ||||
\param file The buffer to write the mangled URL. | ||||
\param filesize The size of the buffer. | ||||
*/ | ||||
/*! \fn int write_html_trailer(FILE *fp_ou) | /*! \fn int write_html_trailer(FILE *fp_ou) | |||
End the HTML file by closing the centered table that was opened by write_html_he ader(), writting | End the HTML file by closing the centered table that was opened by write_html_he ader(), writting | |||
the informations of show_info() and closing the body and html tag. After this fu nction returns, the | the informations of show_info() and closing the body and html tag. After this fu nction returns, the | |||
HTML file is complete and nothing should be written to it. | HTML file is complete and nothing should be written to it. | |||
\param fp_ou The HTML file to close. The file handle is not closed but you shoul d not write anything | \param fp_ou The HTML file to close. The file handle is not closed but you shoul d not write anything | |||
to the file after this function returns. | to the file after this function returns. | |||
\retval 0 No error. | \retval 0 No error. | |||
\retval -1 Write error. | \retval -1 Write error. | |||
End of changes. 4 change blocks. | ||||
59 lines changed or deleted | 0 lines changed or added |