Embryo of documentation for the code with doxygen.
Changed subs to replace the string in place and avoid allocating a memory that was freed on only one occasion.
A few improvements on strings manipulations.
--- /dev/null
+# Doxyfile 1.5.6
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = Sarg
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = 1
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY =
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,
+# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,
+# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
+# and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 3
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen to replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = YES
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespace are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = YES
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be abled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE = doxygen.log
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = . include documentation
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+
+FILE_PATTERNS = *.c *.h *.txt
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
+# directories that are symbolic links (a Unix filesystem feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
+# is applied to all files.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentstion.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# stylesheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to FRAME, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature. Other possible values
+# for this tag are: HIERARCHIES, which will generate the Groups, Directories,
+# and Class Hiererachy pages using a tree view instead of an ordered list;
+# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which
+# disables this behavior completely. For backwards compatibility with previous
+# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
+# respectively.
+
+GENERATE_TREEVIEW = NONE
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse
+# the parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option is superseded by the HAVE_DOT option below. This is only a
+# fallback. It is recommended to install and use dot, since it yields more
+# powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# By default doxygen will write a font called FreeSans.ttf to the output
+# directory and reference it in all dot files that doxygen generates. This
+# font does not include all possible unicode characters however, so when you need
+# these (or just want a differently looking font) you can specify the font name
+# using DOT_FONTNAME. You need need to make sure dot is able to find the font,
+# which can be done by putting it in a standard location or by setting the
+# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
+# containing the font.
+
+DOT_FONTNAME = FreeSans
+
+# By default doxygen will tell dot to use the output directory to look for the
+# FreeSans.ttf font (which doxygen will put there itself). If you specify a
+# different font using DOT_FONTNAME you can set the path where dot
+# can find it using this tag.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is enabled by default, which results in a transparent
+# background. Warning: Depending on the platform used, enabling this option
+# may lead to badly anti-aliased labels on the edges of a graph (i.e. they
+# become hard to read).
+
+DOT_TRANSPARENT = YES
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
get_usertab_name(user,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
if(AuthfailReportLimit) {
get_usertab_name(user,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
if(DansGuardianReportLimit) {
get_usertab_name(user,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
if(DeniedReportLimit) {
--- /dev/null
+/*! \file util.c
+\brief Various useful functions.
+*/
+
+
+
+
+
+/*! \var static char mtab1[12][4];
+The list of the months.
+*/
+
+
+
+
+
+/*! \fn int getword(char *word, int limit, char *line, int stop)
+
+Extract one "word" from the text line and remove it from the text line. The word's boundary is defined
+by the \a stop character. If multiple stop characters are found after the word, only the first one is
+removed. Therfore, passing the line buffer again to the function will remove the next word in a column
+like manner.
+
+\param word The buffer to store the extracted word.
+\param limit The size of the buffer. If the stop character isn't found before that limit is reached,
+the function displays an error message and returns an error code.
+\param line The text line from which the word must be extracted.
+\param stop The character indicating the end of the word.
+
+\retval 0 The word is extracted.
+\retval -1 The stop character was not found before the limit or the end of the string is reached.
+
+*/
+
+
+
+
+
+/*! \fn int getword_multisep(char *word, int limit, char *line, int stop)
+
+Extract one "word" from the text line and remove it from the text line. The word's boundary is defined
+by the \a stop character. All the stop characters following the word are removed too. Therefore, passing
+the line buffer again to the function will remove words even if they are separated by multiple stop
+characters.
+
+\param word The buffer to store the extracted word.
+\param limit The size of the buffer. If the stop character isn't found before that limit is reached,
+the function displays an error message and returns an error code.
+\param line The text line from which the word must be extracted.
+\param stop The character indicating the end of the word.
+
+\retval 0 The word is extracted.
+\retval -1 The stop character was not found before the limit or the end of the string is reached.
+
+*/
+
+
+
+
+
+/*! \fn int getword3(char *word, int limit, char *line, int stop)
+
+This function is now identical to getword().
+
+\param word The buffer to store the extracted word.
+\param limit The size of the buffer. If the stop character isn't found before that limit is reached,
+the function displays an error message and returns an error code.
+\param line The text line from which the word must be extracted.
+\param stop The character indicating the end of the word.
+
+\retval 0 The word is extracted.
+\retval -1 The stop character was not found before the limit or the end of the string is reached.
+
+*/
+
+
+
+
+/*! \fn long long int my_atoll (const char *nptr)
+
+Convert a string into a long long.
+
+\param nptr The string containing the number to convert.
+
+\return The number found in the string or zero if no number was found.
+
+*/
+
+
+
+
+
+/*! \fn void my_mkdir(const char *name)
+
+Create the directory and all the non existing parent directories.
+
+\param name The absolute directory to create.
+
+*/
+
+
+
+
+
+/*! \fn void my_lltoa(unsigned long long int n, char s[], int len)
+
+Format a long long into a string.
+
+\param n The number to format.
+\param s The buffer to write the number.
+\param len The minimum number of digits to format in the output. If the formatted
+number is less than this length, it is padded with zeros.
+
+*/
+
+
+
+
+
+/*! \fn void builddia(char *dia, const char *mes, const char *ano, const char *df, char *wdata)
+
+Format a date into a YYYYMMDD string and into a DD/MM/YYYY or MM/DD/YYYY string depending on the value
+of the \a df parameter.
+
+\param dia The day of the date on input. It is replaced by the date in the human readable format.
+\param mes The name of the month as spelled in ::mtab1. If the month is invalid the output dates are
+set to month 13.
+\param ano The year.
+\param df The format for the human readable date. If the string start with a 'u', it is formatted as
+MM/DD/YYYY. Any other character format it as DD/MM/YYYY.
+\param wdata A buffer to store the machine formatted date YYYYMMDD.
+
+*/
+
+
+
+
+
+/*! \fn void buildymd(const char *dia, const char *mes, const char *ano, char *wdata)
+Convert the date into a machine format YYYYMMDD.
+
+\param dia The day.
+\param mes The name of the month as spelled in ::mtab1. If the month is invalid, the output date
+is set to month 13.
+\param ano The year.
+\param wdata The buffer to format the date.
+*/
+
+
+
+
+
+/*! \fn void conv_month(char *month)
+Convert the month's name into its two digits numerical equivalent.
+
+\param month The name of the month as spelled in ::mtab1. It is replaced by the month number on
+two digits with a padding zero. If the month name is not in ::mtab1, the string is not replaced.
+*/
+
+
+
+
+
+/*! \fn void conv_month_name(char *month)
+Convert a month number into a name.
+
+\param month The number of the month. It is replaced by the name of the month from ::mtab1 unless
+the month number is not between 1 and 12.
+*/
+
+
+
+
+
+/*! \fn void name_month(char *month,int month_len)
+Get the name of the month according to the language file selected by the user.
+
+\param month The number of the month. It is replaced by the month's name if the number is between
+1 and 12 or by the name of December if the number is invalid.
+\param month_len The size of the \a month buffer.
+
+*/
+
+
+
+
+
+/*! \fn void fixper(char *tbuf, char *period, const char *duntil)
+Given a date in the form YYYYMMDD, the function format it as DD/mmm/YYYY
+or mmm/DD/YYYY according to the value of the ::df global variable and append
+it to \a period.
+
+\param tbuf Unused.
+\param period The string to which the formated date is appended.
+\param duntil The date to format.
+
+*/
+
+
+
+
+
+/*! \fn void debuga(const char *msg,...)
+Write a debug message to stderr. The message is prefixed by "SARG:" to identify its origin.
+
+\param msg The printf like message to format.
+\param ... The arguments to format in the message.
+
+*/
+
+
+
+
+
+/*! \fn void debugaz(const char *head, const char *msg)
+Write a debug message to stderr with the value of a parameter. The message is prefixed by "SARG: (util)".
+
+\param head The name of the parameter.
+\param msg The value of the parameter.
+*/
+
+
+
+
+
+/*! \fn void fixip(char *ip)
+Toggle the IP address format from nnn.nnn.nnn.nnn to nnn_nnn_nnn_nnn. Only the first three
+occurences of the . or _ are replaced. That limitation is imposed by a will to mimic as close
+as possible the previous code based on strings copying.
+
+\param ip The IP address to change. It is replaced in place.
+
+*/
+
+
+
+
+
+/*! \fn char *fixnum(long long int value, int n)
+Rewrite a number to make it more readable. The number may be written
+with the suffix K, M, G or T depending on its magnitude or the digits
+are grouped by three and separated by a dot or a comma.
+
+\param value The number to format.
+\param n If the number is abreviated and this parameter is true then append
+the suffix K, M, G or T if necessary. If it is zero, the number is shortened
+but no suffix is written.
+
+\return A static buffer containing the formatted number. It is overwritten on the next
+call of this function.
+
+*/
+
+
+
+
+
+/*! \def MAXLEN_FIXNUM
+The size of the buffer to format a number in fixnum().
+*/
+
+
+
+
+
+/*! \fn char *fixnum2(long long int value, int n)
+Format a number by grouping the digits by three and separating the groups by
+a dot or a comma.
+*/
+
+
+
+
+/*! \def MAXLEN_FIXNUM2
+The size of the buffer to format a number in fixnum2().
+*/
+
+
+
+
+
+/*! \fn void buildhref(char * href)
+Replace the path given as argument by the first part of a HTML tag to link to the given
+directory (the A tag). More precisely, the argument is replaced by <a href=" followed by the given \a href.
+
+\param href The directory to replace by a HTML A tag with the open HREF to it.
+
+*/
+
+
+
+
+
+/*! \fn char *buildtime(long long int elap)
+Write the elapsed time given in milliseconds as a string in the format HH:MM:SS.
+
+\param elap The elapsed time in milliseconds.
+
+\return A static buffer with the formatted time. It is valid until the function is called again.
+*/
+
+
+
+
+
+/*! \fn void obtdate(const char *dirname, const char *name, char *data)
+Get the date stored in the <tt>sarg-date</tt> file of a directory with the connection data.
+
+\param dirname The directory to look for the connection directory.
+\param name The name of the directory whose <tt>sarg-date</tt> file must be read.
+\param data The buffer to store the content of the file. It must be more than 80
+bytes long.
+*/
+
+
+
+
+
+/*! \fn void obtuser(const char *dirname, const char *name, char *tuser)
+Get the number of entries stored in a connection data directory. The number is read from
+the <tt>sarg-users</tt> file of the connection data's directory.
+
+\param dirname The directory to look for the connection directory.
+\param name The name of the connection directory whose <tt>sarg-users</tt> file must be read.
+\param tuser The buffer to store the content of the file. It must be more than 20
+bytes long.
+*/
+
+
+
+
+
+/*! \fn void obttotal(const char *dirname, const char *name, char *tbytes, char *tuser, char *media)
+Count the total size transfered in a connection directory and compute the average number of bytes
+per entry.
+
+\param dirname The directory to look for the connection directory.
+\param name The name of the connection directory whose <tt>sarg-general</tt> file must be read.
+\param tbytes A buffer to store the total number of bytes from this connection.
+\param tuser The number of entries in the connection directory.
+\param media A buffer to store the average number of bytes per entry.
+*/
+
+
+
+
+
+/*! \fn void gperiod(const char *dirname, const char *period)
+Write the current period for the connection directory in a file named <tt>sarg-period</tt>
+in the connection directory.
+
+\param dirname The connection directory to which the period must be written.
+\param period The period to write in the file.
+*/
+
+
+
+
+/*! \fn void vrfydir(const char *dir, 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 populate 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 dir The output directory to fill.
+\param per1 The date range in the form: YYYYMMMDD-YYYYMMMDD or DDMMMYYYY-DDMMMYYYY depending on the value of
+::IndexTree.
+\param addr The ip address or host name to which the report is limited. If the string is empty, all the addresses are accepted.
+\param site The destination site to which the report is limited. If the string is empty, all the sites are accepted.
+\param us The user to whom the report is limited. It is an empty string if all the users are accepted.
+\param form The email address to which the report is sent. It is currently unused.
+
+*/
+
+
+
+
+
+/*! \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
+semicolon.
+
+\param line The text whose html entities are to be removed.
+*/
+
+
+
+
+
+/*! \fn void zdate(char *ftime, const char *DateFormat)
+Format the current date and time according to the date format.
+
+\param ftime The buffer to format the date. It must be at least 127 bytes long.
+\param DateFormat The format of the date. It can be:
+ \arg u to format as mmm/dd/YYYY HH:MM
+ \arg e to format as dd/mmm/YYYY HH:MM
+ \arg w to format as WW-HH-MM where WW is the week number in the range 00 to 53.
+*/
+
+
+
+
+
+/*! \fn char *fixtime(long int elap)
+Format a "time" into a size or a time formatted as HH:MM:SS.
+
+\param elap The "time" to format in milliseconds if it is a time and into bytes if it is a size.
+
+\return The formatted time.
+
+\bug If the elapsed time is less than 1000ms, the time is formated with the milliseconds as the seconds.
+
+\todo Review this function and documentation based on the calls made to it and the arguments passed by the callers.
+*/
+
+
+
+
+
+/*! \fn void date_from(char *date, char *dfrom, char *duntil)
+Split a date range into a date from and a date until. If the date range
+is not a range but just a single date, it is duplicated to make a range out
+of it.
+
+\param date The date range to split in the form <tt>from-until</tt>. If it is a single date,
+it is transformed into a range like <tt>date-date</tt>. Each date is in the form DD/MM/YYYY.
+\param dfrom A buffer to write the start date in the form YYYYMMDD.
+\param duntil A buffer to write the end date in the form YYYYMMDD.
+*/
+
+
+
+
+
+/*! \fn char *strlow(char *string)
+Convert a string to all lowercases.
+
+\param string The string to convert.
+
+\return A pointer to the string passed as argument.
+*/
+
+
+
+
+
+/*! \fn char *strup(char *string)
+Convert a string to all uppercases.
+
+\param string The string to convert.
+
+\return A pointer to the string passed as argument.
+*/
+
+
+
+
+
+/*! \fn void subs(char *str, int size, char *from, char *to)
+Replace one occurence of the string \a from by \a to in the string \a str.
+
+\param str The string in which to replace the text.
+\param size The size of the string buffer to detect a buffer overflow if \a to is longer than \a from.
+\param from The fragment of text to replace.
+\param to The text to replace instead of \a from.
+*/
+
+
+
+
+
+/*! \fn void removetmp(const char *outdir)
+Remove the file <tt>sarg-period</tt> from the output directory and purge the file <tt>sarg-general</tt> from
+all the lines but the total.
+
+\param outdir The output directory to purge.
+*/
+
+
+
+
+
+/*! \fn void load_excludecodes(const char *ExcludeCodes)
+Load the list of the HTTP codes to exclude from the report. There must be one code per line.
+Any trailing space is removed and there is no provision for comments.
+
+\param ExcludeCodes The name of the file to load.
+
+This function allocate the memory to store the codes and it must be freed by a call to
+free_excludecodes().
+*/
+
+
+
+
+
+/*! \fn void free_excludecodes(void)
+Free the memory allocated by load_excludecodes().
+*/
+
+
+
+
+/*! \fn int vercode(const char *code)
+Check if the code is contained in the exclusion list loaded by load_excludecodes().
+
+\param code The HTTP code to test.
+
+\retval 1 The code is excluded.
+\retval 0 The code is not excluded.
+*/
+
+
+
+
+
+/*! \fn void fixnone(char *str)
+Find if the string is the word none and clear the string if it matches. The function
+tolerates the trailing spaces and tabulations.
+
+\param str The text to test for the word "none".
+*/
+
+
+
+
+
+/*! \fn int testvaliduserchar(const char *user)
+Tell if the user string contains any invalid character in a user name. The list
+of the invalid characters is defined by ::UserInvalidChar.
+
+\param user The user name to test.
+
+\retval 1 The string contains at least one invalid character.
+\retval 0 The string is valid.
+*/
+
+
+
+
+
+/*! \fn int compar( const void *a, const void *b )
+Compare two integers for bsearch.
+
+\param a A pointer to the first integer.
+\param b A pointer to the second integer.
+
+\retval 1 If a > b.
+\retval 0 If a == b.
+\retval -1 If a < b.
+*/
+
+
+
+
+
+/*! \fn int getnumlist( char *buf, numlist *list, const int len, const int maxvalue )
+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 is 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)
+Write the HTML formatted message to indicate the version of sarg that produced
+the report and when the report was generated.
+
+\param fp_ou The HTML file to which the identification block must be appended.
+*/
+
+
+
+
+
+/*! \fn void show_sarg(FILE *fp_ou, const char *ind)
+Write the header of the report to tell that it was generated by sarg.
+
+\param fp_ou The handle of the HTML file.
+\param ind The path to use to have access to the images directory with the sarg logo. It is a succession of ..
+to move up until the root of the reports with the images directory.
+*/
+
+
+
+
+
+/*! \fn char *get_size(const char *path, const char *file)
+Get the size, in human readable form and kibibytes, of the content of a directory.
+
+\param path The path containing the directory to scan.
+\param file The last part of the path to the directory to scan.
+
+\return The size of the path.
+*/
+
+
+
+
+
+/*! \fn void write_html_header(FILE *fp_ou, const char * ind)
+Write the HTML header of a HTML report file. The DTD correspond to a
+transitional HTML version 4.01. The title of the document is taken from
+the global variable ::Title.
+
+\param fp_ou The file to which the HTML header is written.
+\param ind The path to pass to show_arg() to find the root directory where the
+images directory is.
+*/
+
+
+
+
+
+/*! \fn void baddata(void)
+Display an error message telling that sarg suspects an attempt to execute arbitrary code and terminate sarg.
+
+Any temporary file created by sarg is deleted.
+*/
+
+
+
+
+
+/*! \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 /.
+
+\param url The URL to parse.
+\param w2 A buffer to store the copied portion of the URL. The buffer must
+be at least 255 characters long.
+*/
+
+
+
+
+
+/*! \fn void write_html_trailer(FILE *fp_ou)
+End the HTML file by closing the centered table that was opened by write_html_header(), writting
+the informations of show_info() and closing the body and html tag. After this function returns, the
+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 should not write anything
+to the file after this function returns.
+
+*/
+
+
+
+
+
+/*! \fn void version(void)
+Display the current version of sarg and terminate the program.
+*/
+
+
+
+
+
+/*! \fn char *get_param_value(const char *param,char *line)
+Get the value of a parameter formatted in the string as "param value"
+without the quotes.
+
+If the parameter name matches \a param, then the value following the parameter
+is returned. If it doesn't match, the function return NULL.
+
+The function is suitable to parse configuration files because it will ignore
+comments (anything but spaces and tabulations put before the parameter will make
+it unrecognized by this function)
+
+\param param The parameter name that must be found at the beginning of the line
+with possible spaces or tabulations before.
+\param line The text line to search for the parameter and it's value.
+
+\return The beginning of the value after the equal sign and with the possible
+spaces or tabulations removed. If the line doesn't start with the parameter name,
+the function returns NULL.
+
+*/
+
+
+
+
+
+/*! \fn void read_usertab(const char *UserTabFile)
+Read the content fo the \a UserTabFile and store it for further use with get_usertab_name().
+
+The file contains the IP address or ID of the user then some spaces and the real name of the user.
+The file may contain comments if the line starts with a #.
+
+\param UserTabFile The name of the file to read. If it is empty, the function does nothing.
+*/
+
+
+
+
+
+/*! \fn void get_usertab_name(const char *user,char *name,int namelen)
+Find the real name of the user with the ID or IP address in \a user. The name is fetched
+from the usertab file.
+
+The usertab file must have been read by read_usertab().
+
+\param user The ID or IP address of the user.
+\param name A buffer to write the real name of the user.
+\param namelen The size of the buffer.
+*/
get_usertab_name(user,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
if(DownloadReportLimit) {
if(strcmp(DateFormat,"e") == 0)
strftime(ftime, 127, "%d/%b/%Y-%H:%M", local);
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
SARGgdImageStringFT(im,&brect[0],darkblue,font1,7,0.0,620,470,ftime);
get_usertab_name(u2,name2,sizeof(name2));
- if(dotinuser && strstr(name2,"_")) {
- str2=(char *)subs(name2,"_",".");
- strcpy(name2,str2);
+ if(dotinuser && strchr(name2,'_')) {
+ subs(name2,sizeof(name2),"_",".");
}
if ((fp_in = fopen(arqin, "r")) == 0){
fprintf(stderr, "SARG: (html3) %s: %s\n",text[45],arqin);
exit(1);
}
-
+
while(fgets(buf,sizeof(buf),fp_in)!=NULL) {
if (getword(wtemp,sizeof(wtemp),buf,' ')<0) {
printf("SARG: Maybe you have a broken record or garbage in your %s file.\n",arqin);
twork2=my_atoll(totuser);
twork=ttnacc/twork2;
- sprintf(wwork1,"%s",fixnum(twork,1));
- sprintf(wwork2,"%s",fixnum(totbytes2,1));
- sprintf(wwork3,"%s",fixnum2(totelap2,1));
+ strcpy(wwork1,fixnum(twork,1));
+ strcpy(wwork2,fixnum(totbytes2,1));
+ strcpy(wwork3,fixnum2(totelap2,1));
sprintf(val6,"%s",buildtime(totelap2));
sprintf(val7,"%3.2f%%",perc2);
char AuthType[255];
char Require[512];
char DownloadSuffix[MAXLEN];
-char *excludecode;
char *userfile;
char *str;
char *str2;
char ip[25];
char RealtimeUnauthRec[15];
-int excode;
int idate;
int smartfilter;
int denied_count;
int squid24;
float perc;
-long long int twork;
-long long int twork2;
long long int nocost;
float cost;
void show_sarg(FILE *fp_ou, const char *ind);
void write_html_header(FILE *fp_ou, const char * ind);
void write_html_trailer(FILE *fp_ou);
-char *subs(char *str, char *from, char *to);
+void subs(char *str, int size, char *from, char *to);
void conv_month(char *month);
void debuga(const char *msg,...);
void debugaz(const char *head, const char *msg);
void my_lltoa(unsigned long long int n, char s[], int len);
char *get_size(const char *path, const char *file);
-void url_module(char *url, char *w2);
+void url_module(const char *url, char *w2);
void strip_latin(char *line);
char *buildtime(long long int elap);
void obtdate(const char *dirname, const char *name, char *data);
void obttotal(const char *dirname, const char *name, char *tbytes, char *tuser, char *media);
void version(void);
int vercode(const char *code);
-void load_excludecodes(void);
+void load_excludecodes(const char *ExcludeCodes);
+void free_excludecodes(void);
void my_mkdir(const char *name);
int testvaliduserchar(const char *user);
char *strlow(char *string);
char *strup(char *string);
void builddia(char *dia, const char *mes, const char *ano, const char *df, char *wdata);
void vrfydir(const char *dir, const char *per1, const char *addr, const char *site, const char *us, const char *form);
-void gperiod(void);
+void gperiod(const char *dirname, const char *period);
void removetmp(const char *outdir);
void zdate(char *ftime, const char *DateFormat);
void baddata(void);
char *get_param_value(const char *param,char *line);
void read_usertab(const char *UserTabFile);
void get_usertab_name(const char *user,char *name,int namelen);
+int compar( const void *, const void * );
dirp = opendir(outdir);
while ((direntp = readdir( dirp )) != NULL) {
- char *p;
if(strcmp(IndexTree,"date") == 0) {
if(strlen(direntp->d_name) > 4 || (!isdigit(direntp->d_name[0]) && !isdigit(direntp->d_name[1]))) continue;
fprintf(fp_tmp,"%s %s\n",direntp->d_name,get_size(outdir,direntp->d_name));
printf("SARG: Maybe you have a broken time in your %s%s/sarg-date file.\n",outdir,direntp->d_name);
exit(1);
}
- p = strchr(html, ' ');
- if (!p) p = html;
- if (getword_multisep(year,sizeof(year),p,' ')<0) {
+ if (getword_multisep(year,sizeof(year),html,' ')<0) {
printf("SARG: Maybe you have a broken year in your %s%s/sarg-date file.\n",outdir,direntp->d_name);
exit(1);
}
void gethexclude(char *hexfile, int debug);
void getuexclude(char *uexfile, int debug);
void ttx(char *user);
-int compar( const void *, const void * );
#define _FILE_OFFSET_BITS 64
SquidGuardConf[0]='\0';
DansGuardianConf[0]='\0';
- excode=0;
denied_count=0;
download_count=0;
authfail_count=0;
if(DataFile[0] != '\0');
dataonly++;
- str2=(char *)subs(TopUserFields,"%BYTES","SETYB");
- strcpy(TopUserFields,str2);
+ subs(TopUserFields,sizeof(TopUserFields),"%BYTES","SETYB");
- str2=(char *)subs(UserReportFields,"%BYTES","SETYB");
- strcpy(UserReportFields,str2);
+ subs(UserReportFields,sizeof(UserReportFields),"%BYTES","SETYB");
if(!narq) {
strcpy(warq[0],AccessLog);
exit(0);
}
- if(ExcludeCodes[0] != '\0') {
- if((excludecode=(char *) malloc(1024))==NULL) {
- fprintf(stderr, "SARG: %s (1024):\n",text[59]);
- exit(1);
- }
- bzero(excludecode,1024);
- load_excludecodes();
- }
+ load_excludecodes(ExcludeCodes);
if(access(PasswdFile, R_OK) == 0) {
getusers(PasswdFile,debug);
continue;
}
- if(excode) {
- if(vercode(code)) {
- totregsx++;
- continue;
- }
+ if(vercode(code)) {
+ totregsx++;
+ continue;
}
if(testvaliduserchar(user))
}
if(dotinuser) {
- str2=(char *)subs(user,"_",".");
- strcpy(user,str2);
+ subs(user,sizeof(user),"_",".");
dotinuser=0;
}
system(tmp4);
}
- if(excludecode)
- free(excludecode);
+ free_excludecodes();
if(userfile)
free(userfile);
if(excludefile)
ip2name(u2,sizeof(u2));
get_usertab_name(u2,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
printf("<tr><td class=\"data\">%s %s</td><td class=\"data3\">%s</td><td class=\"data3\">%s</td><td class=\"data3\">%s</td><td class=\"data2\"><a href=\"http://%s\">%s</td></tr>\n",dat,tim,ip,name,typ,url,url);
get_usertab_name(wuser,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
-
+
fprintf(fp_ou,"<tr><th class=\"header3\" colspan=\"2\">%s: %s</th></tr>\n",text[90],name);
fputs("<tr><td></td></tr><tr><td></td></tr>\n",fp_ou);
debugaz("dirname",dirname);
debugaz("wdir",wdir);
}
-
- strcpy(wdirname,dirname);
- gperiod();
+
+ gperiod(dirname,period);
if(strlen(UserAgentLog) > 0 && email[0] == '\0') useragent();
fprintf(stderr, "SARG: (report) %s: %s\n",text[45],tmp);
exit(1);
}
-
+
if (dlen>0) {
if (dlen>=sizeof(user)) continue;
strncpy(user,direntp->d_name,dlen);
} else {
user[0]='\0';
}
-
+
strcpy(wdirname,dirname);
maketmp(user,tmp,debug,indexonly);
maketmp_hour(user,tmp,indexonly);
-
+
strcpy(u2,user);
if(strcmp(Ip2Name,"yes") == 0)
ip2name(u2,sizeof(u2));
get_usertab_name(u2,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
ttopen=0;
bzero(html_old, MAXLEN);
-
+
while(fgets(buf,sizeof(buf),fp_in)!=NULL) {
if (getword(accdia,sizeof(accdia),buf,' ')<0 || getword(acchora,sizeof(acchora),buf,' ')<0 ||
getword(accuser,sizeof(accuser),buf,' ')<0 || getword(accip,sizeof(accip),buf,' ')<0 ||
printf("SARG: Maybe you have a broken record or garbage in your %s file.\n",tmp3);
exit(1);
}
-
+
if(strlen(accsmart) > 0) {
smartfilter++;
strcpy(wdirname,dirname);
strcpy(nameantes,accip);
} else strcpy(accip,nameantes);
}
-
+
strcpy(wdirname,dirname);
gravatmp_hora(wdirname,accuser,accdia,acchora,accelap,accbytes,indexonly);
if(strstr(oldacccode,"DENIED") != 0)
sprintf(oldmsg,"%s",text[46]);
gravatmp(oldaccuser,wdirname,oldurl,nacc,nbytes,oldmsg,nelap,indexonly,incache,oucache);
- gravager(wdirname,oldaccuser,nacc,oldurl,nbytes,oldaccip,oldacchora,oldaccdia,nelap,
- incache,oucache);
+ gravager(wdirname,oldaccuser,nacc,oldurl,nbytes,oldaccip,oldacchora,oldaccdia,nelap,incache,oucache);
nacc=0;
nbytes=0;
nelap=0;
{
FILE *fp_in, *fp_ou;
-
+
char user[MAXLEN];
char url[MAXLEN];
char wuser[MAXLEN];
char *users;
long long int llbytes=0;
int cstatus;
- char *str2;
if(strcmp(Privacy,"yes") == 0)
return;
get_usertab_name(user,name,sizeof(name));
if(dotinuser && strchr(name,'_')) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ subs(name,sizeof(name),"_",".");
}
/*
get_usertab_name(user,name,sizeof(name));
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
if(SquidGuardReportLimit) {
fputs("<center><table cellpadding=\"0\" cellspacing=\"0\">\n",fp_ou);
fprintf(fp_ou,"<tr><th class=\"title\">%s</th></tr>\n",Title);
-
+
fprintf(fp_ou,"<tr><td class=\"header3\">%s: %s</td></tr>\n",text[89],period);
fprintf(fp_ou,"<tr><th class=\"header3\">%s %s %s</th></tr>\n",text[83],TopSitesNum,text[84]);
fputs("</table></center>\n",fp_ou);
twork2=my_atoll(nbytes);
twork3=my_atoll(ntime);
- sprintf(wwork1,"%s",fixnum(twork1,1));
- sprintf(wwork2,"%s",fixnum(twork2,1));
- sprintf(wwork3,"%s",fixtime(twork3));
+ strcpy(wwork1,fixnum(twork1,1));
+ strcpy(wwork2,fixnum(twork2,1));
+ strcpy(wwork3,fixtime(twork3));
if(strlen(BlockIt) > 0)
sprintf(BlockImage,"<a href=\"%s%s?url=%s\"><img src=\"../images/sarg-squidguard-block.png\" border=\"0\"></a> ",wwwDocumentRoot,BlockIt,url);
show_info(fp_ou);
fputs("</body>\n</html>\n",fp_ou);
-
+
fclose(fp_in);
fclose(fp_ou);
long long int ttnbytes=0, ttnacc=0, tnacc=0;
long long int tnbytes=0, ttnelap=0, tnelap=0;
long long int tnincache=0, tnoucache=0, ttnincache=0, ttnoucache=0;
+ long long int twork;
+ long long int twork2;
float perc=0.00;
float perc2=0.00;
float inperc=0.00, ouperc=0.00;
twork=my_atoll(nacc);
my_lltoa(twork,nacc,0);
- sprintf(wwork1,"%s",fixnum(twork,1));
- sprintf(wwork2,"%s",fixnum(tnbytes,1));
- sprintf(wwork3,"%s",fixnum2(tnelap,1));
+ strcpy(wwork1,fixnum(twork,1));
+ strcpy(wwork2,fixnum(tnbytes,1));
+ strcpy(wwork3,fixnum2(tnelap,1));
sprintf(val1,"%d",posicao);
#ifdef HAVE_GD
if(strstr(ReportType,"users_sites") == 0)
href[0]='\0';
- if(dotinuser && strstr(name,"_")) {
- str2=(char *)subs(name,"_",".");
- strcpy(name,str2);
- free(str2);
+ if(dotinuser && strchr(name,'_')) {
+ subs(name,sizeof(name),"_",".");
}
sprintf(preg,"<tr><td %s>%s</td><td %s>%s</td><td %s>%s%s</td><td %s>%s</td><td %s>%s</td><td %s>%s</td><td %s>%s</td><td %s>%s</td><td %s>%s</td><td %s>%s<td %s>%s</td></tr>\n",hbc1,val1,hbc2,val2,hbc2,href,name,hbc3,wwork1,hbc4,wwork2,hbc5,val3,hbc6,val4,hbc7,val5,hbc8,val6,hbc9,wwork3,hbc10,val7);
twork=ttnacc/totuser;
twork2=ttnelap/totuser;
- sprintf(wwork1,"%s",fixnum(twork,1));
- sprintf(wwork2,"%s",fixnum(tnbytes,1));
- sprintf(wwork3,"%s",fixnum2(twork2,1));
+ strcpy(wwork1,fixnum(twork,1));
+ strcpy(wwork2,fixnum(tnbytes,1));
+ strcpy(wwork3,fixnum2(twork2,1));
if(strstr(TopUserFields,"CONNECT") == 0) {
bzero(wwork1, 255);
#include "include/defs.h"
static char mtab1[12][4]={"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"};
-static char mtab2[12][3]={"01","02","03","04","05","06","07","08","09","10","11","12"};
+
+//! The list of the HTTP codes to exclude from the report.
+static char *excludecode=NULL;
/*void fgetword(char *word, char *line, int stop)
{
{
int x = 0,y;
- /*if(strlen(line) < 3) {
- word[0]='\0';
- return(0);
- }*/
-
for(x=0;((line[x]) && (line[x] != stop ));x++) {
if(x>=limit) {
printf("SARG: getword_multisep loop detected.\n");
return(0);
}
-#if 0 //this function seems unused
-char * getword2(char *word, int limit, char *line, int stop)
-{
- int x = 0;
-
- if(strlen(line) < 3) {
- word[0]='\0';
- return( line ) ;
- }
-
- // printf( "IN Buffer <%s>\n" , line ) ;
- for(x=0;((line[x]) && (line[x] != stop && limit ));x++ , limit-- ) word[x] = line[x];
- if( ! limit) {
- printf("SARG: getword2 loop detected.\n");
- printf("SARG: Buffer=\"%s\"\n",line);
- printf("SARG: searching for \'x%x\'\n",stop);
- printf("SARG: Maybe you have a broken record or garbage in your access.log file.\n");
- exit(1);
- }
-
- word[x] = '\0';
- // printf( "Value <%s>\n" , word ) ;
- // printf( "OUT Buffer <%s>\n" , line+x+1 ) ;
- return( line + x +1) ;
-}
-#endif
-
int getword3(char *word, int limit, char *line, int stop)
{
int x = 0, y = 0;
#else
-#define MAXLLL 30 //maximum number of digits in long long (a guess)
+#define MAXLLL 30 //!< Maximum number of digits in long long (a guess).
long long int my_atoll (const char *nptr)
{
long long int returnval=0;
void builddia(char *dia, const char *mes, const char *ano, const char *df, char *wdata)
{
char ndia[11];
- char nmes[3];
- int x;
+ int nmes;
if(strlen(dia) < 1) return;
- ndia[0]='\0';
- nmes[0]='\0';
-
- for(x=0; x<12; x++) {
- if(strcmp(mtab1[x],mes) == 0) {
- strncpy(nmes,mtab2[x],sizeof(nmes)-1);
- nmes[sizeof(nmes)-1]=0;
+ for(nmes=0; nmes<12; nmes++) {
+ if(strcmp(mtab1[nmes],mes) == 0) {
break;
}
}
+ nmes++;
- snprintf(wdata,9,"%s%s%s",ano,nmes,dia);
+ snprintf(wdata,9,"%s%02d%s",ano,nmes,dia);
- if(strncmp(df,"u",1) != 0)
- snprintf(ndia,sizeof(ndia),"%s/%s/%s",dia,nmes,ano);
+ if(df[0]!='u')
+ snprintf(ndia,sizeof(ndia),"%s/%02d/%s",dia,nmes,ano);
else
- snprintf(ndia,sizeof(ndia),"%s/%s/%s",nmes,dia,ano);
+ snprintf(ndia,sizeof(ndia),"%02d/%s/%s",nmes,dia,ano);
strcpy(dia,ndia);
void buildymd(const char *dia, const char *mes, const char *ano, char *wdata)
{
- char nmes[3];
- int x;
-
- nmes[0]='\0';
+ int nmes;
- for(x=0; x<12; x++) {
- if(strcmp(mtab1[x],mes) == 0)
- strcpy(nmes,mtab2[x]);
+ for(nmes=0; nmes<12; nmes++) {
+ if(strcmp(mtab1[nmes],mes) == 0)
+ break;
}
- sprintf(wdata,"%s%s%s",ano,nmes,dia);
+ sprintf(wdata,"%s%02d%s",ano,nmes+1,dia);
}
{
int x;
- for(x=0; x<12; x++) {
- if(strcmp(mtab1[x],month) == 0)
- strcpy(month,mtab2[x]);
- }
+ for(x=0; x<12 && strcmp(mtab1[x],month)!=0; x++);
+ sprintf(month,"%02d",x+1);
}
{
int x;
- for(x=0; x<12; x++) {
- if(strcmp(mtab2[x],month) == 0)
- strcpy(month,mtab1[x]);
- }
+ x=atoi(month);
+ if (x>=1 && x<=12)
+ strcpy(month,mtab1[x-1]);
}
strncpy(ano,duntil,4);
ano[4]='\0';
- for(x=0; x<12; x++) {
- if(strcmp(mtab2[x],mes) == 0) {
- strcpy(mes,mtab1[x]);
- break;
- }
- }
+ x=atoi(mes);
+ if (x>=1 && x<=12)
+ strcpy(mes,mtab1[x-1]);
if(strcmp(df,"e") == 0)
sprintf(warea,"%s%s%s",dia,mes,ano);
if(strcmp(df,"u") == 0)
- sprintf(warea,"%s%s%s",ano,mes,dia);
+ sprintf(warea,"%s%s%s",mes,dia,ano);
strcat(period,warea);
}
void fixip(char *ip)
{
- char n1[MAXLEN], n2[MAXLEN], n3[MAXLEN];
- char wip[MAXLEN];
- char sep='.';
- int iflag=0;
-
- strcpy(wip,ip);
-
- if(strchr(ip,'.') != 0) {
- sep='_';
- iflag++;
- }
-
- if(iflag) {
- if (getword(n1,sizeof(n1),wip,'.')<0 || getword(n2,sizeof(n2),wip,'.')<0 || getword(n3,sizeof(n3),wip,'.')<0) {
- printf("SARG: Maybe you have a broken record or garbage in the IP address.\n");
- exit(1);
+ int i;
+ char sep='_';
+ char search=0;
+ int nrepl=0;
+
+ for (i=0; ip[i]; i++) {
+ if (ip[i]=='.') {
+ search='.';
+ sep='_';
+ break;
}
- } else {
- if (getword(n1,sizeof(n1),wip,'_')<0 || getword(n2,sizeof(n2),wip,'_')<0 || getword(n3,sizeof(n3),wip,'_')<0) {
- printf("SARG: Maybe you have a broken record or garbage in the IP address.\n");
- exit(1);
+ if (ip[i]=='_') {
+ search='_';
+ sep='.';
+ break;
+ }
+ }
+ for (; ip[i]; i++) {
+ if (ip[i]==search) {
+ ip[i]=sep;
+ nrepl++;
+ if (nrepl>=3) break;
}
}
- sprintf(ip,"%s%c%s%c%s%c%s",n1,sep,n2,sep,n3,sep,wip);
-
}
for ( i = strlen(pbuf) - 1, j = 0 ; i > -1; i--, j++)
pret[j] = pbuf[i];
- pret[j] = '\0';
+ pret[j] = '\0';
- return pret;
+ return pret;
}
char wdir[MAXLEN];
long long int med=0;
long long int wtuser=0;
+ long long int twork;
sprintf(wdir,"%s%s/sarg-general",dirname,name);
if ((fp_in = fopen(wdir, "r")) == 0) {
exit(1);
}
twork=my_atoll(warea);
- sprintf(tbytes,"%s",fixnum(twork,1));
+ strcpy(tbytes,fixnum(twork,1));
}
fclose(fp_in);
- if(tuser[0] == '\0') {
- wtuser=0;
- sprintf(media,"%s","0");
+ wtuser=my_atoll(tuser);
+ if(wtuser == 0) {
+ strcpy(media,"0");
return;
}
-
- wtuser=my_atoll(tuser);
+
med=my_atoll(warea) / wtuser;
- sprintf(media,"%s",fixnum(med,1));
+ strcpy(media,fixnum(med,1));
return;
}
-//void gperiod(char *dirname, const char *period)
-void gperiod(void)
+void gperiod(const char *dirname, const char *period)
{
-
+
FILE *fp_ou;
-
char wdirname[MAXLEN];
strcpy(wdirname,dirname);
fprintf(stderr, "SARG: (report) %s: %s\n",text[45],wdirname);
exit(1);
}
-
+
fputs(period,fp_ou);
fclose(fp_ou);
if(debug)
debuga("%s",(char *)text[50]);
-
+
return;
}
} else
break;
}
-
+
if(count > 0) {
if(debug)
fprintf(stderr, "SARG: %s: %s %s %s\n",text[51],dirname2,text[52],wdir);
system(csort);
}
}
-
+
if(access(wdir, R_OK) != 0)
my_mkdir(wdir);
}
if(img_in!=NULL) {
img_ou = fopen(val11, "wb");
if(img_ou!=NULL) {
- while (c!=EOF) {
- c = fgetc(img_in);
- if(c==EOF) break;
+ while ((c = fgetc(img_in))!=EOF) {
fputc(c,img_ou);
}
- c=0;
fclose(img_ou);
} else
fprintf(stderr,"SARG: (util): %s %s: %s\n", text[45]?text[45]:"Can't open/create file", val11, strerror(errno));
+ fclose(img_in);
} else
fprintf(stderr,"SARG: (util): %s %s: %s\n", text[45]?text[45]:"Can't open file", val10, strerror(errno));
-
- fclose(img_in);
}
(void) rewinddir(dirp);
(void) closedir(dirp);
static char buf[12];
if(strcmp(datetimeby,"bytes") == 0) {
- sprintf(buf,"%s",fixnum(elap,1));
+ strcpy(buf,fixnum(elap,1));
return buf;
}
- buf[0]='\0';
-
if(num<1) {
sprintf(buf,"00:00:%02ld",elap);
return buf;
min=(num % 3600) / 60;
sec=num % 60;
- sprintf(buf,"%01d:%02d:%02d",hor,min,sec);
-
- if(strcmp(buf,"0:00:00") == 0)
+ if(hor==0 && min==0 && sec==0)
strcpy(buf,"0");
+ else
+ sprintf(buf,"%01d:%02d:%02d",hor,min,sec);
return buf;
strcpy(wdate,date);
- if(strstr(wdate,"-") == 0) {
+ if(strchr(wdate,'-') == NULL) {
strcat(wdate,"-");
strcat(wdate,date);
strcpy(date,wdate);
}
-char *subs(char *str, char *from, char *to)
+void subs(char *str, int size, char *from, char *to)
{
char *tmp;
- char *ret;
- unsigned int ss, st;
-
- if(strstr(str,from) == 0)
- return (char *) str;
-
- ss = strlen(str); st = strlen(to) + 10;
+ int i;
+ int ss, st, sf;
+ int len;
+ int shift;
- if((ret=(char *) malloc(ss + st))==NULL)
- {
- fprintf(stderr, "SARG: %s (%d):\n",text[59],ss+st);
- exit(1);
- }
+ tmp = strstr(str, from);
+ if(tmp == NULL)
+ return;
- bzero(ret,ss+st);
+ ss = strlen(str);
+ sf = strlen(from);
+ st = strlen(to);
+ shift=st-sf;
- tmp = strstr(str, from);
- if ( tmp == (char *) NULL )
- return (char *) NULL;
- strncpy(ret, str, ss - strlen(tmp));
- strcat(ret, to);
- strcat(ret, (tmp+strlen(from)));
- return (char *) ret;
+ if (shift>0) {
+ if (ss+shift>=size){
+ fprintf(stderr,"SARG: Cannot replace %s by %s in %s and fit within %d bytes\n",from,to,str,size);
+ exit(1);
+ }
+ for (i=strlen(tmp) ; i>=sf ; i--)
+ tmp[i+shift]=tmp[i];
+ } else if (shift<0) {
+ len=strlen(tmp);
+ for (i=sf ; i<=len ; i++)
+ tmp[i+shift]=tmp[i];
+ }
+ memcpy(tmp, to, st);
+ return;
}
if(strcmp(RemoveTempFiles,"yes") != 0)
return;
-
+
if(debug) {
debuga("%s: sarg-general, sarg-period",text[82]);
}
- sprintf(warea,"%s/sarg-general",outdir);
+ if (snprintf(warea,sizeof(warea),"%s/sarg-general",outdir)>=sizeof(warea)) {
+ fprintf(stderr, "SARG: (removetmp) directory too long to remove: %s/sarg-period\n",outdir);
+ exit(1);
+ }
if((fp_in=fopen(warea,"r"))==NULL){
fprintf(stderr, "===SARG: (removetmp) %s: %s\n",text[45],warea);
exit(1);
exit(1);
}
unlink(warea);
-
+
return;
}
-void load_excludecodes(void)
+void load_excludecodes(const char *ExcludeCodes)
{
FILE *fp_in;
char data[80];
+ int i;
+
+ if(ExcludeCodes[0] == '\0')
+ return;
+
+ if((excludecode=(char *) malloc(1024))==NULL) {
+ fprintf(stderr, "SARG: %s (1024):\n",text[59]);
+ exit(1);
+ }
+ bzero(excludecode,1024);
if((fp_in=fopen(ExcludeCodes,"r"))==NULL) {
fprintf(stderr, "SARG: (util) Cannot open file: %s (exclude_codes)\n",ExcludeCodes);
}
while(fgets(data,sizeof(data),fp_in)!=NULL) {
- data[strlen(data)-1]='\0';
+ for (i=strlen(data)-1 ; i>=0 && (unsigned char)data[i]<=' ' ; i--) data[i]=0;
+ if (i<0) continue;
strcat(excludecode,data);
strcat(excludecode,";");
- excode++;
}
fclose(fp_in);
}
+void free_excludecodes(void)
+{
+ if (excludecode) {
+ free(excludecode);
+ excludecode=NULL;
+ }
+}
+
int vercode(const char *code)
{
- char warea[1024];
- char cod[80];
- int z;
-
- strcpy(warea,excludecode);
- for(z=0; z<=excode-1; z++) {
- if (getword_multisep(cod,sizeof(cod),warea,';')<0) {
- printf("SARG: Maybe you have a broken record or garbage in a version code.\n");
- exit(1);
+ char *cod;
+ int clen;
+
+ if (excludecode && excludecode[0]!=0) {
+ clen=strlen(code);
+ for (cod=excludecode ; cod ; cod=strchr(cod+1,';')) {
+ if (strncmp(code,cod,clen)==0 && cod[clen]==';')
+ return 1;
}
- if(strcmp(code,cod) == 0)
- return 1;
}
return 0;
}
void fixnone(char *str)
{
- char *eol;
+ int i;
- eol=strchr(str,'\n');
- if (eol) *eol=0;
- if(strcmp(str,"none") == 0)
+ for (i=strlen(str)-1 ; i>=0 && (unsigned char)str[i]<=' ' ; i--);
+ if(i==3 && strncmp(str,"none",4) == 0)
str[0]='\0';
return;
}
int getnumlist( char *buf, numlist *list, const int len, const int maxvalue )
-{ int i, j, d, flag, r1, r2;
- char *pbuf, **bp, *strbufs[ 24 ];
-
- bp = strbufs;
- strtok( buf, " \t" );
- for( *bp = strtok( NULL, "," ), list->len = 0; *bp; *bp = strtok( NULL, "," ) )
- { if( ++bp >= &strbufs[ 24 ] )
- break;
- list->len++;
+{
+ int i, j, d, flag, r1, r2;
+ char *pbuf, **bp, *strbufs[ 24 ];
+
+ bp = strbufs;
+ strtok( buf, " \t" );
+ for( *bp = strtok( NULL, "," ), list->len = 0; *bp; *bp = strtok( NULL, "," ) ) {
+ if( ++bp >= &strbufs[ 24 ] )
+ break;
+ list->len++;
}
- if( ! list->len )
- return -1;
- d = 0;
- for( i = 0; i < list->len; i++ )
- { if( strstr( strbufs[ i ], "-" ) != 0 )
- { pbuf = strbufs[ i ];
- strtok( pbuf, "-" );
- pbuf = strtok( NULL, "\0" );
- r1 = atoi( strbufs[ i ] );
- if( ( r2 = atoi( pbuf ) ) >= maxvalue || r1 >= r2 )
- return -1;
- if( i + d + ( r2 - r1 ) + 1 <= len )
- { for( j = r1; j <= r2; j++ )
- list->list[ i + d++ ] = j;
- d--;
+ if( ! list->len )
+ return -1;
+ d = 0;
+ for( i = 0; i < list->len; i++ ) {
+ if( strchr( strbufs[ i ], '-' ) != 0 ) {
+ pbuf = strbufs[ i ];
+ strtok( pbuf, "-" );
+ pbuf = strtok( NULL, "\0" );
+ r1 = atoi( strbufs[ i ] );
+ if( ( r2 = atoi( pbuf ) ) >= maxvalue || r1 >= r2 )
+ return -1;
+ if( i + d + ( r2 - r1 ) + 1 <= len ) {
+ for( j = r1; j <= r2; j++ )
+ list->list[ i + d++ ] = j;
+ d--;
}
}
- else
- if( ( list->list[ i + d ] = atoi( strbufs[ i ] ) ) >= maxvalue )
- return 1;
+ else
+ if( ( list->list[ i + d ] = atoi( strbufs[ i ] ) ) >= maxvalue )
+ return 1;
}
- list->len += d;
- qsort( list->list, list->len, sizeof( int ), compar );
- do
- { flag = 0;
- for( i = 0; i < list->len - 1; i++ )
- if( list->list[ i ] == list->list[ i + 1 ] )
- { for( j = i + 1; j < list->len; j++ )
- list->list[ j - 1 ] = list->list[ j ];
- list->len--;
- flag = 1;
- break;
- }
+ list->len += d;
+ qsort( list->list, list->len, sizeof( int ), compar );
+ do {
+ flag = 0;
+ for( i = 0; i < list->len - 1; i++ )
+ if( list->list[ i ] == list->list[ i + 1 ] ) {
+ for( j = i + 1; j < list->len; j++ )
+ list->list[ j - 1 ] = list->list[ j ];
+ list->len--;
+ flag = 1;
+ break;
+ }
} while( flag );
- return 0;
+ return 0;
}
void show_info(FILE *fp_ou)
{
- if(strcmp(ShowSargInfo,"yes") != 0) return;
- zdate(ftime, DateFormat);
- fprintf(fp_ou,"<center><table><tr><td><br><br></td><td class=\"info\">%s <a href='%s'><font class=\"info\">%s-%s</font></a> %s %s</td></tr></table></center>\n",text[108],URL,PGM,VERSION,text[109],ftime);
+ char ftime[127];
+
+ if(strcmp(ShowSargInfo,"yes") != 0) return;
+ zdate(ftime, DateFormat);
+ fprintf(fp_ou,"<center><table><tr><td><br><br></td><td class=\"info\">%s <a href='%s'><font class=\"info\">%s-%s</font></a> %s %s</td></tr></table></center>\n",text[108],URL,PGM,VERSION,text[109],ftime);
}
void show_sarg(FILE *fp_ou, const char *ind)
}
-void url_module(char *url, char *w2)
+void url_module(const char *url, char *w2)
{
int x, y;
char w[255];
- bzero(w, 255);
- bzero(w2, 255);
y=0;
for(x=strlen(url)-1; x>=0; x--) {
- if(url[x] == '/' || y>255) break;
- w[y]=url[x];
- y++;
+ if(url[x] == '/' || y>=sizeof(w)-1) break;
+ w[y++]=url[x];
}
- y=0;
- for(x=strlen(w)-1; x>=0; x--) {
- w2[y]=w[x];
- y++;
+ x=0;
+ for(y=y-1; y>=0; y--) {
+ w2[x++]=w[y];
}
+ w2[x]=0;
}
projects / thirdparty / sarg.git / commitdiff
