diff --git a/CMakeLists.txt b/CMakeLists.txt index 652d7fa..272d3ec 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,6 +6,7 @@ set(LOGGER_CLASS UnixLogger CACHE STRING "One of UnixLogger, FileLogger or NullL add_executable (hermes ${CMAKE_CURRENT_BINARY_DIR}/Configfile.cpp + ${CMAKE_CURRENT_BINARY_DIR}/Configfile.h src/Exception.cpp src/hermes.cpp src/ServerSocket.cpp @@ -14,7 +15,7 @@ add_executable (hermes src/Proxy.cpp src/Socket.cpp) -option(BUILD_DOC "Build documentation") +option(BUILD_DOCS "Build documentation") if(WIN32) set(SOURCES ${SOURCES} @@ -31,7 +32,7 @@ target_sources(hermes PRIVATE src/${LOGGER_CLASS}.cpp) find_library (SQLITE3_LIBRARY NAMES libsqlite3 sqlite3) # optional dependency libspf2 -find_library (SPF2_LIBRARY NAMES spf2 libspf2) +find_library (SPF2_LIBRARY REQUIRED NAMES spf2 libspf2) if(SPF2_LIB) target_compile_definitions(hermes PRIVATE HAVE_SPF2) target_sources(hermes PRIVATE src/Spf.cpp) @@ -49,26 +50,43 @@ include_directories( ${CMAKE_CURRENT_BINARY_DIR} src) +set(CONFIG_TEMPLATE ${CMAKE_CURRENT_SOURCE_DIR}/src/Configfile.tmpl) + # generation of various files add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Configfile.cpp - COMMAND cpp ${OPT_DEFS} ${CMAKE_CURRENT_SOURCE_DIR}/src/Configfile.tmpl -I - ${CMAKE_CURRENT_BINARY_DIR} | - python ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_config.py - DEPENDS src/Configfile.cpp.in src/Configfile.h.in src/Configfile.tmpl - docs/hermes-options.html.in scripts/generate_config.py) + COMMAND python "${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_config.py" "${CONFIG_TEMPLATE}" + --cpp-template "${CMAKE_CURRENT_SOURCE_DIR}/src/Configfile.cpp.in" + --output-cpp "${CMAKE_CURRENT_BINARY_DIR}/Configfile.cpp" + DEPENDS ${CONFIG_TEMPLATE} src/Configfile.cpp.in) +add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Configfile.h + COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_config.py "${CONFIG_TEMPLATE}" + --h-template "${CMAKE_CURRENT_SOURCE_DIR}/include/Configfile.h.in" + --output-h "${CMAKE_CURRENT_BINARY_DIR}/Configfile.h" + DEPENDS ${CONFIG_TEMPLATE} include/Configfile.h.in) + +# DEPENDS src/Configfile.cpp.in src/Configfile.h.in src/Configfile.tmpl +# docs/hermes-options.html.in scripts/generate_config.py) # doxygen if (BUILD_DOCS) + add_custom_command(OUTPUT docs/hermesrc.example + COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_config.py "${CONFIG_TEMPLATE}" + --output-example "${CMAKE_CURRENT_BINARY_DIR}/docs/hermesrc.example" + DEPENDS ${CONFIG_TEMPLATE}) + add_custom_command(OUTPUT docs/html/hermes-options.html + COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_config.py "${CONFIG_TEMPLATE}" + --html-template "${CMAKE_CURRENT_SOURCE_DIR}/docs/hermes-options.html.in" + --output-html "${CMAKE_CURRENT_BINARY_DIR}/docs/html/hermes-options.html" + DEPENDS ${CONFIG_TEMPLATE} docs/hermes-options.html.in) find_package (Doxygen) - if(DOXYGEN_FOUND) - add_custom_target(doc ALL - doxygen - WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docs) - install( - DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docs/html - TYPE DOC) - endif() + add_custom_target(doc ALL + doxygen "${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile" + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs + DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/docs/html/hermes-options.html" "${CMAKE_CURRENT_BINARY_DIR}/docs/hermesrc.example") + install( + DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html + TYPE DOC) endif() target_link_libraries(hermes diff --git a/src/Configfile.h.in b/include/Configfile.h.in similarity index 100% rename from src/Configfile.h.in rename to include/Configfile.h.in diff --git a/scripts/generate_config.py b/scripts/generate_config.py index fff5597..b864250 100644 --- a/scripts/generate_config.py +++ b/scripts/generate_config.py @@ -1,37 +1,63 @@ #!/usr/bin/env python3 - import sys -import re import string +import argparse +import os def camel_case(str_): """Convert snake_case to CamelCase.""" return string.capwords(str_, "_").replace("_", "") def main(): - # Read input files - with open('../docs/hermes-options.html.in', 'r') as f: - html_templ = f.read() + # Set up argument parser + parser = argparse.ArgumentParser(description='Generate configuration files for Hermes.') + parser.add_argument('input_template', + type=argparse.FileType('r'), + help='Input configuration template file') + parser.add_argument('--html-template', + default='', + help='Path to HTML template input file') + parser.add_argument('--cpp-template', + default='', + help='Path to C++ template input file') + parser.add_argument('--h-template', + default='', + help='Path to header template input file') + parser.add_argument('--output-cpp', + default='', + help='Output path for generated C++ file') + parser.add_argument('--output-h', + default='', + help='Output path for generated header file') + parser.add_argument('--output-example', + default='', + help='Output path for example configuration') + parser.add_argument('--output-html', + default='', + help='Output path for generated HTML documentation') - hvar1 = "" - hvar2 = "" - cppvar1 = "" - cppvar2 = "" - cppvar3 = "" - conf_example = "" - htmlvar = "" + # Parse arguments + args = parser.parse_args() + + hvar1 = [] + hvar2 = [] + cppvar1 = [] + cppvar2 = [] + cppvar3 = [] + conf_example = [] + htmlvar = [] htmlexpl = "" # Process input - for line in sys.stdin: + for line in args.input_template: line = line.strip() if not line or line.startswith('#') or line.startswith('*'): if line == '*clean*': htmlexpl = "" elif line.startswith('*'): - line = line.replace('*', '#') - conf_example += line + "\n" + line = line.replace('*', '#').strip() + conf_example.append(line) # Convert line for HTML line_html = line.lstrip('#').replace('>', '>') @@ -52,61 +78,80 @@ def main(): camel_name = camel_case(var_name) # Generate header variables - hvar1 += f"{type_str} {var_name};\n" - hvar2 += f"{type_str}& get{camel_name}();\n" + hvar1.append(f"{type_str} {var_name};") + hvar2.append(f"{type_str}& get{camel_name}();") # Generate cpp variables if 'list' in type_str: - cppvar1 += f"{var_name} = Configfile::parseAsList({default_val});\n" + cppvar1.append(f"{var_name} = Configfile::parseAsList({default_val});") else: - cppvar1 += f"{var_name} = {default_val};\n" + cppvar1.append(f"{var_name} = {default_val};") - cppvar2 += f"PARSE_{parts[0].upper()}(\"{var_name}\", {var_name})\n" - cppvar3 += f"GET_VAR(get{camel_name}, {var_name}, {type_str}&)\n" + cppvar2.append(f"PARSE_{parts[0].upper()}(\"{var_name}\", {var_name})") + cppvar3.append(f"GET_VAR(get{camel_name}, {var_name}, {type_str}&)") # Generate config example - conf_example += f"{var_name} = {default_val}\n\n" + conf_example.append(f"{var_name} = {default_val}") # Generate HTML - html_temp = html_templ.replace('%type%', parts[0]) \ - .replace('%name%', var_name) \ - .replace('%default%', default_val) \ - .replace('%explanation%', htmlexpl) - htmlvar += html_temp + if args.html_template: + html_templ = open(args.html_template, 'r').read() + html_temp = html_templ.replace('%type%', parts[0]) \ + .replace('%name%', var_name) \ + .replace('%default%', default_val) \ + .replace('%explanation%', htmlexpl) + htmlvar.append(html_temp) htmlexpl = "" - # Clean up variables - for var in [cppvar1, cppvar2, cppvar3, hvar1, hvar2, conf_example]: - var = var.rstrip() + # Convert lists to newline-separated strings + hvar1 = '\n'.join(hvar1) + hvar2 = '\n'.join(hvar2) + cppvar1 = '\n'.join(cppvar1) + cppvar2 = '\n'.join(cppvar2) + cppvar3 = '\n'.join(cppvar3) + conf_example = '\n\n'.join(conf_example) + htmlvar = ''.join(htmlvar) - # Read and write Configfile.cpp - with open('../src/Configfile.cpp.in', 'r') as f: - cpp_str = f.read() + # Write Configfile.cpp + if args.cpp_template and args.output_cpp: + try: + cpp_str = open(args.cpp_template, 'r').read() + cpp_str = cpp_str.replace('%templ_default_values%', cppvar1) \ + .replace('%templ_parsevars%', cppvar2) \ + .replace('%templ_getmethods%', cppvar3) - cpp_str = cpp_str.replace('%templ_default_values%', cppvar1) \ - .replace('%templ_parsevars%', cppvar2) \ - .replace('%templ_getmethods%', cppvar3) + os.makedirs(os.path.dirname(args.output_cpp), exist_ok=True) + with open(args.output_cpp, 'w') as f: + f.write(cpp_str) + except FileNotFoundError: + print(f"Error: C++ template file {args.cpp_template} not found.", file=sys.stderr) + sys.exit(1) - with open('Configfile.cpp', 'w') as f: - f.write(cpp_str) + # Write Configfile.h + if args.h_template and args.output_h: + try: + h_str = open(args.h_template, 'r').read() + h_str = h_str.replace('%templ_privateattribs%', hvar1) \ + .replace('%templ_publicmethods%', hvar2) - # Read and write Configfile.h - with open('../src/Configfile.h.in', 'r') as f: - h_str = f.read() - - h_str = h_str.replace('%templ_privateattribs%', hvar1) \ - .replace('%templ_publicmethods%', hvar2) - - with open('Configfile.h', 'w') as f: - f.write(h_str) + os.makedirs(os.path.dirname(args.output_h), exist_ok=True) + with open(args.output_h, 'w') as f: + f.write(h_str) + except FileNotFoundError: + print(f"Error: Header template file {args.h_template} not found.", file=sys.stderr) + sys.exit(1) # Write hermesrc.example - with open('../dists/hermesrc.example', 'w') as f: - f.write(conf_example) + if args.output_example: + os.makedirs(os.path.dirname(args.output_example), exist_ok=True) + with open(args.output_example, 'w') as f: + f.write(conf_example) # Write hermes-options.html - with open('../docs/hermes-options.html', 'w') as f: - f.write(htmlvar) + if args.output_html and htmlvar: + os.makedirs(os.path.dirname(args.output_html), exist_ok=True) + with open(args.output_html, 'w') as f: + f.write(htmlvar) if __name__ == "__main__": main() diff --git a/src/Configfile.tmpl b/src/Configfile.tmpl index 4cf022c..ef86599 100644 --- a/src/Configfile.tmpl +++ b/src/Configfile.tmpl @@ -9,7 +9,6 @@ * *clean* -#ifndef WIN32 * whether to fork to the background. initscripts require * this to be true most of the time. @@ -35,7 +34,6 @@ string,group,"nobody" * if you set background=true above, this will write the pid * of the forked hermes, not the original. string,pid_file,"/var/run/hermes.pid" -#endif //WIN32 * the port where hermes will listen for new connection. * if you are going to use a port lower than 1024 (almost always, @@ -58,11 +56,7 @@ int,server_port,2525 * database file to use. * if you are chrooting, the path is relative to the chroot: * real filepath = chroot + database_file -#ifdef WIN32 -string,database_file,"greylisting.db" -#else string,database_file,"/var/hermes/greylisting.db" -#endif //WIN32 * whether to use greylisting. * greylisting will slightly delay your emails (configurable, see below) @@ -120,13 +114,6 @@ bool,add_status_header,false * time to delay the initial SMTP banner int,banner_delay_time,5 -#ifdef REALLY_VERBOSE_DEBUG -* email to notify exceptions to. -* CAVEAT: the code that does this is VERY BUGGY and VERY VERBOSE, don't use unless you -* are a developer looking for a bug. -string,notify_to,"" -#endif //REALLY_VERBOSE_DEBUG - * greylisting options. * *clean* @@ -142,56 +129,12 @@ int,initial_blacklist,5 * 36 is a magic number, is the maximum days between a day and the same day next month int,whitelist_expiry,36 -* whether to submit stats. -bool,submit_stats,true - -* should stats be submited using SSL? -* recomended, but some people will compile without ssl. -#ifdef HAVE_SSL -bool,submit_stats_ssl,true -#else -bool,submit_stats_ssl,false -#endif //HAVE_SSL - -* username (used to submit stats). -* you can register on http://www.hermes-project.com -string,submit_stats_username,"anonymous" - -* password -string,submit_stats_password,"anonymous" - * log level: * 0: log only errors * 1: log errors and information (default) * 2: debug (passwords might be written in plaintext with this option, so use with care) int,log_level,1 -#if LOGGER_CLASS==FileLogger -* if you are using the filelogger, which file to log to. -string,file_logger_filename,"hermes.log" - -* whether to keep the logger file locked between writes -bool,keep_file_locked,true - -* frequency for log rotating in minutes -* default is 1440 (1 day) -* 0 means no rotation -int,log_rotation_frequency,1440 - -* format for the logfile rotation -* if you are using logfile rotation, file_logger represents the filename -* to which the logger will write, while this is the name files will get -* when rotated -* you can use the following variables: -* %%year%% - current year (4 digits) -* %%month%% - current month -* %%day%% - current day -* %%hour%% - current hour -* %%minute%% - current minute -* all of them are zero-padded -string,rotate_filename,"hermes-%%year%%-%%month%%-%%day%%-%%hour%%:%%minute%%.log" -#endif //LOGGER_CLASS==FileLogger - * whether to clean the database file and send stats. * if you have two instances of hermes running (for example one for smtp and other for smtps) * you want to configure all of them but one to use clean_db=false. @@ -201,9 +144,7 @@ string,rotate_filename,"hermes-%%year%%-%%month%%-%%day%%-%%hour%%:%%minute%%.lo * will be left hanging around without any use. bool,clean_db,true -#ifdef HAVE_SSL * ssl-related config options -* NOTE: this NEEDS the openssl library * *clean* @@ -235,7 +176,6 @@ string,certificate_file,"/etc/hermes/hermes.cert" * # openssl dhparam -out dhparam.pem * (replace with the number of bits suitable for you, e.G. 1024) string,dhparams_file,"" -#endif //HAVE_SSL * whether to add headers to the email sent or no. * to be rfc compatible this HAS to be true, but if you set to false, no one will know you are using hermes @@ -262,11 +202,7 @@ bool,check_helo_against_reverse,false * whether to query the spf record for the incoming domain. * should help, enable if you have libspf (if you don't, install it and recompile) -#ifdef HAVE_SPF bool,query_spf,true -#else -bool,query_spf,false -#endif //HAVE_SPF * return temporary error instead of permanent error. * Currently, this only applies to SPF and DNSBL rejected email