%% options copyright owner = Dirk Krause copyright year = 2015-xxxx license = bsd %% module #include "dk4conf.h" #if DK4_HAVE_STDLIB_H #include #endif #include "dk4types.h" #include "dk4const.h" #include "dk4dbi.h" #include "dk4dbit8.h" #include "dk4dbitw.h" #include "dk4dbit.h" #include "dk4fput.h" #include "dk4app.h" #include "dk4vers.h" /** Actions the program can perform. */ enum { /** Do nothing (illegal options). */ DKDBT_ACTION_NONE = 0 , /** Copy one database to another. */ DKDBT_ACTION_COPY = 1 , /** Make database from text. */ DKDBT_ACTION_FROM_TEXT = 2 , /** Convert database to text. */ DKDBT_ACTION_TO_TEXT = 3 }; /** License conditions. */ static const dkChar * const dkdbt_license_text[] = { $!text macro=dkT,preprocessor This software uses code from the following projects, either directly or as a library: dktools Dirk Krause's tools and libraries. See http://dktools.sourceforge.net/ for more information. #if DK4_HAVE_ZLIB_H zlib Data compression library. See http://www.zlib.net/ for more information. #endif #if DK4_HAVE_BZLIB_H bzip2 Data compression program and library. See http://www.bzip.org/ for more information. #endif All the licenses below apply to the program. Licenses for used libraries are shown as found on my Scientific Linux 6.x computer in the /usr/share/doc directory on 2015-04-01. Check the project homepages of the used libraries for additional information and/or updated license terms. DK tools and libraries license ============================== Copyright (c) 2015-2016, Dirk Krause All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Dirk Krause nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #if DK4_HAVE_ZLIB_H Zlib license ============ (C) 1995-2004 Jean-loup Gailly and Mark Adler This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean-loup Gailly Mark Adler jloup@gzip.org madler@alumni.caltech.edu #endif #if DK4_HAVE_BZLIB_H Bzip2 and libbzip2 library license ================================== This program, "bzip2", the associated library "libbzip2", and all documentation, are copyright (C) 1996-2007 Julian R Seward. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 3. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 4. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Julian Seward, jseward@bzip.org bzip2/libbzip2 version 1.0.5 of 10 December 2007 #endif $!end }; /** Short help text. */ static const dkChar * const dkdbt_help_text[] = { $!string-table macro=dkT Database tool dkdbt -m [-a] [-c ] [-i ] [] dkdbt -t [] dkdbt [-a] -m Make database from text file(s). -t Show database as text, optionally save to file. Without -m and -t the database is copied. -a Append to existing database when copying or making a database. Without this option an existing database is truncated. -c character Commentar character. Lines started by this character are comments. -i encoding Expected input encoding when making a database from text. --help Show short help text. --manual *** SHOW MANUAL *** --version Show version number. --license Show license information. $!end }; static const dkChar version_text[] = { DKT_VERSION_DK #if DK4_HAVE_DB_H dkT(" bdb") #endif #if DK4_HAVE_NDBM_H dkT(" ndbm") #endif dkT(" mem") }; /** Constant keywords, not localized. */ static const dkChar * const dkdbt_kwnl[] = { $!string-table macro=dkT # # 0, 1, 2 Program group name, manual text, string table # dktools dkdbt.txt dkdbt.str $!end }; /** Keywords, replaced by localized text. */ static const dkChar * const dkdbt_kw_def[] = { $!string-table macro=dkT # # 0 Error message: Failed to set up signal handlers! # Failed to set up signal handlers! # # 1 Error message: Failed to restore previous signal handlers! # Failed to restore previous signal handlers! $!end }; /** Command line options. */ static const dk4_option_specification_t dkdbt_options[] = { { dkT('m'), dkT("make"), DK4_OPT_ARG_NONE }, { dkT('t'), dkT("text"), DK4_OPT_ARG_NONE }, { dkT('a'), dkT("append"), DK4_OPT_ARG_NONE }, { dkT('c'), dkT("comment"), DK4_OPT_ARG_STRING }, { dkT('i'), dkT("input-encoding"), DK4_OPT_ARG_STRING } }; /** Application structure. */ static dk4_app_t *app = NULL; /** Pointer to localized messages array. */ static const dkChar * const *dkdbt_msg = dkdbt_kw_def; /** Number of options in the dkdbt_options array. */ static const size_t dkdbt_sz_options = sizeof(dkdbt_options)/sizeof(dk4_option_specification_t); /** Number of keywords in the dkdbt_msg array. */ static size_t dkdbt_sz_msg = (sizeof(dkdbt_kw_def)/sizeof(DK4_PDKCHAR) - 1); /** Maximum key size (0 = unlimited). */ static size_t keymax = 4096; /** Maximum value size (0 = unlimited). */ static size_t valmax = 4096; /** Exit status code. */ static int exval = EXIT_FAILURE; /** Action to execute. */ static int action = DKDBT_ACTION_COPY; /** Expected input encoding on stdin. */ static int input_enc_s = DK4_FILE_ENCODING_ASCII; /** Expected input encoding on input files. */ static int input_enc_f = DK4_FILE_ENCODING_ASCII; /** Flag: Append instead of truncate. */ static int append = 0; #ifdef SIGPIPE /** Indicator: SIGPIPE signal received. */ static DK4_VOLATILE dk4_sig_atomic_t sig_had_pipe = 0; #endif /** Indicator: SIGINT signal received. */ static DK4_VOLATILE dk4_sig_atomic_t sig_had_int = 0; /** Indicator: SIGTERM signal received. */ static DK4_VOLATILE dk4_sig_atomic_t sig_had_term = 0; /** Pass a volatile pointer to an atomic integer. This function is necessary as some compilers mis-optimize direct access to volatile variables (at least if you believe one of the coding standards). @param ptr Address of atomic integer variable. @return The unmodified pointer. */ static DK4_VOLATILE dk4_sig_atomic_t * sig_pass_pointer(DK4_VOLATILE dk4_sig_atomic_t *ptr) { return ptr; } #ifdef SIGPIPE /** Handler for SIGPIPE signal. @param signo Signal number (always SIGPIPE, ignored). */ static void sig_handler_pipe(int signo) { *sig_pass_pointer(&sig_had_pipe) = 1; } #endif /** Handler for SIGINT signal. @param signo Signal number (always SIGINT, ignored). */ static void sig_handler_int(int signo) { *sig_pass_pointer(&sig_had_int) = 1; } /** Handler for SIGTERM signal. @param signo Signal number (always SIGTERM, ignored). */ static void sig_handler_term(int signo) { *sig_pass_pointer(&sig_had_term) = 1; } /** Read value from volatile atomic type. This function is necessary as some compilers mis-optimize direct access to volatile variables (at least if you believe one of the coding standards). @param ap Pointer to volatile atomic variable. @return Contents of the variable. */ static dk4_sig_atomic_t sig_read_atomic(DK4_VOLATILE dk4_sig_atomic_t *ap) { return (*ap); } /** Check whether we can continue or if a signal was received. @param check_pipe Flag: Check for occured SIGPIPE signal too. @return 1 if the program can continue, 0 if a signal was received. */ static int sig_can_continue(int check_pipe) { int back = 1; #ifdef SIGPIPE if (0 != check_pipe) { if (0 != sig_read_atomic(&sig_had_pipe)) { back = 0; } } #endif if (0 != sig_read_atomic(&sig_had_int )) { back = 0; } if (0 != sig_read_atomic(&sig_had_term)) { back = 0; } return back; } /** Check whether we can continue. @return 1 for yes, 0 for no. */ static int dkdbt_can_continue(void) { int back = 1; if (0 == sig_can_continue(1)) { back = 0; } return back; } static void dkdbt_copy_databases(void) { /* ##### */ } static void dkdbt_make_database(void) { /* ##### */ } static void dkdbt_show_database(void) { dk4_er_t er; dk4_dbi_t *dbi; const dkChar *fn; int argc; argc = dk4app_get_argc(app); if (0 < argc) { if (3 > argc) { fn = dk4app_get_argv(app, 0); if (NULL != fn) { dk4error_init(&er); dbi = dk4dbi_open(fn, 0, 0, keymax, valmax, &er); if (NULL != dbi) { dk4dbi_close(dbi, &er); } } else { /* ##### ERROR: Bug */ exval = EXIT_FAILURE; } } else { /* ##### ERROR: Too many file names */ exval = EXIT_FAILURE; } } else { /* ##### ERROR: At least one file name required */ exval = EXIT_FAILURE; } } /** Run with signal handlers installed. */ static void dkdbt_normal_run(void) { dkChar buf[32]; const size_t szbuf = DK4_SIZEOF(buf,dkChar); int bom = 0; if (0 != dk4app_opt_is_set_short(app, dkT('m'), NULL)) { if (0 != dk4app_opt_is_set_short(app, dkT('t'), NULL)) { action = DKDBT_ACTION_NONE; exval = EXIT_FAILURE; /* ##### ERROR: Illegal option combination */ } else { action = DKDBT_ACTION_FROM_TEXT; if (0 != dk4app_opt_is_set_short(app, dkT('a'), NULL)) { append = 1; } if (0 != dk4app_opt_is_set_short(app, dkT('i'), NULL)) { if (0 != dk4app_opt_get_string_short(buf,sz_buf,app,dkT('i'),NULL)) { if (0 != dk4enc_find(&input_enc_s, &bom, buf, NULL)) { input_enc_f = input_enc_s; } else { /* ##### ERROR: Illegal input encoding */ exit = EXIT_FAILURE; } } } } } else { if (0 != dk4app_opt_is_set_short(app, dkT('t'), NULL)) { action = DKDBT_ACTION_TO_TEXT; } else { if (0 != dk4app_opt_is_set_short(app, dkT('a'), NULL)) { append = 1; } } } if (EXIT_SUCCESS == exval) { switch (action) { case DKDBT_ACTION_COPY : { dkdbt_copy_databases(); } break; case DKDBT_ACTION_FROM_TEXT : { dkdbt_make_database(); } break; case DKDBT_ACTION_TO_TEXT : { dkdbt_show_database(); } break; } } } #if DK4_HAVE_SIGACTION /** Set signal handlers and run. */ static void dkdbt_run_with_signal_handlers(void) { #ifdef SIGPIPE struct sigaction opipe; #endif struct sigaction oint; #ifdef SIGPIPE struct sigaction npipe; #endif struct sigaction nint; struct sigaction oterm; struct sigaction nterm; int success = 0; #ifdef SIGPIPE /* Set up signal handling for SIGPIPE. */ npipe.sa_handler = sig_handler_pipe; npipe.sa_flags = 0; if (0 != sigemptyset(&npipe.sa_mask)) { /* ERROR: Failed to set up masked signal set for SIGPIPE */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto finished; } if (0 != sigaddset(&npipe.sa_mask, SIGPIPE)) { /* ERROR: Failed to set up masked signal set for SIGPIPE */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto finished; } if (0 != sigaction(SIGPIPE, &npipe, &opipe)) { /* ERROR: Failed to set up signal handler for SIGPIPE */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto finished; } #endif /* Set up signal handling for SIGINT. */ nint.sa_handler = sig_handler_int; nint.sa_flags = 0; if (0 != sigemptyset(&nint.sa_mask)) { /* ERROR: Failed to set up masked signal set for SIGINT */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_pipe; } if (0 != sigaddset(&nint.sa_mask, SIGINT)) { /* ERROR: Failed to set up masked signal set for SIGINT */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_pipe; } if (0 != sigaction(SIGINT, &nint, &oint)) { /* ERROR: Failed to set up signal handler for SIGINT */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_pipe; } /* Set up signal handling for SIGTERM */ nterm.sa_handler = sig_handler_term; nterm.sa_flags = 0; if (0 != sigemptyset(&nterm.sa_mask)) { /* ERROR: Failed to set up masked signal set for SIGTERM */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_int; } if (0 != sigaddset(&nterm.sa_mask, SIGTERM)) { /* ERROR: Failed to set up masked signal set for SIGTERM */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_int; } if (0 != sigaction(SIGTERM, &nterm, &oterm)) { /* ERROR: Failed to set up signal handler for SIGTERM */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 0); goto restore_old_int; } success = 1; dkdbt_normal_run(); /* Restore signal handling for SIGTERM. */ if (0 != sigaction(SIGTERM, &oterm, NULL)) { /* ERROR: Failed to restore old SIGTERM settings */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 1); success = 0; } /* Restore signal handling for SIGINT. */ restore_old_int: if (0 != sigaction(SIGINT, &oint, NULL)) { /* ERROR: Failed to restore old SIGPIPE settings */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 1); success = 0; } #ifdef SIGPIPE /* Restore signal handling for SIGPIPE. */ restore_old_pipe: if (0 != sigaction(SIGPIPE, &opipe, NULL)) { /* ERROR: Failed to restore old SIGPIPE settings */ dk4app_log_1(app, dkdbt_msg, dkdbt_sz_msg, DK4_LL_ERROR, 1); success = 0; } #endif /* Set exit status code if error occured. */ finished: if (0 == success) { exval = EXIT_FAILURE; } } #else #if DK4_HAVE_SIGSET /** Set signal handlers and run. */ static void dkdbt_run_with_signal_handlers(void) { #ifdef SIGPIPE dk4_sig_handler_t *oldpipe = NULL; #endif dk4_sig_handler_t *oldint = NULL; dk4_sig_handler_t *oldterm = NULL; #ifdef SIGPIPE oldpipe = sigset(SIGPIPE, sig_handler_pipe); #endif oldint = sigset(SIGINT, sig_handler_int); oldterm = sigset(SIGTERM, sig_handler_term); dkdbt_normal_run(); sigset(SIGTERM, oldterm); sigset(SIGINT, oldint); #ifdef SIGPIPE sigset(SIGPIPE, oldpipe); #endif } #else #if DK4_HAVE_SIGNAL /** Set signal handlers and run. */ static void dkdbt_run_with_signal_handlers(void) { #ifdef SIGPIPE dk4_sig_handler_t *oldpipe = NULL; #endif dk4_sig_handler_t *oldint = NULL; dk4_sig_handler_t *oldterm = NULL; #ifdef SIGPIPE oldpipe = signal(SIGPIPE, sig_handler_pipe); #endif oldint = signal(SIGINT, sig_handler_int); oldterm = signal(SIGTERM, sig_handler_term); dkdbt_normal_run(); signal(SIGTERM, oldterm); signal(SIGINT, oldint); #ifdef SIGPIPE signal(SIGPIPE, oldpipe); #endif } #else /** Set signal handlers and run. */ static void dkdbt_run_with_signal_handlers(void) { dkdbt_normal_run(); } #endif #endif #endif /** Main function. @param argc Number of command line arguments. @param argv Command line arguments array. @return 0 on success, all other values indicate errors. */ #if DK4_CHAR_SIZE > 1 int wmain(int argc, wchar_t *argv[]) #else int main(int argc, char *argv[]) #endif { dk4_sig_atomic_t shp = 0; $!trace-init dkdbt.deb $? "+ main" dk4fput_initialize_stdout(); dk4fput_initialize_stderr(); app = dk4app_open_cmd( argc, argv, dkdbt_options, dkdbt_sz_options, dkdbt_kwnl[0], version_text, dkdbt_kwnl[1], dkdbt_help_text, dkdbt_license_text ); if (NULL != app) { dkdbt_sz_msg = dk4app_string_table_size(dkdbt_kw_def); dkdbt_msg = dk4app_string_table(app, dkdbt_kwnl[2], dkdbt_kw_def); if (0 != dk4app_can_run_normally(app)) { exval = EXIT_SUCCESS; dkdbt_run_with_signal_handlers(); #ifdef SIGPIPE shp = sig_read_atomic(&sig_had_pipe); #endif if (0 != shp) { $? "! writing to pipe failed" /* ##### ERROR: Writing to pipe failed */ } if (0 != sig_read_atomic(&sig_had_int)) { $? "! interrupted" /* ##### ERROR: Interrupted */ } } else { if (0 != dk4app_help_version_license(app)) { exval = EXIT_SUCCESS; } } dk4app_close(app); app = NULL; } fflush(stdout); fflush(stderr); dk4fput_cleanup_stderr(); dk4fput_cleanup_stdout(); $? "- main %d", exval $!trace-end exit(exval); return exval; }