From c64ab570a19423c51b6b8b5937fc8e6d08f63821 Mon Sep 17 00:00:00 2001 From: Christof Donat Date: Tue, 24 Apr 2012 15:15:42 +0000 Subject: [PATCH] added more or less resurrected C++ cli client. This will need a lot of work. please note, that I would do quite some things differently nowadays. I home to get those things in via refactoring --- hsacppcli/Makefile | 70 + hsacppcli/hsadminc/CMakeLists.txt | 129 ++ hsacppcli/hsadminc/doc/Doxyfile.in | 1679 +++++++++++++++++ hsacppcli/hsadminc/doc/logo.png | Bin 0 -> 7619 bytes hsacppcli/hsadminc/source/CMakeLists.txt | 11 + .../hsadminc/source/abstractcmdlineparser.cpp | 22 + .../hsadminc/source/abstractcmdlineparser.h | 417 ++++ hsacppcli/hsadminc/source/cmdlineparser.cpp | 772 ++++++++ hsacppcli/hsadminc/source/cmdlineparser.h | 386 ++++ hsacppcli/hsadminc/source/configfile.cpp | 257 +++ hsacppcli/hsadminc/source/configfile.h | 94 + hsacppcli/hsadminc/source/hsadminc.cpp | 155 ++ hsacppcli/hsadminc/source/httpclient.cpp | 146 ++ hsacppcli/hsadminc/source/httpclient.h | 163 ++ hsacppcli/hsadminc/source/logger.cpp | 136 ++ hsacppcli/hsadminc/source/logger.h | 68 + hsacppcli/hsadminc/source/sslclient.cpp | 171 ++ hsacppcli/hsadminc/source/sslclient.h | 73 + hsacppcli/hsadminc/source/transaction.cpp | 502 +++++ hsacppcli/hsadminc/source/transaction.h | 77 + hsacppcli/hsadminc/source/xmlparser.cpp | 209 ++ hsacppcli/hsadminc/source/xmlparser.h | 296 +++ 22 files changed, 5833 insertions(+) create mode 100644 hsacppcli/Makefile create mode 100644 hsacppcli/hsadminc/CMakeLists.txt create mode 100644 hsacppcli/hsadminc/doc/Doxyfile.in create mode 100644 hsacppcli/hsadminc/doc/logo.png create mode 100644 hsacppcli/hsadminc/source/CMakeLists.txt create mode 100644 hsacppcli/hsadminc/source/abstractcmdlineparser.cpp create mode 100644 hsacppcli/hsadminc/source/abstractcmdlineparser.h create mode 100644 hsacppcli/hsadminc/source/cmdlineparser.cpp create mode 100644 hsacppcli/hsadminc/source/cmdlineparser.h create mode 100644 hsacppcli/hsadminc/source/configfile.cpp create mode 100644 hsacppcli/hsadminc/source/configfile.h create mode 100644 hsacppcli/hsadminc/source/hsadminc.cpp create mode 100644 hsacppcli/hsadminc/source/httpclient.cpp create mode 100644 hsacppcli/hsadminc/source/httpclient.h create mode 100644 hsacppcli/hsadminc/source/logger.cpp create mode 100644 hsacppcli/hsadminc/source/logger.h create mode 100644 hsacppcli/hsadminc/source/sslclient.cpp create mode 100644 hsacppcli/hsadminc/source/sslclient.h create mode 100644 hsacppcli/hsadminc/source/transaction.cpp create mode 100644 hsacppcli/hsadminc/source/transaction.h create mode 100644 hsacppcli/hsadminc/source/xmlparser.cpp create mode 100644 hsacppcli/hsadminc/source/xmlparser.h diff --git a/hsacppcli/Makefile b/hsacppcli/Makefile new file mode 100644 index 0000000..0761760 --- /dev/null +++ b/hsacppcli/Makefile @@ -0,0 +1,70 @@ +# +# (c) okunah gmbh +# +# name: Makefile +# +# description: description +# +# written by: Christof Donat +# +# changes: +# 05.11.11 (Christof Donat): created this file +# + + +# +# includes +# + +# +# defines +# + +# +# rules +# + +all: release + +debug-test: debug + cd build/Debug; make test + +debug: debug-env + cd build/Debug; make + +debug-dir: + if [ ! -d build/Debug ]; then mkdir -p build/Debug; fi + +debug-env: debug-dir + cd build/Debug; cmake -DCMAKE_BUILD_TYPE="Debug" ../../hsadminc/ + +test: release + cd build/Release; make test + +release: release-env + cd build/Release; make + +release-env: release-dir + cd build/Release; cmake -DCMAKE_BUILD_TYPE="Release" ../../hsadminc/ + +release-dir: + if [ ! -d build/Release ]; then mkdir -p build/Release; fi + +small-test: small + cd build/MinSizeRel; make test + +small: small-env + cd build/MinSizeRel; make + +small-env: small-dir + cd build/MinSizeRel; cmake -DCMAKE_BUILD_TYPE="MinSizeRel" ../../hsadminc/ + +small-dir: + if [ ! -d build/MinSizeRel ]; then mkdir -p build/MinSizeRel; fi + +clean: + rm -rf build + +# end Makefile + + diff --git a/hsacppcli/hsadminc/CMakeLists.txt b/hsacppcli/hsadminc/CMakeLists.txt new file mode 100644 index 0000000..153d33e --- /dev/null +++ b/hsacppcli/hsadminc/CMakeLists.txt @@ -0,0 +1,129 @@ +PROJECT( hsadminc ) +CMAKE_MINIMUM_REQUIRED( VERSION 2.6 ) + +# +# look for packages needed for the build to succeed +# + +# find boost libraries +SET(Boost_USE_MULTITHREADED ON) +SET(Boost_USE_STATIC_RUNTIME OFF) +FIND_PACKAGE( Boost 1.44 REQUIRED COMPONENTS date_time filesystem iostreams regex system unit_test_framework thread ) + +# find doxygen +FIND_PACKAGE( Doxygen 1.7.3 ) + +# find GnuTLS +FIND_PACKAGE( GnuTLS 2.8.6 REQUIRED ) + + +# +# set compiler and linker flags +# + +# compiler +SET( CMAKE_CXX_FLAGS_DEBUG "-g3 -O0" ) +SET( CMAKE_CXX_FLAGS_RELEASE "-O3" ) +SET( CMAKE_CXX_FLAGS_RELWITHDEBINFO "-g3 -O3" ) +SET( CMAKE_CXX_FLAGS_MINSIZEREL "-Os" ) + +# gcc specific +IF( CMAKE_COMPILER_IS_GNUCC ) + SET( CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wold-style-cast -pedantic -Wall -Wextra -Winit-self -Wshadow -Wconversion -Wlogical-op -Wnormalized=nfc -Winline -std=c++0x" ) + SET( CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -std=c++0x" ) + SET( CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -std=c++0x" ) + SET( CMAKE_CXX_FLAGS_MINSIZEREL "${CMAKE_CXX_FLAGS_MINSIZEREL} -std=c++0x" ) +ENDIF() + +#linker +SET( CMAKE_LINK_FLAGS_DEBUG "-g -O0" ) +SET( CMAKE_LINK_FLAGS_RELEASE "-O3" ) +SET( CMAKE_LINK_FLAGS_RELWITHDEBINFO "-g -O3" ) +SET( CMAKE_LINK_FLAGS_MINSIZEREL "-O3" ) + +# GNU ld specific +IF( CMAKE_COMPILER_IS_GNUCC ) + SET( CMAKE_LINK_FLAGS_DEBUG "${CMAKE_LINK_FLAGS_RELEASE} --relax" ) + SET( CMAKE_LINK_FLAGS_RELEASE "${CMAKE_LINK_FLAGS_RELEASE} --relax" ) + SET( CMAKE_LINK_FLAGS_RELWITHDEBINFO "${CMAKE_LINK_FLAGS_RELWITHDEBINFO} --relax" ) + SET( CMAKE_LINK_FLAGS_MINSIZEREL "${CMAKE_LINK_FLAGS_MINSIZEREL} -s --gc-sections --relax" ) +ENDIF() + +# build the release as default +SET( CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS_RELEASE} ) +SET( CMAKE_LINK_FLAGS ${CMAKE_LINK_FLAGS_RELEASE} ) + +# make sure the boost include files are available +INCLUDE_DIRECTORIES( ${Boost_INCLUDE_DIRS} ) +# all libs that will be linked to hsadminc +SET( HSADMINC_LIB ${Boost_LIBRARIES} gnutls ) + +# now this is where the source is +ADD_SUBDIRECTORY( source ) + +# packaging +IF( ${UNIX} ) + SET( CPACK_GNERATOR "DEB;RPM;" ) + SET( CPACK_PACKAGE_DESCRIPTION "hsadmin command line client" ) + SET( CPACK_PACKAGE_DESCRIPTION_SUMMARY "a command line tool to access servers of the configuration tool hsadmin developed by Hostsharing e.G." ) + SET( CPACK_PACKAGE_NAME "hsadminc" ) + + SET( CPACK_DEBIAN_PACKAGE_DEPENDS "boost (>= 1.44), gnutls (>= 2.8.6)" ) + SET( CPACK_PACKAGE_CONTACT "Christof Donat" ) + SET( CPACK_PACKAGE_VENDOR "Hostsharing e.G." ) + SET( CPACK_PACKAGE_VERSION_MAJOR "0" ) + SET( CPACK_PACKAGE_VERSION_MINOR "0" ) + SET( CPACK_PACKAGE_VERSION_PATCH "1" ) + SET( VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}" ) +ENDIF() + +# currently WIN32 is not supported +#IF( ${WIN32} ) +# SET( CPACK_GNERATOR "NSIS;" ) +# SET( CPACK_NSIS_MUI_ICON "" ) +# SET( CPACK_NSIS_MUI_UNIICON "" ) +# SET( CPACK_PACKAGE_ICON "" ) +# SET( CPACK_NSIS_EXTRA_INSTALL_COMMANDS "" ) +# SET( CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS "" ) +# SET( CPACK_NSIS_COMPRESSOR "" ) +# SET( CPACK_NSIS_MODIFY_PATH "" ) +# SET( CPACK_NSIS_DISPLAY_NAME "" ) +# SET( CPACK_NSIS_INSTALLED_ICON_NAME "" ) +# SET( CPACK_NSIS_HELP_LINK "" ) +# SET( CPACK_NSIS_URL_INFO_ABOUT "" ) +# SET( CPACK_NSIS_CONTACT "" ) +# SET( CPACK_NSIS_CREATE_ICONS_EXTRA "" ) +# SET( CPACK_NSIS_DELETE_ICONS_EXTRA "" ) +# SET( CPACK_NSIS_MENU_LINKS "" ) +# SET( CPACK_NSIS_MUI_FINISHPAGE_RUN "" ) +#ENDIF() + +# currently OSX is not supported +#IF( ${APPLE} ) +# SET( CPACK_GNERATOR "MACOSX_BUNDLE;" ) +# SET( CPACK_PACKAGE_FILE_NAME "" ) +# SET( CPACK_PACKAGE_ICON "" ) +# SET( CPACK_BUNDLE_NAME "" ) +# SET( CPACK_BUNDLE_ICON "" ) +# SET( CPACK_BUNDLE_PLIST "" ) +# SET( CPACK_BUNDLE_STARTUP_COMMAND "" ) +#ENDIF() + + +# +# doxygen documentation +# + +CONFIGURE_FILE( doc/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ) +ADD_CUSTOM_TARGET( doxygen ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ) +SET_PROPERTY( DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CKEAN_FILES doc ) +GET_TARGET_PROPERTY( DOC_TARGET doc TYPE ) +IF( NOT DOC_TARGET ) + ADD_CUSTOM_TARGET( doc ) +ENDIF() + +ADD_DEPENDENCIES( doc doxygen ) + +SET( DOC_PATH "share/doc/${CPACK_PACKAGE_NAME}-${VERSION}" ) +INSTALL( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc/html DESTINATION DOC_PATH ) + diff --git a/hsacppcli/hsadminc/doc/Doxyfile.in b/hsacppcli/hsadminc/doc/Doxyfile.in new file mode 100644 index 0000000..332f8d8 --- /dev/null +++ b/hsacppcli/hsadminc/doc/Doxyfile.in @@ -0,0 +1,1679 @@ +# Doxyfile 1.7.3 + +# 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 = ${CPACK_PACKAGE_NAME} + +# 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 = ${VERSION} + +# Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = ${CPACK_PACKAGE_DESCRIPTION} + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = ${CMAKE_CURRENT_SOURCE_DIR}/doc/logo.png + +# 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 = doc + +# 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, Esperanto, 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, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +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 = YES + +# 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 if your file system +# 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 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 = 8 + +# 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 = NO + +# 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 + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# 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 makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# 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 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 = NO + +# 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 + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# 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 = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# 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 = NO + +# 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 namespaces 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 FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# 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 = NO + +# 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 = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# 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 + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = 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 macro 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 macros 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 , where is the value of +# the FILE_VERSION_FILTER tag, and 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 = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# 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 + +# The WARN_NO_PARAMDOC option can be enabled 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 = NO + +# 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 = + +#--------------------------------------------------------------------------- +# 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 = ${CMAKE_CURRENT_SOURCE_DIR}/source + +# 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++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = + +# 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 = ${CMAKE_CURRENT_SOURCE_DIR}/source/test + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix file system 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 , where +# is the value of the INPUT_FILTER tag, and 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 or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +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 + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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 = NO + +# 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 documentation. + +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 = YES + +# 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 = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the stylesheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = NO + +# 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 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_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. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +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 + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# 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_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 + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# 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 [0,1..20]) +# that doxygen will group on one line in the generated HTML documentation. +# Note that a value of 0 will completely suppress the enum values from appearing in the overview section. + +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 YES, 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 (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# 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 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# 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 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# 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. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +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, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# 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 + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = 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 that overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these 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 also works with HAVE_DOT disabled, but 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 = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will write a font called Helvetica to the output +# directory and reference it in all dot files that doxygen generates. +# When you want a differently looking font you can specify the font name +# using DOT_FONTNAME. You 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 = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# 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 = YES + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# 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 generate a 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, svg, gif or svg. +# 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 MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_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 disabled by default, because dot on Windows does not +# seem to support this out of the box. 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 = NO + +# 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 = YES + +# 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 diff --git a/hsacppcli/hsadminc/doc/logo.png b/hsacppcli/hsadminc/doc/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..09c524dfbc6fe54766599e97136bf28e4c3b905b GIT binary patch literal 7619 zcmV;!9X#TRP)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01nFl01nFm_M00007bV*G`2ipq; z5+WHWSRRo803Aa~L_t(|+U=cpd{ssEz`t|veLX!SKnf-F61t!Q0s>ML1X)o~SqrS9 zva789=c2eO>Z%~3i&(IC1r!xqG|skuu2=>8Qd2h5;fn`4RZ-gE%`c zmSGACp)guq##Q=inj43hE%#xz+=s>f$A~xFAstQz{J=7~H8046*(@~->cPICa>|zqy z`BpME7&^6z#CkFe#cAY4J3zA4__jC|q{M zq^0vP{?oTXgaBmT47_NLRn#=GcS=oE_t-jsWDr@92sNlbCwfbr@=UY9PVRJeYg ziv>j4t=KH`d0Dsm2`&^_BB!7{I1gtr(b9QPCk^P@ESXR58$`^gS(JPHzg_0=1^CO5 z4%{)QE$tfB3A?pDr-*iUe}t<3`WnO;teT*&zMd3H&}(6i5}{CzBY4Bl)5MB`iEq1+odYv%qnnB%Fj zJ$Yq(Z^}IZT2FWn>8h6y!)DO$k$KEny${vnKQH4yBQMrP+OCt{J0_y>g$@S|bR?dU zujFC%vnti<1n>i+weNXN9t^0b>_4FCB*r@E)Fc^z-T5W#&n*V)323Mq>GfjCs2hVM z39=8DaUic4EOPiHYdW#fb~qLP8dk&Y9og2iVnix(`j>c}0*?r&`na%2wQ8$K_JMt+k@qhrEMJ74c&iN6XloTLOv{hC}bpjky1+&dgn%&G5&+GW(YV2*Kj@2UxszAJ{DCg?CSz zK_o*Xox+peKTJGstko?I-jjQBy}q2rdO@umq6uiI7veHXsTB58j-hpW0vo4YOIl(S z00pHUZlCoXpMJj^WGS?eqx!Vu#c`LA7;Uy$T;b!sw^s7nx7)(oYnaIA4-BG3YJBM0 znq5a2@Yt7>lzSQ4ErXBm8Hmj)bN^MHxPN#jzF4!5;ZJ{4ZGm;h^l!~`H+82@j3XrN zW-iR)_E)~Efy1p=v}5LNy+hCK$Sa}so$rO)I{}SNFI`8gv;-_cV)FP^9(s2b(?0#F zidX_F69#9JQ7@J?yN~eH4HqK>be#ARg~e__&@rP9%b&OkG5n=4qMUGfJFe~7jOXTU zWa`a5f;_3SY5y_0{Qcvg%_%}S&bYNVcMQ%X`*11gNzr(GD!O6t?WPf1UnN%8 zfh73i$GzCEcmcnvbK~^I$o-yU_~b9b#uVeSao_Mx?8qxY40#bTa4Hwx|0y#UY^@cC zXa0OK8MnTT7&wjFW-g;uT0BqQa1r3Sq z;b4H>s&IMdhD;pVf!+_#A!hU}Htj165!uOXAFD+sEisDgdo?HF`d1M{US#@Lo9Wyn ziN6hLXBvq?DbTS=GItElr0=A;G`apYI^O*e(GCk!K3m7g$zRsGyW4FF@7~=Xw=aP6 znwf|JQ+adAc4klLOI(yaghQ0wLbLj@c>Nk#+YVJxq;8lFnd2Yb_-!+Yh9F>^T;Oby z8rGB&hQ@Z$i1C(j1cX$(T5f=iz-f(P?&@sj{+JDR3!Anb;)CyZ(J(ohD7z)3%TB$e zC%f}Y_~$1-fmH^Z!hNrP&(1?7OdQ%F%vBuiv~Z-vVlFE7-UJpVO7X2tN@Q6tO{#(9AepLXu{qaNU3?mEE!|;Cy|nlm_Ke-CaK#f}v3yew<&}QZUOP>F{r;x-bDWgPyJHlXb8Nzp7UeiB)0s&Li|}of0<5vlnmY>WiCF@WEdg_tH}4 zuGx3SXP3q0Ufx^2lZUVFLi1O~FlPFla?4=(}ih~ zX_ORA-}Y&=NQn!1cI?)gOLnxx&B225aQoymVOvhsSPPDrc8b%cRLz}$BPAXZqwPf5 zEfkh|5Ycwh5~EnLEgx0WYqeKerNsg8_~;8mmu(gq0d#9#FLX8&&~z%j0UQ>kihK-% zft?y~bKh2oVB1GZ+D@N<%>3;VOq#utYo1+1na9u87e=#i@|849imvtXic@)G z41-vgl?9WAu=C~XxccIz#JX(gKQpFEpGx2?ch|C0xqdA&vzKgVZ+@!VL#mxA$nssQ3Ccj+DA-o)Txyi(!B)F?Q;= zNCT(QZ2Y^peJbY*lrv$FZ{)5NsvlFws0hVcDF%EmHv?pz3cSG;`Z`=jpqk`?BgF6z z%e72XhOkL*#4Pm{tcJmEk-$GKBLE-2IB-#zzUN(e#l$!*SY*kRB0;DV<6zgJlJK3~ zs_@h9ql|oZA*r)h@a037^UhuU=rr*o3d+1EVE;4zYP*F`R_tQ#>TFu4C-D7~!*E`#BX_FvxK>+*odCKZ^f7>Bql|a_vuJG` zWU1VV%d8Lch1`K#EVol39A|J6bIQ{==B~-6Q${k$vCfcz=dj8Q?%a@t>kn3WyP)cH zSvSbbFXh&MFC#563g-z%r`sPODaK){1t%Db)yEVFXl&Y%&ogs2(4ldivtE>pdNBa3 z+go7vDG9nYt9$;aL!YzXie@K#_3U2Rj?C+ac5GCpW`oI~ub3XgucmeH5A;NyD-@XEq0R88mB0d3F? zgQ;I`4D-RiIPMbmkv7G6{OdR;_e~s`SgdqXN|`C>_W!$f$3v=^4Y4r^l6($kJk0iAC>4j zoAwp*%5A;LK2nANj#YU1dffr$uF9_UmE2<$%v`XQnYZ<(MM@m&vkQoE+8EFwo%`PY zft@);LD473$t&i@7Z&sG-ThekG2NOPMZsVcrHhWh8M^-&Wkzw-rC^$mg<0zTn_%e?BkF z(IPE@v^r5pLXa8^yXoJd0pt3&;nIK1W$EVJ8cqpAHyA%-F}w3idE&Zm*sThNVX!Ty zh-2m6aAL74y#M_!*6uyR2NN&jwt;QK=6A`KT)sI$`u}Re^K25PBtvJq`UY2P8~KNF zC3mXd;1Z`7=kt_2j8~QZXC^sx!;FNrDk0s~^bV-tQ%(14^#w8v@B~afRu<;p4r@)% zk~aXdAS%W|g(qP4;jq*^6;^f7bzZyG#g3O2~fE;Zn)@jAB>Qoe0n*G_7^THr!l`y3XiN7mjm?igPr${A1td^RcxmqO&h_=_NQq{UJLV(j+C6ZmX+S|38L{M?uJ9e_?6bTGLX{E2`B30|F z%MI!*7 zP_E`8eHX2byihi7Xr~E!0s=ztj@+HiqUjl{SHH-!bxw4*(|GQ`v54n8xKNmmf`U>H zPhNK+W$pk)6<$&kUHsplI+L2{;?-}rg-f(^fyZwss8am$%8CXca2j5&($_FdTSIF- zmt<7jz)|7iKT;<1<<6{-GEL?%`0YlPMxcg@)-*ky@dMj(N$V6`c7?;mZhqK#n0J@$ zWJhlCA9^jtf2;JUgn=F@$`FCyIsBKbp5x3BDf=6N2!qtFyoUXbKm;NT5&`&S`Rj&( z)25IT?>e{R(G8lX#Nn_iXFWDW7Qx(bBf=mNID2AL6e%p<;S4oXdbLSm)*XG$?YO)F zcD{5S-CNc>Ypu6myL3LfXMlO`^gjejgsRUWs5%pecfx5`c=Vkg!E)x)tLX+_|9^)F zwO^2Q^ux}>Y|kw^`GMdc6l7Wse)LRVig8*QKcFq+E^9+ZatxdH7ow^^26Rm4U_phM{wbM>FrzMM&Rs*=)1+Q3+j5HVsX7gkqUe*EMrxvqhp+C!1x=IL zf3%#Ea&Nc`Q8(z5na2HBbz)f84C=)@S-2ae$n zXvng}O_#Q!K~gmL4(mv_=JnW}UqV@hnUU$VTexjN8*UrWmW;YFY&}?nU)4a>dGv;h zcx&kn_8%!jNP=s+H)X=*nOxMO9@$6A%(({QqwL&0v_04NYEI{-$z0ktje=4)Rz;?J z%ld4|E&v1SCb+og$_`x9qZzsZdk&TSA>F-au3{Mmv&Q!(InKeq=B%f6g9H{oHp~o} z2xvTc{Y6X~*_Ah!?7$b$S@rY?ELH`)0Ur2MXYLx(o|nJgLTX|Z)5l!`K!ZBb%${&5 zf9}(gsb6fQMM@m6-_ZxVEqu3X)gXaS?i6XCCprq z#a%<%b4~ZApz35cOl0z?t|8SRA(5$SXzwx^6Jy;wHp6EWG&jX2$k!#cOx; z0iTK@OT2#PrSxx~&I|K5(;_vFC68Tcrt5kGy#3dHG)sx&UvoE*mKen+_YO4IC0vYf zbKh2s?cbVzFWAa~qvibg^q-Jq8Qgy6JUEC3Nzpv{*?NXv(3pUxaiE}rc8wCv7%5c; zNn+izBe5tFvleABb9^rbcKTzMl0D?nY^)kGH({t@+P7@TE?~wN8$mOedUFrHTECwq zTk=@6@gRl)8FgdB!nQqS9=v{yf-*OIbBe$)iz7_=bRFyW6);mTguotf{fDo|dz%i!ISe-qntikbY;8hW&@PwN(S!$b6aD$m~7ovB}LV$;4tW__`d z+`x`T+p;G+p-Q-&4XPb z&Sm4!u}X8?lEjAW0=hIw232Fl_I$=&)&>K(rEe?#HFrY|PeQZ$aa4Fz<~}$WSrWuL ztz_jCMHmDj$StfSA=-}3BAe->Q8rQ%ToeU!C}c^(e%v^fO@dpxHP>Vs;L#7)@ZFZY z8qu5qO{sV?!%O~RPGZx3b5rR5$UJtubRE$S3(w41&$~-@28$_#h=8IBFPd&}`2(Ms(ZCTm zZ)mm1Ei9+p6QE0zB!naw(Y+~tRpa}tLuR!^n^}g&Zjot|kxW`07xUNd$5-NJ^{yk_ zI-o7d@lISeg%+uCXViT{w8@NmK;zX#Sy&aBdI>JxUb=%0jqA{;K>}7qVsNL1%vqfc z7MYyF3Y<2Dc5PF!DiY%^YZEF2P#bJLc#MAS(`nTt3AUaFBb4ccfu*40el5X2S%mb_+|lB(Z+?5z5?tdbLSGmIRlyNkI~VrCW2u30#r+?8m(f?AQ>iBGIH#9Womx z@c#1Mpy^Dy<^mRNILKYEf6os)4kKGmsIe?eoa)CrxuSP-99D&TaSrOmIU^F}_zaDH zZV~TKyo~rL8|7XZ;cIOkTgsj_rlnJjcXWern z31~VM-T)28zQto7uf=Io$eKP1k6-0TsfS+wH^x#< zPgQ%texl-CCO#I~tdDg(;VP((;Zs9-BY6B~!jTZcuZ8eeB}?fBcmvqu9C(X^{Tx?i zD}u>jaxit(8$fc}(7gfknj{!=X-l(w(G9Pe*X$OuUb>D^&o5&0t|R7n9mk9G>EKm~ zPH<6vJVp6DRzUo19TZ9eTsD&cYDs9ZTjZ*Rsjh|yz;3}X419jIiU?#WoH?NO+A-Tnu6jb{5@MRL_!iED>d+_wI90$pI@sY=Hs{+24$80+L`0{yM{qP)vC63 zo0G)2S0< z$L&{b;q(WOM?LrX zAk{^A1b%{AOaBvi9iG* l3=)9|L>MFj5%`V3{{!zs%p7GH3jF{8002ovPDHLkV1h$R#76)C literal 0 HcmV?d00001 diff --git a/hsacppcli/hsadminc/source/CMakeLists.txt b/hsacppcli/hsadminc/source/CMakeLists.txt new file mode 100644 index 0000000..4314b10 --- /dev/null +++ b/hsacppcli/hsadminc/source/CMakeLists.txt @@ -0,0 +1,11 @@ +CMAKE_MINIMUM_REQUIRED( VERSION 2.6 ) + +INCLUDE_DIRECTORIES( ${CMAKE_CURRENT_SOURCE_DIR} ) + +SET( HSADMINC_SRC abstractcmdlineparser.cpp cmdlineparser.cpp configfile.cpp hsadminc.cpp httpclient.cpp logger.cpp sslclient.cpp transaction.cpp xmlparser.cpp ) + +ADD_EXECUTABLE( hsadminc ${HSADMINC_SRC} ) +TARGET_LINK_LIBRARIES( hsadminc ${HSADMINC_LIB} ) + +INSTALL( TARGETS hsadminc RUNTIME DESTINATION bin ) + diff --git a/hsacppcli/hsadminc/source/abstractcmdlineparser.cpp b/hsacppcli/hsadminc/source/abstractcmdlineparser.cpp new file mode 100644 index 0000000..68b914b --- /dev/null +++ b/hsacppcli/hsadminc/source/abstractcmdlineparser.cpp @@ -0,0 +1,22 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + + #include "abstractcmdlineparser.h" + diff --git a/hsacppcli/hsadminc/source/abstractcmdlineparser.h b/hsacppcli/hsadminc/source/abstractcmdlineparser.h new file mode 100644 index 0000000..08c7019 --- /dev/null +++ b/hsacppcli/hsadminc/source/abstractcmdlineparser.h @@ -0,0 +1,417 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + + +#include +#include +#include "logger.h" +#include +#include +#include +#include + +/** abstractcommandlineparser holds some basic stuff for making commandline-Parsers easier. */ + +namespace abstractcommandlineparser { + +#ifndef HSADMIN_ABSTRACTCMDLINEPARSER +#define HSADMIN_ABSTRACTCMDLINEPARSER + +using std::vector; +using std::string; +using boost::shared_ptr; +using boost::scoped_ptr; +using boost::starts_with; +using boost::erase_first; + +/** \brief template for Commandline-Parser + * + * Has two Parameters: + * - class Options: This class must provide a method 'parseThis()'. - see template CmdLineOption for an example + * - class parseResult: a shared pointer to an Object of this class is passed to the Options. + */ +template class CmdLineParser { + public: + /** \brief this actually not only instatiates the parser but also parses Parameters. + * + * takes the Options in a vector + */ + CmdLineParser(vector options) : m_parsed(new parserResult), m_parseSuccessful(false) { + Options o; + while( options.size() > 0 ) + if( !(this->m_parseSuccessful = o.parseThis(options,m_parsed)) ) + return; + }; + + //! has the parser been successful? + inline bool operator!() { return !this->m_parseSuccessful; } + + protected: + shared_ptr m_parsed; + bool m_parseSuccessful; +}; + + +/** \brief base template for Option classes + * + * usually you would use one of the many specialisations + * has four parameters: + * - bool hasLongName: the Parameter has a long name (e.g. --verbose) + * - bool hasShortName: the Parameter has a short name (e.g. -v) + * - bool hasParameter: the Parameter is followed by another Parameter that belongs to it + * - class parseResult: takes the Parse results + * + * You should implement a protected virtual method 'bool handle(string ¶meter, shared_ptr result)' + * if you have 'hasParameter' set to true or 'bool handle(shared_ptr result)' otherwise. There you + * can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) {}; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that do have long and short names as well as a value. + * + * You should implement a protected virtual method + * 'bool handle(string ¶meter, shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( starts_with(options[0], "-"+m_shortName) ) { + if( rval = this->handle(options[1],result) ) { + if( options[0] == "-"+m_shortName) + options.erase(options.begin(),options.begin()+2); + else { + options.erase(options.begin()+1); + erase_first(options[0], m_shortName); + } + } + } else { + if( starts_with(options[0], "--"+m_longName+m_parameterSeparator) ) { + string p = options[0].substr(m_longName.size()+m_parameterSeparator.size()+2); + if( rval = this->handle(p,result) ) + options.erase(options.begin()); + } + } + return rval; + } + + protected: + string m_longName; + string m_shortName; + string m_parameterSeparator; + + //! the handle function. + virtual bool handle(string ¶meter, shared_ptr result) { return true; }; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that do have long and short names but no value. + * + * You should implement a protected virtual method + * 'bool handle(shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( options[0] == "-"+m_shortName || options[0] == "--"+m_longName ) { + if( rval = this->handle(result) ) + options.erase(options.begin()); + } else if( starts_with(options[0], "-"+m_shortName) && (rval = this->handle(result)) ) + erase_first(options[0], m_shortName); + return rval; + } + + protected: + string m_longName; + string m_shortName; + + //! the handle function. + virtual bool handle(shared_ptr result) { return true; }; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that only have a long name and a value but no short name. + * + * You should implement a protected virtual method + * 'bool handle(string ¶meter, shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( starts_with(options[0], "--"+m_longName+m_parameterSeparator) ) { + string p = options[0].substr(m_longName.size()+m_parameterSeparator.size()+2); + if ( rval = this->handle(p, result) ) + options.erase(options.begin()); + } + return rval; + } + + protected: + string m_longName; + string m_parameterSeparator; + + //! the handle function. + virtual bool handle(string ¶meter, shared_ptr result) { return true; }; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that only have a long name but no value or short name. + * + * You should implement a protected virtual method + * 'bool handle(shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( options[0] == "--"+m_longName && (rval = this->handle(result)) ) + options.erase(options.begin()); + return rval; + } + + protected: + string m_longName; + + //! the handle function. + virtual bool handle(shared_ptr result) { return true; }; +}; + + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that only have short name and a value but no long name. + * + * You should implement a protected virtual method + * 'bool handle(string ¶meter, shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( starts_with(options[0], "-"+m_shortName) && (rval = this->handle(options[1],result)) ) { + if( options[0] == "-"+m_shortName) + options.erase(options.begin(),options.begin()+2); + else { + options.erase(options.begin()+1); + erase_first(options[0], m_shortName); + } + } + return rval; + } + + protected: + string m_shortName; + + //! the handle function. + virtual bool handle(string ¶meter, shared_ptr result) { return true; }; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that only have short name bot no value or long name. + * + * You should implement a protected virtual method + * 'bool handle(shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( starts_with(options[0], "-"+m_shortName) && (rval = this->handle(result)) ) { + if( options[0] == "-"+m_shortName ) + options.erase(options.begin()); + else + erase_first(options[0], m_shortName); + } + return rval; + } + + protected: + string m_shortName; + + //! the handle function. + virtual bool handle(shared_ptr result) { return true; }; +}; + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that only have a value but neither a long or short name. + * + * You should implement a protected virtual method + * 'bool handle(string ¶meter, shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( !starts_with(options[0], "-") && (rval = this->handle(options[0],result)) ) + options.erase(options.begin()); + return rval; + } + + protected: + //! the handle function. + virtual bool handle(string ¶meter, shared_ptr result) { return true; }; +}; + + +/** \brief base template for Option classes - specialisation + * + * this is the specialisation for Parameters that neither have a value, a long or short name. + * + * You should implement a protected virtual method + * 'bool handle(shared_ptr result)'. + * There you can actually store your values in your parseResult. + */ +template class CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( !starts_with(options[0], "-") && (rval = this->handle(result)) ) + options.erase(options.begin()); + return rval; + } + + protected: + //! the handle function. + virtual bool handle(shared_ptr result) { return true; }; +}; + +//! just needed for typelists +class nullType {}; + +//! typelist for multiple Options parser +template class typelist { + public: + typedef CAR car; + typedef CDR cdr; +}; + +/** \brief A Commandline-Option for CmdLineParser that works with a typelist of Options. + * + * this is meant to combine multiple Parameters in a typelist to build a complex Command Line parser + */ +template class CmdLineOptionList : public CmdLineOption { + public: + //! the actual parser function. + bool parseThis(vector& options, shared_ptr result) { + return m_first.parseThis(options,result) || m_second.parseThis(options,result); + } + + private: + typename tl::car m_first; + CmdLineOptionList m_second; +}; + +/** \brief specialisation for empty type list + */ +template class CmdLineOptionList : public CmdLineOption { + public: + //! the actual parser function; always returns false. + bool parseThis(vector& options, shared_ptr result) { + return false; + } +}; + +#define Parameterlist1(t1) \ + abstractcommandlineparser::typelist +#define Parameterlist2(t1,t2) \ + abstractcommandlineparser::typelist +#define Parameterlist3(t1,t2,t3) \ + abstractcommandlineparser::typelist +#define Parameterlist4(t1,t2,t3,t4) \ + abstractcommandlineparser::typelist +#define Parameterlist5(t1,t2,t3,t4,t5) \ + abstractcommandlineparser::typelist +#define Parameterlist6(t1,t2,t3,t4,t5,t6) \ + abstractcommandlineparser::typelist +#define Parameterlist7(t1,t2,t3,t4,t5,t6,t7) \ + abstractcommandlineparser::typelist +#define Parameterlist8(t1,t2,t3,t4,t5,t6,t7,t8) \ + abstractcommandlineparser::typelist +#define Parameterlist9(t1,t2,t3,t4,t5,t6,t7,t8,t9) \ + abstractcommandlineparser::typelist +#define Parameterlist10(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10) \ + abstractcommandlineparser::typelist +#define Parameterlist11(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11) \ + abstractcommandlineparser::typelist +#define Parameterlist12(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12) \ + abstractcommandlineparser::typelist +#define Parameterlist13(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13) \ + abstractcommandlineparser::typelist +#define Parameterlist14(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14) \ + abstractcommandlineparser::typelist +#define Parameterlist15(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15) \ + abstractcommandlineparser::typelist +#define Parameterlist16(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16) \ + abstractcommandlineparser::typelist +#define Parameterlist17(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17) \ + abstractcommandlineparser::typelist +#define Parameterlist18(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18) \ + abstractcommandlineparser::typelist +#define Parameterlist19(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19) \ + abstractcommandlineparser::typelist +#define Parameterlist20(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19,t20) \ + abstractcommandlineparser::typelist +#define Parameterlist21(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19,t20,t21) \ + abstractcommandlineparser::typelist +#define Parameterlist22(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19,t20,t21,t22) \ + abstractcommandlineparser::typelist +#define Parameterlist23(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19,t20,t21,t22,t23) \ + abstractcommandlineparser::typelist +#define Parameterlist24(t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12,t13,t14,t15,t16,t17,t18,t19,t20,t21,t22,t23,t24) \ + abstractcommandlineparser::typelist + +#else + +template class CmdLineParser; +template class CmdLineOption; +class nullType; +template class typelist; +template class CmdLineOptionList; + +#endif /* HSADMIN_ABSTRACTCMDLINEPARSER */ +}; diff --git a/hsacppcli/hsadminc/source/cmdlineparser.cpp b/hsacppcli/hsadminc/source/cmdlineparser.cpp new file mode 100644 index 0000000..07e6053 --- /dev/null +++ b/hsacppcli/hsadminc/source/cmdlineparser.cpp @@ -0,0 +1,772 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include +#include + +#include +#include +#include + +#include "cmdlineparser.h" +#include "logger.h" + +#include +#include + +namespace commandline { + +using std::cout; +using std::cin; +using std::flush; +using std::ifstream; +using std::ostringstream; + +using boost::lexical_cast; +using boost::bad_lexical_cast; +using boost::shared_ptr; +using boost::scoped_ptr; +using boost::starts_with; +using boost::erase_first; + +// dynamic cast needs this + +vector callParameter::parseDisplayspec() { + vector rval; + boost::regex pattern("\\$\\{([^\\}]*)\\}"); + boost::sregex_iterator end; + + for(boost::sregex_iterator i(this->m_display.begin(),this->m_display.end(),pattern); i != end; i++ ) + rval.insert(rval.end(),(*i)[1]); + + Logger::log(Logger::DEBUG,"have parsed displayspec Parameter '"+this->m_display+"'"); + + return rval; +} +string callParameter::evalDisplay(const map &values) { + string rval = this->m_display; + string::size_type pos; + + for( map::const_iterator i = values.begin(); i != values.end(); i++ ) { + string pattstring = "${"+i->first+"}"; + while( (pos = rval.find(pattstring,0)) != string::npos ) rval.replace(pos,pattstring.length(),i->second); + } + + while( (pos = rval.find("\\n",0)) != string::npos ) rval.replace(pos,2,"\n"); + while( (pos = rval.find("\\t",0)) != string::npos ) rval.replace(pos,2,"\t"); + while( (pos = rval.find("\\r",0)) != string::npos ) rval.replace(pos,2,"\r"); + + Logger::log(Logger::DEBUG,"have evaluated displayspec Parameter '"+this->m_display+"': '"+rval+"'"); + + return rval; +} + +string setParameter::toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile) { + string rpccall = ""; + rpccall += "property"+m_property+""; + rpccall += "value"+m_value+""; + rpccall += ""; + return rpccall; +} +string whereParameter::toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile) { + string rpccall = ""; + rpccall += "property"+m_property+""; + rpccall += "value"+m_pattern+""; + rpccall += ""; + return rpccall; +} +string orderParameter::toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile) { + string rpccall = ""; + rpccall += "property"+m_property+""; + rpccall += "ascending"; + rpccall += string((m_ascending?"1":"0"))+""; + rpccall += ""; + return rpccall; +} +string callParameter::toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile) { + string rpccall = ""; + rpccall += ""; + rpccall += "module"; + rpccall += ""+m_module+""; + rpccall += ""; + rpccall += ""; + rpccall += "function"; + rpccall += ""+m_function+""; + rpccall += ""; + + if( m_force ) { + rpccall += ""; + rpccall += "force"; + rpccall += "1"; + rpccall += ""; + } + if( m_ignoreerror ) { + rpccall += ""; + rpccall += "ignoreerror"; + rpccall += "1"; + rpccall += ""; + } + + // read + vector reads = parseDisplayspec(); + + if(reads.size()) { + rpccall += ""; + rpccall += "read"; + rpccall += ""; + for(vector::iterator j = reads.begin(); j != reads.end(); j++ ) + rpccall += ""+(*j)+""; + rpccall += ""; + rpccall += ""; + } + + if( m_where.size() ) { + rpccall += ""; + rpccall += "where"; + rpccall += ""; + for(vector >::iterator j = m_where.begin(); j != m_where.end(); j++ ) + rpccall += ""+((*j)->toXML(username,cfgfile))+""; + rpccall += ""; + rpccall += ""; + } + + if( m_set.size() ) { + rpccall += ""; + rpccall += "set"; + rpccall += ""; + for(vector >::iterator j = m_set.begin(); j != m_set.end(); j++ ) + rpccall += ""+((*j)->toXML(username,cfgfile))+""; + rpccall += ""; + rpccall += ""; + } + + if( m_order.size() ) { + rpccall += ""; + rpccall += "order"; + rpccall += ""; + for(vector >::iterator j = m_order.begin(); j != m_order.end(); j++ ) + rpccall += ""+((*j)->toXML(username,cfgfile))+""; + rpccall += ""; + rpccall += ""; + } + + if( m_objects.size() ) { + rpccall += ""; + rpccall += "objectid"; + rpccall += ""; + for(vector::iterator j = m_objects.begin(); j != m_objects.end(); j++ ) + rpccall += ""+(*j)+""; + rpccall += ""; + rpccall += ""; + } + + if( m_unset.size() ) { + rpccall += ""; + rpccall += "unset"; + rpccall += ""; + for(vector::iterator j = m_unset.begin(); j != m_unset.end(); j++ ) + rpccall += "property"+(*j)+""; + rpccall += ""; + rpccall += ""; + } + + rpccall += ""; + + return rpccall; +} + +parsedParameters::parsedParameters(): + m_error(NOERROR), + m_user(""), + m_ticket(""), + m_defaultDisplay(""), + m_addConfigFile(""), + m_test(false), + m_ignoreerrors(false) {} + +string parsedParameters::toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile) { + // begin method call + string rpccall = "hsadmin.transaction"; + + // ticket + rpccall += ""; + if( this->m_ticket != "" ) { + string ticket; + ifstream file(this->m_ticket.c_str()); + if( ! file ) { + string msg = Logger::getMessageFormatString(Logger::CouldNotOpenFile); + boost::format fmt(msg); + fmt % this->m_ticket; + Logger::log(Logger::FATAL,fmt.str()); + exit(-1); + } + + char ch; + while(file.get(ch)) ticket += ch; + + boost::regex findticket(".*\\n---\\n"); + + ticket = boost::regex_replace(ticket,findticket,""); + if( ticket[ticket.size()-1] == '\0' ) ticket = ticket.substr(0,ticket.size()-2); + + rpccall += ticket; + } else { + rpccall += cfgfile->getTicket(username); + } + Logger::log(Logger::DEBUG,"have read ticket"); + rpccall += ""; + + // global Parameters + rpccall += ""; + if( this->m_test ) + rpccall += "test1"; + rpccall += ""; + + // calls Array + rpccall += ""; + for( vector >::iterator c = m_call.begin(); c != m_call.end(); c++ ) + rpccall += ""+((*c)->toXML(username,cfgfile))+""; + + rpccall += ""; + + rpccall += "\n"; + + return rpccall; +} + + +// specific Parser for --runas-Option + +bool VerbosityOption::parseThis(vector& options, shared_ptr result) { + bool rval = false; + if( starts_with(options[0], "-v") ) { + if( options[1] == "none" || + options[1] == "normal" || + options[1] == "high" || + options[1] == "debug" || + options[1] == "debugXML" || + options[1] == "debugAll" ) { + if( rval = this->handle(options[1], result) ) { + if( options[0] == "-v" ) + options.erase(options.begin(),options.begin()+2); + else { + erase_first(options[0], "v"); + options.erase(options.begin()+1); + } + } + } else { + string p; + if( rval = this->handle(p, result) ) { + if( options[0] == "-v" ) + options.erase(options.begin()); + else + erase_first(options[0], "v"); + } + } + } + if( starts_with(options[0], "--verbosity=") ) { + string p = options[0].substr(12); + if( rval = this->handle(p, result) ) + options.erase(options.begin()); + } + return rval; +} + +// constuctors + +TestOption::TestOption() { + m_longName = "test"; + m_shortName = "t"; +} + +IgnoreErrorOption::IgnoreErrorOption() { + m_longName = "ignoreerror"; + m_shortName = "e"; +} + +IgnoreErrorsOption::IgnoreErrorsOption() { + m_longName = "ignoreerrors"; + m_shortName = "E"; +} + +VerbosityOption::VerbosityOption() { + m_longName = "verbosity"; + m_shortName = "v"; + m_parameterSeparator = "="; +} + +RunAsOption::RunAsOption() { + m_longName = "runas"; + m_shortName = "r"; + m_parameterSeparator = "="; +} + +TicketOption::TicketOption() { + m_longName = "ticket"; + m_shortName = "T"; + m_parameterSeparator = "="; +} + +ConfigOption::ConfigOption() { + m_longName = "config"; + m_shortName = "C"; + m_parameterSeparator = "="; +} + +ForceOption::ForceOption() { + m_longName = "force"; +} + +GlobalsOption::GlobalsOption() { + m_longName = "globals"; + m_shortName = "l"; +} + +WhereOption::WhereOption() { + m_longName = "where"; + m_shortName = "w"; + m_parameterSeparator = ":"; +} + +OnlyOption::OnlyOption() { + m_longName = "only"; + m_shortName = "W"; + m_parameterSeparator = ":"; +} + +SetOption::SetOption() { + m_longName = "set"; + m_shortName = "s"; + m_parameterSeparator = ":"; +} + +SetAllOption::SetAllOption() { + m_longName = "setall"; + m_shortName = "S"; + m_parameterSeparator = ":"; +} + +InfileOption::InfileOption() { + m_longName = "infile"; + m_shortName = "f"; + m_parameterSeparator = ":"; +} + +OrderOption::OrderOption() { + m_longName = "order"; + m_shortName = "o"; + m_parameterSeparator = ":"; +} + +GlobalOrderOption::GlobalOrderOption() { + m_longName = "global-order"; + m_shortName = "O"; + m_parameterSeparator = ":"; +} + +InputOption::InputOption() { + m_longName = "input"; + m_shortName = "i"; + m_parameterSeparator = ":"; +} + +PassInputOption::PassInputOption() { + m_longName = "passinput"; + m_shortName = "p"; + m_parameterSeparator = ":"; +} + +DisplayOption::DisplayOption() { + m_longName = "display"; + m_shortName = "d"; + m_parameterSeparator = ":"; +} + +DefaultDisplayOption::DefaultDisplayOption() { + m_longName = "default-display"; + m_shortName = "D"; + m_parameterSeparator = ":"; +} + +CallOption::CallOption() { + m_longName = "call"; + m_shortName = "c"; + m_parameterSeparator = ":"; +} + +UnsetOption::UnsetOption() { + m_longName = "unset"; + m_shortName = "u"; + m_parameterSeparator = ":"; +} + +UnsetAllOption::UnsetAllOption() { + m_longName = "unsetall"; + m_shortName = "U"; + m_parameterSeparator = ":"; +} + +ObjectID::ObjectID() { }; + + +// handle functions + +bool TestOption::handle(shared_ptr result) { + result->m_test = true; + Logger::log(Logger::DEBUG," found test Option"); + return true; +} + +bool IgnoreErrorOption::handle(shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + result->m_call.back()->m_ignoreerror = true; + Logger::log(Logger::DEBUG," found ignoreerror Option"); + return true; +} + +bool IgnoreErrorsOption::handle(shared_ptr result) { + result->m_ignoreerrors = true; + Logger::log(Logger::DEBUG," found ignoreerrors Option"); + return true; +} + +bool VerbosityOption::handle(string ¶meter, shared_ptr result) { + if( parameter == "none" ) Logger::setLevel(0); + else if( parameter == "normal") Logger::setLevel(1); + else if( parameter == "high") Logger::setLevel(2); + else if( parameter == "debug") Logger::setLevel(3); + else if( parameter == "debugXML") Logger::setLevel(4); + else if( parameter == "debugAll") Logger::setLevel(5); + else Logger::incrementLevel(); + + Logger::log(Logger::DEBUG," set Verbosity Level to "+lexical_cast(Logger::level)); + + return true; +} + +bool QuietOption::handle(string ¶meter, shared_ptr result) { + Logger::decrementLevel(); + Logger::log(Logger::DEBUG," set Verbosity Level to "+lexical_cast(Logger::level)); + return true; +} + +bool RunAsOption::handle(string ¶meter, shared_ptr result) { + result->m_user = parameter; + Logger::log(Logger::DEBUG," found runas Option: "+parameter); + return true; +} + +bool TicketOption::handle(string ¶meter, shared_ptr result) { + result->m_ticket = parameter; + Logger::log(Logger::DEBUG," found ticket Option: "+parameter); + return true; +} + +bool ConfigOption::handle(string ¶meter, shared_ptr result) { + result->m_addConfigFile = parameter; + Logger::log(Logger::DEBUG," found config Option: "+parameter); + return true; +} + +bool ForceOption::handle(shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + result->m_call.back()->m_force = true; + Logger::log(Logger::DEBUG," found force Option"); + return true; +} + +bool GlobalsOption::handle(shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + result->m_call.back()->m_globalOrderIndex = result->m_call.back()->m_order.size(); + Logger::log(Logger::DEBUG," found globals Option"); + return true; +} + +bool WhereOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + string::size_type pos = parameter.find('='); + string property(parameter,0,pos); + string pattern(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + whereParameter *where = new whereParameter(); + where->m_property = property; + where->m_pattern = pattern; + + result->m_call.back()->m_where.push_back(shared_ptr(where)); + + Logger::log(Logger::DEBUG," found where Option: "+parameter); + return true; +} + +bool OnlyOption::handle(string ¶meter, shared_ptr result) { + string::size_type pos = parameter.find('='); + string property(parameter,0,pos); + string pattern(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + whereParameter *where = new whereParameter(); + where->m_property = property; + where->m_pattern = pattern; + + result->m_only.push_back(shared_ptr(where)); + + Logger::log(Logger::DEBUG," found only Option: "+parameter); + return true; +} + +bool UnsetOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + result->m_call.back()->m_unset.push_back(parameter); + Logger::log(Logger::DEBUG," found unset Option: "+parameter); + return true; +} + +bool UnsetAllOption::handle(string ¶meter, shared_ptr result) { + result->m_unsetall.push_back(parameter); + Logger::log(Logger::DEBUG," found unsetall Option: "+parameter); + return true; +} + +bool OrderOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + string::size_type pos = parameter.find('='); + string *property; + string * direction; + if( pos != string::npos ) { + property = new string(parameter,0,pos); + direction = new string(parameter,(pos != string::npos)?(pos+1):(string::npos)); + } else { + property = new string(parameter); + direction = new string("a"); + } + + orderParameter *order = new orderParameter(); + order->m_property = *property; + order->m_ascending = ((*direction)[0] == 'a'); + + result->m_call.back()->m_order.push_back(shared_ptr(order)); + + Logger::log(Logger::DEBUG," found order Option: "+parameter); + return true; +} + +bool GlobalOrderOption::handle(string ¶meter, shared_ptr result) { + string::size_type pos = parameter.find('='); + string *property; + string * direction; + if( pos != string::npos ) { + property = new string(parameter,0,pos); + direction = new string(parameter,(pos != string::npos)?(pos+1):(string::npos)); + } else { + property = new string(parameter); + direction = new string("a"); + } + + orderParameter *order = new orderParameter(); + order->m_property = *property; + order->m_ascending = ((*direction)[0] == 'a'); + + result->m_globalOrder.push_back(shared_ptr(order)); + + Logger::log(Logger::DEBUG," found global order Option: "+parameter); + return true; +} + +bool SetOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + string::size_type pos = parameter.find('='); + string property(parameter,0,pos); + string value(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + setParameter *set = new setParameter(); + set->m_property = property; + set->m_value = value; + + result->m_call.back()->m_set.push_back(shared_ptr(set)); + + Logger::log(Logger::DEBUG," found set Option: "+parameter); + return true; +} + +bool SetAllOption::handle(string ¶meter, shared_ptr result) { + string::size_type pos = parameter.find('='); + string property(parameter,0,pos); + string value(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + setParameter *set = new setParameter(); + set->m_property = property; + set->m_value = value; + + result->m_setall.push_back(shared_ptr(set)); + + Logger::log(Logger::DEBUG," found setall Option: "+parameter); + return true; +} + +bool InfileOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + string::size_type pos = parameter.find('='); + string property(parameter,0,pos); + string filename(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + setParameter *set = new setParameter(); + set->m_property = property; + + ifstream file(filename.c_str()); + if( ! file ) { + string msg = Logger::getMessageFormatString(Logger::CouldNotOpenFile); + boost::format fmt(msg); + fmt % filename; + Logger::log(Logger::FATAL,fmt.str()); + exit(-1); + } + char ch; + while(file.get(ch)) set->m_value += ch; + + result->m_call.back()->m_set.push_back(shared_ptr(set)); + + Logger::log(Logger::DEBUG," found infile Option: "+parameter); + return true; +} + +bool InputOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + setParameter *set = new setParameter(); + set->m_property = parameter; + cout << "Eingabe (" << parameter << "): " << flush; + std::getline(cin, set->m_value); + + result->m_call.back()->m_set.push_back(shared_ptr(set)); + + Logger::log(Logger::DEBUG," found input Option: "+parameter); + return true; +} + +string readPasswd() { + string rval = ""; + struct termios t, t2; + + tcgetattr(0,&t); + t2 = t; + t2.c_lflag &= ~ECHO; + tcsetattr(0,TCSANOW,&t2); + std::getline(cin, rval); + tcsetattr(0,TCSANOW,&t); + + return rval; +} + +bool PassInputOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + setParameter *set = new setParameter(); + set->m_property = parameter; + cout << "Passworteingabe (" << parameter << "): " << flush; + set->m_value = readPasswd(); + + result->m_call.back()->m_set.push_back(shared_ptr(set)); + + Logger::log(Logger::DEBUG," found password-input Option: "+parameter); + return true; +} + +bool DisplayOption::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + result->m_call.back()->m_display = parameter; + + Logger::log(Logger::DEBUG," found display Option: "+parameter); + return true; +} + +bool DefaultDisplayOption::handle(string ¶meter, shared_ptr result) { + result->m_defaultDisplay = parameter; + + Logger::log(Logger::DEBUG," found default display Option: "+parameter); + return true; +} + +bool ObjectID::handle(string ¶meter, shared_ptr result) { + if( result->m_call.size() <= 0 ) { + result->m_error = NeedCall; + return false; + } + + result->m_call.back()->m_objects.push_back(parameter); + Logger::log(Logger::DEBUG," found an ObjectID: "+parameter); + return true; +} + +bool CallOption::handle(string ¶meter, shared_ptr result) { + string::size_type pos = parameter.find('.'); + string module(parameter,0,pos); + string function(parameter,(pos != string::npos)?(pos+1):(string::npos)); + + callParameter *call = new callParameter(); + call->m_module = module; + call->m_function = function; + + result->m_call.push_back(shared_ptr(call)); + + Logger::log(Logger::DEBUG," found call Option: "+parameter); + return true; +} + +}; diff --git a/hsacppcli/hsadminc/source/cmdlineparser.h b/hsacppcli/hsadminc/source/cmdlineparser.h new file mode 100644 index 0000000..d47ce06 --- /dev/null +++ b/hsacppcli/hsadminc/source/cmdlineparser.h @@ -0,0 +1,386 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + + +#include +#include +#include +#include +#include + +#include "abstractcmdlineparser.h" +#include "configfile.h" + +//! here comes the commandline-Parser - with help of the abstractcommandlineparser. + +namespace commandline { + +#ifndef HSADMIN_CMDLINEPARSER +#define HSADMIN_CMDLINEPARSER + +using std::vector; +using std::string; +using std::map; +using boost::shared_ptr; +using boost::scoped_ptr; + +// Parameter Objects are the resultof each Parser step and used in second step. + +//! parsed values of a --setall, --set, --input, --passinput or a --infile option +class setParameter { + public: + string m_property; + string m_value; + + string toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile); +}; + +//! parsed values of a --only or a --where option +class whereParameter { + public: + string m_property; + string m_pattern; + + string toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile); +}; + +//! parsed values of a --global-order or a --order option +class orderParameter { + public: + string m_property; + bool m_ascending; + + string toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile); +}; + +//! a whole parsed --call Option which holds all the relevant other options +class callParameter { + public: + callParameter(): m_module(""), m_function(""), m_display(""), m_ignoreerror(false), m_force(false), m_globalOrderIndex(-1) { }; + + string m_module; + string m_function; + + string m_display; + vector > m_set; + vector > m_where; + vector > m_order; + vector m_objects; + vector m_unset; + + bool m_ignoreerror; + bool m_force; + int m_globalOrderIndex; + + vector parseDisplayspec(); + string evalDisplay(const map &values); + string toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile); +}; + +enum parseError { NOERROR = 0, NeedCall = 1 }; + +//! all the parsed values +class parsedParameters { + public: + parsedParameters(); + parseError m_error; + string m_user; + string m_ticket; + string m_defaultDisplay; + string m_addConfigFile; + bool m_test; + bool m_ignoreerrors; + vector > m_only; + vector > m_setall; + vector > m_globalOrder; + vector > m_call; + vector m_unsetall; + + string toXML(string &username, shared_ptr< ::ConfigFileParser > cfgfile); +}; + +// Option classes are used in first Parse step + +//! --test +class TestOption: public abstractcommandlineparser::CmdLineOption { + public: + TestOption(); + protected: + virtual bool handle(shared_ptr result); +}; + +//! --ignoreerror +class IgnoreErrorOption: public abstractcommandlineparser::CmdLineOption { + public: + IgnoreErrorOption(); + protected: + virtual bool handle(shared_ptr result); +}; + +//! --ignoreerrors +class IgnoreErrorsOption: public IgnoreErrorOption { + public: + IgnoreErrorsOption(); + protected: + virtual bool handle(shared_ptr result); +}; + +//! --verbosity +class VerbosityOption: public abstractcommandlineparser::CmdLineOption { + public: + VerbosityOption(); + bool parseThis(vector& options, shared_ptr result); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --quiet +class QuietOption: public abstractcommandlineparser::CmdLineOption { + public: + QuietOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --runas +class RunAsOption: public abstractcommandlineparser::CmdLineOption { + public: + RunAsOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --ticket +class TicketOption: public abstractcommandlineparser::CmdLineOption { + public: + TicketOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --config +class ConfigOption: public abstractcommandlineparser::CmdLineOption { + public: + ConfigOption(); + protected: + virtual bool handle(string & parameter, shared_ptr result); +}; + +//! --force +class ForceOption: public abstractcommandlineparser::CmdLineOption { + public: + ForceOption(); + protected: + virtual bool handle(shared_ptr result); +}; + +//! --globals +class GlobalsOption: public abstractcommandlineparser::CmdLineOption { + public: + GlobalsOption(); + protected: + virtual bool handle(shared_ptr result); +}; + +//! --where +class WhereOption: public abstractcommandlineparser::CmdLineOption { + public: + WhereOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --only +class OnlyOption: public WhereOption { + public: + OnlyOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --set +class SetOption: public abstractcommandlineparser::CmdLineOption { + public: + SetOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --setall +class SetAllOption: public SetOption { + public: + SetAllOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --infile +class InfileOption: public abstractcommandlineparser::CmdLineOption { + public: + InfileOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --order +class OrderOption: public abstractcommandlineparser::CmdLineOption { + public: + OrderOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --global-order +class GlobalOrderOption: public OrderOption { + public: + GlobalOrderOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --input +class InputOption: public abstractcommandlineparser::CmdLineOption { + public: + InputOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --passinput +class PassInputOption: public abstractcommandlineparser::CmdLineOption { + public: + PassInputOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --display +class DisplayOption: public abstractcommandlineparser::CmdLineOption { + public: + DisplayOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --default-display +class DefaultDisplayOption: public DisplayOption { + public: + DefaultDisplayOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --call +class CallOption: public abstractcommandlineparser::CmdLineOption { + public: + CallOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --unset +class UnsetOption: public abstractcommandlineparser::CmdLineOption { + public: + UnsetOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! --unsetall +class UnsetAllOption: public abstractcommandlineparser::CmdLineOption { + public: + UnsetAllOption(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! all other parameters are objectIDs. +class ObjectID: public abstractcommandlineparser::CmdLineOption { + public: + ObjectID(); + protected: + virtual bool handle(string ¶meter, shared_ptr result); +}; + +//! putting it all together in a typelist +typedef Parameterlist24( + TestOption, + IgnoreErrorsOption, + VerbosityOption, + RunAsOption, + TicketOption, + ConfigOption, + SetAllOption, + UnsetAllOption, + OnlyOption, + GlobalOrderOption, + DefaultDisplayOption, + IgnoreErrorOption, + ForceOption, + GlobalsOption, + WhereOption, + SetOption, + InfileOption, + OrderOption, + InputOption, + PassInputOption, + UnsetOption, + DisplayOption, + ObjectID, + CallOption ) allParameters; + +//! generating a class with parse()-function from the list of Options +typedef abstractcommandlineparser::CmdLineOptionList Parameters; + +#else +class parsedParameters; +class setParameter; +class whereParameter; +class orderParameter; +class callParameter; +class TestOption; +class IgnoreErrorOption; +class IgnoreErrorsOption; +class VerbosityOption; +class RunAsOption; +class TicketOption; +class ConfigOption; +class SetAllOption; +class OnlyOption; +class UnsetAllOption; +class GlobalOrderOption; +class DefaultDisplayOption; +class ForceOption; +class GlobalsOption; +class WhereOption; +class SetOption; +class InfileOption; +class OrderOption; +class InputOption; +class PassInputOption; +class DisplayOption; +class unsetOption; +class CallOption; +class ObjectID; + +#endif /* HSADMIN_CMDLINEPARSER */ + +}; + diff --git a/hsacppcli/hsadminc/source/configfile.cpp b/hsacppcli/hsadminc/source/configfile.cpp new file mode 100644 index 0000000..08d9097 --- /dev/null +++ b/hsacppcli/hsadminc/source/configfile.cpp @@ -0,0 +1,257 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "configfile.h" +#include "logger.h" + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include + + +using std::ostringstream; +using std::istringstream; +using std::ifstream; +using std::fstream; +using std::string; +using boost::lexical_cast; +using boost::bad_lexical_cast; + +ConfigFileFinder::ConfigFileFinder(Transaction& t): vector() { + try { + boost::filesystem::path general("/etc/hsadminc.conf"); + if( boost::filesystem::exists(general) && !boost::filesystem::is_directory(general) ) + this->loadFile(general.native()); + } catch(boost::filesystem::filesystem_error) {} + + string priv = getenv("HOME"); + try { + boost::filesystem::path p( priv + "/.hsadmin.conf"); + + if( boost::filesystem::exists(p) && !boost::filesystem::is_directory(p) ) + this->loadFile(p.native()); + } catch(boost::filesystem::filesystem_error) {} + + shared_ptr params = t.getParsed(); + if( params->m_addConfigFile != "" ) try { + boost::filesystem::path c( params->m_addConfigFile); + + if( boost::filesystem::exists(c) && !boost::filesystem::is_directory(c) ) + this->loadFile(c.native()); + } catch(boost::filesystem::filesystem_error) {} +} + +void ConfigFileFinder::loadFile(string filename) { + ifstream file(filename.c_str(),std::ios::in); + ostringstream reader; + reader << file.rdbuf(); + string *tmp = new string(reader.str()); + this->insert(this->end(),tmp); +} + +void ConfigFileParser::parse(string& text) { + vector lines; + config * current = &(this->basic); + vector configs; + + boost::split(lines,text,boost::is_any_of("\n")); + + if( current->pattern != ".*" ) { + current->pattern = ".*"; + current->ticketcommand = "hsadmint \\0"; + current->server = "http://localhost:7777/RPC2"; + current->shell = "/bin/sh"; + current->askpass = false; + } + + for( vector::iterator i = lines.begin(); i != lines.end(); i++ ) { + string& line = *i; + // ignore coments and empty lines + boost::trim_left(line); + if( line[0] == '#' || line == "" ) + continue; + + // is this a section? + if( line[0] == '[' ) { + line.erase(0,1); + line.erase(line.rfind(']')); + + if( current != &(this->basic) ) { + configs.insert(configs.end(),*current); + delete(current); + } + current = new config; + *current = this->basic; + + current->pattern = line; + } else { + string::size_type equals = line.find('='); + string name = boost::trim_copy(line.substr(0,equals)); + string value = boost::trim_copy(line.substr(equals+1)); + + // trim name and value + boost::trim(name); + boost::trim(value); + + if( name == "ticket" ) + current->ticketcommand = value; + else if( name == "server" ) + current->server = value; + else if( name == "shell" ) + current->shell = value; + else if( name == "askpass" && value == "true" ) + current->askpass = true; + else if( name == "askpass" && value == "false" ) + current->askpass = false; + } + } + + if( current != &(this->basic) ) { + configs.insert(configs.end(),*current); + delete(current); + } + + this->configs.insert(this->configs.begin(),configs.begin(),configs.end()); +} + +string ConfigFileParser::replaceStringMatches(string &userpattern, string username, string content) { + if( username == "" ) { + char* u = (char*)malloc(L_cuserid+1);; + cuserid(u); + if( u != 0 ) username = u; + } + + + boost::regex pattern(userpattern); + boost::cmatch results; + if( !boost::regex_match(username.c_str(),results,pattern) ) return content; + + for(int j = 0; j < results.size(); j++) { + ostringstream p; + p << "^\\\\" << j << "|([^\\\\])\\\\" << j; + boost::regex pat(p.str()); + + string replace = "$1"; + if( results[j].matched ) for( const char* i = results[j].first; i != results[j].second; i++ ) + replace += *i; + + content = boost::regex_replace(content,pat,replace); + } + + return content; +} + +string ConfigFileParser::getTicket(string &username) { + string ticketstring = ""; + config cfg = this->getConfig(username); + string command = cfg.getTicketcommand(username); + + Logger::log(Logger::DEBUG,"use '"+command+"' as command"); + + pid_t pid; + pid_t parentpid = getpid(); + int cmdout[2]; + + if(pipe(cmdout) || (pid=fork()) == -1) + return ""; + + if(!pid) { + close(1); + close(cmdout[0]); + dup(cmdout[1]); + //command = cfg.shell+" -c \""+command+"\""; + + // this should never return. + execlp(cfg.shell.c_str(),cfg.shell.c_str(),"-c",command.c_str(),(char*)0); + + // if we have reached this something has gone wrong. + string msg = Logger::getMessageFormatString(Logger::ErrorWithTicketCommand); + boost::format fmt(msg); + fmt % cfg.shell % command % Logger::getErrnoMessage(errno); + Logger::log(Logger::FATAL,fmt.str()); + exit(-1); + } + + int status; + waitpid(pid,&status,0); + close(cmdout[1]); + + // check if ticket has been successfully generated + if( !WIFEXITED(status) || WEXITSTATUS(status) ) + exit(WEXITSTATUS(status)); + + char buf[257]; + bzero(buf,257); + errno = 0; + int i = 0; + + while( (i = read(cmdout[0],buf,256)) != 0 ) { + if( i < 0 ) { + if( errno == EAGAIN ) { + usleep(20); + continue; + } else if( errno == EINTR ) continue; + else { + string msg = Logger::getMessageFormatString(Logger::ErrorReadingTicket); + boost::format fmt(msg); + fmt % Logger::getErrnoMessage(errno); + Logger::log(Logger::FATAL,fmt.str()); + exit(-1); + } + errno = 0; + } + ticketstring += buf; + if( strlen(buf) < i ) break; + bzero(buf,257); + } + + return ticketstring; +} + +ConfigFileParser::config &ConfigFileParser::getConfig(string &username) { + if( username == "" ) return basic; + + for( vector::iterator i = configs.begin(); i != configs.end(); i++ ) { + boost::regex pat(i->pattern); + if(boost::regex_match(username,pat)) return *i; + } + + return basic; +} + diff --git a/hsacppcli/hsadminc/source/configfile.h b/hsacppcli/hsadminc/source/configfile.h new file mode 100644 index 0000000..d24f3e7 --- /dev/null +++ b/hsacppcli/hsadminc/source/configfile.h @@ -0,0 +1,94 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include + +#ifndef HSADMIN_CONFIGFILE +#define HSADMIN_CONFIGFILE + +#include "transaction.h" + +using std::vector; +using std::string; +using std::iostream; + +//! this class manages configfiles +class ConfigFileFinder: public vector { + public: + //! find the standard config-files + ConfigFileFinder(Transaction& t); + //! load a config file + void loadFile(string filename); +}; + +//! parser for config files +class ConfigFileParser { + public: + //! parses one text + inline ConfigFileParser(string& text) { this->parse(text); }; + //! parses multiple texts + inline ConfigFileParser(vector* texts) { this->parse(texts); }; + + inline string getTicket() { string s = ""; return getTicket(s); }; + + /** \brief get a ticket for a specified user. + * + * this function finds the config for this user and calls the tocket-command + * with the specified shell. + */ + string getTicket(string &username); + + //! replaces references (\0, \1, etc.) in content with regex-matches. + static string replaceStringMatches(string &userpattern, string username, string content); + + //! holds single config entries + struct config { + string pattern; + string ticketcommand; + string server; + string shell; + bool askpass; + + string getTicketcommand(string &username) { return ConfigFileParser::replaceStringMatches(pattern,username,ticketcommand); }; + string getServer(string &username) { return ConfigFileParser::replaceStringMatches(pattern,username,ticketcommand); }; + string getShell(string &username) { return ConfigFileParser::replaceStringMatches(pattern,username,ticketcommand); }; + }; + + //! find the config for a specified user + config& getConfig(string &username); + + private: + void parse(string& text); + inline void parse(vector* texts) { + for( vector::iterator i = texts->begin(); i != texts->end(); i++ ) + this->parse(**i); + } + + vector configs; + config basic; +}; + +#else +class ConfigFileFinder; +class ConfigFileParser; + +#endif /* HSADMIN_CONFIGFILE */ diff --git a/hsacppcli/hsadminc/source/hsadminc.cpp b/hsacppcli/hsadminc/source/hsadminc.cpp new file mode 100644 index 0000000..8706c67 --- /dev/null +++ b/hsacppcli/hsadminc/source/hsadminc.cpp @@ -0,0 +1,155 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#ifdef HAVE_CONFIG_H +#include +#endif + +#include +#include +#include +#include + +#include +#include +#include + +#include "cmdlineparser.h" +#include "configfile.h" +#include "logger.h" +#include "transaction.h" + +using std::string; +using std::vector; +using std::cerr; +using std::endl; +using boost::shared_ptr; +using boost::scoped_ptr; +using boost::starts_with; + +void printErrorMessage(Transaction& transact, vector& options) { + shared_ptr p = transact.getParsed(); + string FailedOption = options[0]; + if( starts_with(FailedOption,"--") ) + FailedOption = FailedOption.substr(2); + else if( starts_with(FailedOption,"-") ) + FailedOption = FailedOption.substr(1,2); + + cerr << "Error on Commandline at Parameter '"<< FailedOption; + if( p->m_error == commandline::NeedCall ) + cerr << ": call specific Parameter before call"; + cerr << endl; +} + +void printUsage(char* cmdname) { + cerr << "Usage: " << endl << endl; + cerr << cmdname << " [--test|-t]" << endl; + cerr << "[--ignoreerrors|-e]" << endl; + cerr << "[--verbosity=|-v ]" << endl; + cerr << "[--quiet|-q]" << endl; + cerr << "[--runas=|-r ]" << endl; + cerr << "[--ticket=|-T ]" << endl; + cerr << "[--config=|-C ]" << endl; + cerr << "[--default-display:|-D ]" << endl; + cerr << "[(--only:=|-W =)" << endl; + cerr << " ... (--only:=|-W =)]" << endl; + cerr << "[(--setall:=|-S =)" << endl; + cerr << " ... (--setall:=|-S =)]" << endl; + cerr << " [(--unsetall:property_1|-U property_1) ... (--unsetall:property_n|-U property_n)]" << endl; + cerr << "[(--global-order:[=(asc|desc|a|d)]|-O [=(asc|desc|a|d)])" << endl; + cerr << " ..." << endl; + cerr << " (--global-order:[=(asc|desc|a|d)]|-O [=(asc|desc|a|d)]]" << endl; + cerr << " [--ignoreerrors|-E]" << endl; + cerr << "(--call:.|-c .)" << endl; + cerr << " [--force]" << endl; + cerr << " [--ignoreerror|-e]" << endl; + cerr << " [--display:|-d ]" << endl; + cerr << " [(--where:=|-w =)" << endl; + cerr << " ... (--where:=|-w =)]" << endl; + cerr << " [(--set:=|-s =)" << endl; + cerr << " ... (--set:=|-s =)]" << endl; + cerr << " [(--input:|-i )" << endl; + cerr << " ... (--input:|-i )]" << endl; + cerr << " [(--passinput:|-p )" << endl; + cerr << " ... (--passinput:|-p )]" << endl; + cerr << " [(--infile:=|-f =)" << endl; + cerr << " ... (--infile:=|-f =)]" << endl; + cerr << " [(--unset:property_1_1|-u property_1_1]) ... (--unset:property_1_n|-u property_1_n])]" << endl; + cerr << " [(--order:[=(asc|desc|a|d)]|-o [=(asc|desc|a|d)])" << endl; + cerr << " ..." << endl; + cerr << " [--globals|-l]" << endl; + cerr << " ..." << endl; + cerr << " (--order:[=(asc|desc|a|d)]|-o [=(asc|desc|a|d)]]" << endl; + cerr << " [object_1_1 ... object_1_n]" << endl; + cerr << "..." << endl; + cerr << "(--call:.|-c .)" << endl; + cerr << " [--force]" << endl; + cerr << " [--ignoreerror|-e]" << endl; + cerr << " [--display:|-d ]" << endl; + cerr << " [(--where:=|-w =)" << endl; + cerr << " ... (--where:=|-w =)]" << endl; + cerr << " [(--set:=|-s =)" << endl; + cerr << " ... (--set:=|-s =)]" << endl; + cerr << " [(--input:|-i )" << endl; + cerr << " ... (--input:|-i )]" << endl; + cerr << " [(--passinput:|-p )" << endl; + cerr << " ... (--passinput:|-p )]" << endl; + cerr << " [(--infile:=|-f =)" << endl; + cerr << " ... (--infile:=|-f =)]" << endl; + cerr << " [(--unset:property_m_1|-u property_m_1]) ... (--unset:property_m_n|-u property_m_n])]" << endl; + cerr << " [(--order:[=(asc|desc|a|d)]|-o [=(asc|desc|a|d)])" << endl; + cerr << " ..." << endl; + cerr << " [--globals|-l]" << endl; + cerr << " ..." << endl; + cerr << " (--order:[=(asc|desc|a|d)]|-o [=(asc|desc|a|d)]]" << endl; + cerr << " [object_m_1 ... object_m_n]" << endl; +} + +int main(int argc, char *argv[]) +{ + if( argc == 1 ) { + printUsage(*argv); + exit(1); + } + vector options(argv+1,argv+argc); + Transaction transact(options); + + if( !transact ) { + printErrorMessage(transact, options); + printUsage(*argv); + exit(1); + } + + Logger::log(Logger::DEBUG,"have parsed Parameters"); + + scoped_ptr cfff(new ConfigFileFinder(transact)); + shared_ptr cfg(new ConfigFileParser(cfff.get())); + + Logger::log(Logger::DEBUG,"have read config File"); + + transact(cfg); + + Logger::log(Logger::DEBUG,"have executed Transaction"); + + //cout << transact.formatOutput(); + //exit(transact.errorCode()); + + return 0; +} diff --git a/hsacppcli/hsadminc/source/httpclient.cpp b/hsacppcli/hsadminc/source/httpclient.cpp new file mode 100644 index 0000000..9411f6a --- /dev/null +++ b/hsacppcli/hsadminc/source/httpclient.cpp @@ -0,0 +1,146 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "httpclient.h" +#include "logger.h" +#include +#include +#include +#include +#include + +using std::string; +using std::streamsize; +using std::iostream; +using boost::lexical_cast; +using boost::bad_lexical_cast; + +TCPDevice::TCPDevice(const string& address, const short int port) { + this->init(address.c_str(),port); +} +TCPDevice::TCPDevice(const char* address, const short int port) { + this->init(address,port); +} + +void TCPDevice::init(const char* address, const short int port) { + struct sockaddr_in addr; + bzero(&addr,sizeof(addr)); + addr.sin_family = AF_INET; + if( (addr.sin_addr.s_addr = inet_addr(address)) == INADDR_NONE ) { + struct hostent* hp = gethostbyname(address); + if( hp == 0 ) throw("can't resolve hostname '"+string(address)+"'"); + bcopy(hp->h_addr, (char*) &addr.sin_addr, hp->h_length); + } + addr.sin_port = htons(port); + + if( (m_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0 ) throw(string("can't open socket")); + if( ::connect(m_socket, (struct sockaddr*) &addr, sizeof(addr)) < 0 ) { + ::close(m_socket); + throw("can't connect to '"+string(address)+"' port "+(lexical_cast(port))); + } +} +TCPDevice::TCPDevice(const int socket) : m_socket(socket) {} +TCPDevice::TCPDevice(const TCPDevice& other) : m_socket(other.m_socket) { } + +TCPDevice::~TCPDevice() { } + +void TCPDevice::closeSocket() { ::close(m_socket); } + +streamsize TCPDevice::read(char* s, streamsize n) { return (streamsize)::read(m_socket,(void*)s,(size_t)n); } + +streamsize TCPDevice::write(const char* s, streamsize n) { return (streamsize)::write(m_socket,(const void*)s,(size_t)n); } + +GenericHttpClient::GenericHttpClient(const string &url, const unsigned short defaultPort = 80): + m_url(url), m_defaultPort(defaultPort) {}; + +string GenericHttpClient::post(string postcontent) { + iostream *connection; + try { connection = this->parseUrl(); } + catch(string &e) { + Logger::log(Logger::FATAL,"connection failed: "+e); + exit(-1); + } + if( connection == 0 ) return ""; + + string outbuf = "POST "+m_path+" HTTP/1.1\r\n"; + outbuf += "Connection: close\r\n"; + outbuf += "User-Agent: hsadmin CLI client\r\n"; + outbuf += "Content-Type: text/xml\r\n"; + outbuf += "Content-Length: "+boost::lexical_cast(postcontent.length())+"\r\n"; + outbuf += "Host: "+m_hostname+"\r\n\r\n"; + outbuf += postcontent; + + for( int i = 0; i < outbuf.length(); i++ ) + (*connection) << outbuf[i];; + + connection->flush(); + + string reply = ""; + + char buf[257]; + do { // we simply ignore the http header in the response + bzero(buf,257); + connection->getline(buf,256); + } while( string(buf) != "" && string(buf) != "\r" ); + + string tmp; + do { + tmp = ""; + (*connection) >> tmp; + reply += " "+tmp; + } while( tmp.length() ); + + this->close(); + delete connection; + + return reply; +}; + +iostream * GenericHttpClient::parseUrl() { + int protocolend = m_url.find("://"); + m_protocol = m_url.substr(0,protocolend); + if( ! this->checkProtocol(m_protocol) ) return (iostream *)0; + + int hostnameend = m_url.find("/",protocolend+3); + m_hostname = m_url.substr(protocolend+3,hostnameend-(protocolend+3)); + m_port = m_defaultPort; + m_path = m_url.substr(hostnameend); + int portstart = m_hostname.find(":"); + if( portstart >= 0 ) { + string portstring = m_hostname.substr(portstart+1); + + if( portstring.size() > 0 ) { + try { + m_port = lexical_cast(portstring.c_str()); + m_hostname = m_hostname.substr(0,m_hostname.find(":")); + } catch(bad_lexical_cast &) { } + } + } + + return this->getConnection(m_hostname, m_port); +}; + +GenericHttpClient *createHttpClient(const string &url) { + int protocolend = url.find("://"); + string protocol = url.substr(0,protocolend); + if( protocol == "http" ) return (GenericHttpClient *) new HttpClient(url); + if( protocol == "https" ) return (GenericHttpClient *) new HttpClient(url); + return 0; +} diff --git a/hsacppcli/hsadminc/source/httpclient.h b/hsacppcli/hsadminc/source/httpclient.h new file mode 100644 index 0000000..0409c2e --- /dev/null +++ b/hsacppcli/hsadminc/source/httpclient.h @@ -0,0 +1,163 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include +#include +#include + +#include "sslclient.h" + +#ifndef HSADMIN_HTTPCLIENT +#define HSADMIN_HTTPCLIENT + +using std::string; +using std::iostream; +using std::streamsize; +using boost::lexical_cast; +using boost::bad_lexical_cast; + +//! A Socket as a Device +class TCPDevice : public boost::iostreams::device { +public: + //! create a TCP-Stream by connecting to the given port at the given address + TCPDevice(const string& address, const short int port); + //! create a TCP-Stream by connecting to the given port at the given address + TCPDevice(const char* address, const short int port); + //! create a TCP-Stream from a connected socket - use this with accept + TCPDevice(const int socket); + //! copy constructor + TCPDevice(const TCPDevice& other); + //! does not close the socket - use closeSocket before deleting the Device. + virtual ~TCPDevice(); + //! closes the socket + void closeSocket(); + + //! read n Bytes from socket + virtual streamsize read(char* s, streamsize n); + //! write n Bytes to socket + virtual streamsize write(const char* s, streamsize n); +private: + void init(const char* address, const short int port); + int m_socket; +}; + +//class SSLDevice; + +const int HTTP = 0; +const int HTTPS = 1; + +//! the basic HTTP Client - can only handle POST method. +class GenericHttpClient { + public: + //! initialize HTTP CLient with URL and default Port (usually 80) + GenericHttpClient(const string &url, const unsigned short defaultPort); + //! Post + string post(string postcontent); + + protected: + //! get a buffered iostream for the connection - must be overridden by derived classes + virtual iostream * getConnection(const string &host, unsigned short port) = 0; + //! check if this class can handle the protocol - must be overridden by derived classes + virtual bool checkProtocol(const string &protocol) { return false; }; + //! close the underlying connection + virtual void close() = 0; + + private: + iostream * parseUrl(); + const string& m_url; + string m_protocol; + string m_hostname; + string m_path; + unsigned short m_port; + const unsigned short m_defaultPort; +}; + +//! This template should usually be used in one of the specialized Versions below. +template class HttpClient: public GenericHttpClient { + public: + HttpClient(const string &url, unsigned short defaultPort = 80): GenericHttpClient(url,defaultPort) {}; + protected: + iostream * getConnection(const string &host, unsigned short port) { return (iostream *)0; }; + bool checkProtocol(const string &p) { return false; }; + virtual void close() { }; +}; + +//! a HTTP CLient with a plain TCP socket as transport +template <> class HttpClient: public GenericHttpClient { + public: + //! initialize HTTP CLient with URL and default Port (usually 80) + HttpClient(const string &url, unsigned short defaultPort = 80): GenericHttpClient(url,defaultPort), device(0) {}; + protected: + //! get a buffered iostream for the connection + iostream * getConnection(const string &host, unsigned short port) { + if( device == 0 ) device = new TCPDevice(host,port); + return (iostream *) new boost::iostreams::stream(*device); + } + //! check if this class can handle the protocol + bool checkProtocol(const string &protocol) { return (protocol == "http"); }; + //! close the underlying connection + virtual void close() { device->closeSocket(); }; + private: + TCPDevice *device; +}; +//! a HTTP CLient with a SSL stream as transport +template <> class HttpClient: public GenericHttpClient { + public: + //! initialize HTTPS CLient with URL and default Port (usually 443) + HttpClient(const string &url, unsigned short defaultPort = 443): GenericHttpClient(url,defaultPort), device(0) {}; + protected: + //! get a buffered iostream for the connection + iostream * getConnection(const string &host, unsigned short port) { + try { + if( device == 0 ) device = new SSLDevice(host,port); + return (iostream *) new boost::iostreams::stream(*device); + } catch( SSLDevice::CertificateError &e ) { + if( device != 0 ) { + delete(device); + device = 0; + } + std::cerr << e.msg << std::endl; + return (iostream *)0; + } + } + //! check if this class can handle the protocol + bool checkProtocol(const string &protocol) { return (protocol == "https"); }; + //! close the underlying connection + virtual void close() { device->closeSocket(); }; + private: + SSLDevice *device; +}; + +/** \brief get the best HTTP client for the defined Protocol + * + * returns HttpClient or HttpClient depending on the protocol + */ +GenericHttpClient *createHttpClient(const string &uri); + +#else /* HSADMIN_HTTPCLIENT */ +class TCPDevice; +class GenericHttpClient; +genericHttpClient *createHttpClient(url); + +extern const int HTTP = 0; +extern const int HTTPS = 1; +#endif /* HSADMIN_HTTPCLIENT */ diff --git a/hsacppcli/hsadminc/source/logger.cpp b/hsacppcli/hsadminc/source/logger.cpp new file mode 100644 index 0000000..2eebba5 --- /dev/null +++ b/hsacppcli/hsadminc/source/logger.cpp @@ -0,0 +1,136 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include +#include +#include + +#include +#include +#include + +#include + +#include "logger.h" + +namespace Logger { + +const int FATAL = 1; +const int ERROR = 2; +const int WARNING = 4; +const int DEBUG = 8; +const int XML = 16; +int levels[6] = { 1, 3, 7, 15, 23, 31 }; +int level = 1; + +std::map messages; + +void setLevel(int newlevel) { + level = newlevel; + if( level > 5 ) level = 5; + if( level < 0 ) level = 0; +} +void incrementLevel() { + level++; + if( level > 5 ) level = 5; +} +void decrementLevel() { + level--; + if( level < 0 ) level = 0; +} + +void log(int type, const std::string text) { + int bitmask = levels[level]; + + if( type & bitmask ) + std::cerr << text << std::endl; +} + +void insertMessages(std::string filename) { + std::ifstream file(filename.c_str(),std::ios::in); + if( !file ) return; + + char input[1024]; + + while(!file.eof()) { + bzero(input,1024); + file.getline(input,1023); + char *c = input; + // ignore whitespace at beginning of line + while( *c == ' ' || *c == '\t' ) c++; + // lines that dont't begin with a digit are ignored + if( *c < '0' || *c > '9' ) continue; + char *i = c; + while( *c >= '0' && *c <= '9' ) c++; + char *j = c; + while( *c == ' ' || *c == '\t' ) c++; + // the digit istn't followed by a '=' -> ignore this line + if( *c != '=' ) continue; + // separate number from content + *j = '\0'; + std::string number(i); + std::string formatstring(c+1); + messages[boost::lexical_cast(number)] = boost::trim_copy(formatstring); + } +} + +void loadMessages() { + std::string lang = getenv("LANG"); + std::string priv = getenv("HOME"); + + try { + boost::filesystem::path general("/etc/hsadminc.messages"); + if( boost::filesystem::exists(general) && !boost::filesystem::is_directory(general) ) + insertMessages(general.native()); + } catch(boost::filesystem::filesystem_error) {} + + try { + boost::filesystem::path generalLang("/etc/hsadminc.messages."+lang); + if( boost::filesystem::exists(generalLang) && !boost::filesystem::is_directory(generalLang) ) + insertMessages(generalLang.native()); + } catch(boost::filesystem::filesystem_error) {} + + try { + boost::filesystem::path p( priv + "/.hsadmin.messages" ); + if( boost::filesystem::exists(p) && !boost::filesystem::is_directory(p) ) + insertMessages(p.native()); + } catch(boost::filesystem::filesystem_error) {} + + try { + boost::filesystem::path pLang( priv + "/.hsadmin.messages."+lang ); + if( boost::filesystem::exists(pLang) && !boost::filesystem::is_directory(pLang) ) + insertMessages(pLang.native()); + } catch(boost::filesystem::filesystem_error) {} +} + +std::string getErrnoMessage(int e) { + if( messages.empty() ) loadMessages(); + std::map::iterator i = messages.find(e); + if( i != messages.end() ) return i->second; + else return std::string(""); +} + +std::string getMessageFormatString(const message msg) { + return getErrnoMessage((int)msg); +} + +} diff --git a/hsacppcli/hsadminc/source/logger.h b/hsacppcli/hsadminc/source/logger.h new file mode 100644 index 0000000..774fa19 --- /dev/null +++ b/hsacppcli/hsadminc/source/logger.h @@ -0,0 +1,68 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#ifndef HSADMIN_LOGGER +#define HSADMIN_LOGGER + +#include + +#include + +//! a simple logger +namespace Logger { + extern const int FATAL; + extern const int ERROR; + extern const int WARNING; + extern const int DEBUG; + extern const int XML; + + extern int levels[6]; + extern int level; + + typedef enum { + CouldNotOpenFile = 1001, + NoBodyInResponse = 1002, + CantResolveHostname = 1003, + CantOpenSocket = 1004, + CantConnetcToHost = 1005, + ServerErrorCode = 1006, + UnknownCallbackInXMLParser = 1007, + ConnectionFailed = 1008, + ErrorWithTicketCommand = 1009, + ErrorReadingTicket = 1010 + } message; + + //! change the loglevel - used by VerbosityOption + void setLevel(int newlevel); + //! increment the loglevel - used by VerbosityOption + void incrementLevel(); + //! decrement theloglevel - used by QuietOption + void decrementLevel(); + + //! do actualy output loginfo + void log(int type, const std::string text); + + //! get a message format string for a defined Message Type; use boost::format to insert Values + std::string getMessageFormatString(const message msg); + //! get an appropriate Message for an errno. + std::string getErrnoMessage(int e); +}; + +#endif /* HSADMIN_LOGGER */ diff --git a/hsacppcli/hsadminc/source/sslclient.cpp b/hsacppcli/hsadminc/source/sslclient.cpp new file mode 100644 index 0000000..0b18ecf --- /dev/null +++ b/hsacppcli/hsadminc/source/sslclient.cpp @@ -0,0 +1,171 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "sslclient.h" +#include "logger.h" + +#include +#include +#include +#include +#include + +#include +#include + +#include + +using std::string; +using std::streamsize; +using boost::lexical_cast; +using boost::bad_lexical_cast; + +int SSLDevice::countInstances = 0; + +SSLDevice::SSLDevice(const string& address, const short int port): m_session(0) { + this->init(address.c_str(),port); +} +SSLDevice::SSLDevice(const char* address, const short int port): m_session(0) { + this->init(address,port); +} + +void SSLDevice::init(const char* address, const short int port) { + struct sockaddr_in addr; + bzero(&addr,sizeof(addr)); + addr.sin_family = AF_INET; + if( (addr.sin_addr.s_addr = inet_addr(address)) == INADDR_NONE ) { + struct hostent* hp = gethostbyname(address); + if( hp == 0 ) throw("can't resolve hostname '"+string(address)+"'"); + bcopy(hp->h_addr, (char*) &addr.sin_addr, hp->h_length); + } + addr.sin_port = htons(port); + + if( (m_socket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0 ) throw(string("can't open socket")); + if( ::connect(m_socket, (struct sockaddr*) &addr, sizeof(addr)) < 0 ) { + ::close(m_socket); + throw("can't connect to '"+string(address)+"' port "+(lexical_cast(port))); + } + + const int cert_type_priority[3] = { GNUTLS_CRT_X509, GNUTLS_CRT_OPENPGP, 0 }; + + m_session = new gnutls_session; + + if( countInstances == 0 ) gnutls_global_init(); + countInstances++; + + gnutls_certificate_allocate_credentials(&m_xcred); + gnutls_certificate_set_x509_trust_file(m_xcred, "ca.pem", GNUTLS_X509_FMT_PEM); + + gnutls_init(m_session,GNUTLS_CLIENT); + + gnutls_set_default_priority(*m_session); + + gnutls_credentials_set(*m_session, GNUTLS_CRD_CERTIFICATE, m_xcred); + + gnutls_transport_set_ptr(*m_session, (gnutls_transport_ptr)&m_socket); + + if( gnutls_handshake(*m_session) < 0 ) + throw(string(gnutls_protocol_get_name(gnutls_protocol_get_version(*m_session)))+" Handshake failed"); + + verify_certificate( *m_session, address); +} +SSLDevice::SSLDevice(const SSLDevice& other) : m_session(other.m_session), m_socket(other.m_socket), m_xcred(other.m_xcred) { } +SSLDevice::~SSLDevice() { } + +void SSLDevice::closeSocket() { + gnutls_bye(*m_session, GNUTLS_SHUT_RDWR); + gnutls_certificate_free_credentials(m_xcred); + ::close(m_socket); + gnutls_deinit(*m_session); + delete(m_session); + + countInstances--; + if( countInstances == 0 ) gnutls_global_deinit(); +} + +streamsize SSLDevice::read(char* s, streamsize n) { return (streamsize)gnutls_record_recv(*m_session,(void*)s,(size_t)n); } +streamsize SSLDevice::write(const char* s, streamsize n) { + /*streamsize i = (streamsize)gnutls_record_send(*m_session,(const void*)s,(size_t)n); + Logger::log(Logger::DEBUG,string("sending ")+boost::lexical_cast(i)+" von "+boost::lexical_cast(n)+" bytes: \n---\n"+s+"\n---\n");*/ + return (streamsize)gnutls_record_send(*m_session,(const void*)s,(size_t)n); //i; +} + +void SSLDevice::verify_certificate( gnutls_session session, string hostname) { + boost::filesystem::path general("/etc/hsadminc.cert"); + if( boost::filesystem::exists(general) && !boost::filesystem::is_directory(general) ) + gnutls_certificate_set_x509_trust_file (m_xcred, general.native().c_str(), GNUTLS_X509_FMT_PEM); + //string privfilename = getenv("HOME"); + string priv = getenv("HOME"); + boost::filesystem::path p( priv + "/.hsadmin.cert" ); + //p /= ".hsadminc.conf"; + + if( boost::filesystem::exists(p) && !boost::filesystem::is_directory(p) ) + gnutls_certificate_set_x509_trust_file (m_xcred, p.native().c_str(), GNUTLS_X509_FMT_PEM); + //gnutls_certificate_set_x509_trust_file (m_xcred, const char * cafile, PEM) + + unsigned int status = 0;//gnutls_certificate_verify_peers(*m_session); + /*if( gnutls_certificate_verify_peers2(*m_session, &status) < 0 ) + throw(string("Error while verifying certificate"));*/ + + string tval = "Certificate Verification failed: "; + if( status & GNUTLS_CERT_INVALID ) { throw(tval+"The certificate is not trustet"); } + if( status & GNUTLS_CERT_SIGNER_NOT_FOUND ) { throw(tval+"The certificate has no known Issuer"); } + if( status & GNUTLS_CERT_REVOKED ) { throw(tval+"The certificate has been revoked"); } + + // the further checks are only valid for X509 certificates + if ( gnutls_certificate_type_get(session) != GNUTLS_CRT_X509) return; + + const gnutls_datum* cert_list; + unsigned int cert_list_size; + gnutls_x509_crt cert; + + if ( gnutls_x509_crt_init(&cert) < 0) throw(tval+"error in initialization"); + + cert_list = gnutls_certificate_get_peers(session, &cert_list_size); + if ( cert_list == NULL ) throw(tval+"no certificate found"); + + bool failed = false; + string tReason = ""; + for( int i = 0; i < cert_list_size-1; i++ ) { + bool failed = false; + + if ( gnutls_x509_crt_import( cert, &cert_list[0], GNUTLS_X509_FMT_DER) < 0) + throw(tval+"error parsing certificate Number "+lexical_cast(i)); + + if ( gnutls_x509_crt_get_expiration_time(cert) < time(0) ) { + tReason = "The certificate has expired"; + failed = true; + } + + if ( gnutls_x509_crt_get_activation_time(cert) > time(0) ) { + tReason = "The certificate is not yet activated"; + failed = true; + } + if ( !gnutls_x509_crt_check_hostname(cert,hostname.c_str()) ) { + tReason = "The certificate’s owner does not match hostname ’"; + tReason += hostname +"'"; + failed = true; + } + gnutls_x509_crt_deinit(cert); + + if( !failed ) break; + } + if( failed ) throw(tval+tReason); +} diff --git a/hsacppcli/hsadminc/source/sslclient.h b/hsacppcli/hsadminc/source/sslclient.h new file mode 100644 index 0000000..524b8bc --- /dev/null +++ b/hsacppcli/hsadminc/source/sslclient.h @@ -0,0 +1,73 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include +#include + +#include + +#ifndef HSADMIN_SSLCLIENT +#define HSADMIN_SSLCLIENT + +using std::string; +using std::streamsize; + +//! A SSL connection as a Device +class SSLDevice : public boost::iostreams::device { +public: + //! create a SSL-Stream by connecting to the given port at the given address and checking the Certificate + SSLDevice(const string& address, const short int port); + //! create a SSL-Stream by connecting to the given port at the given address and checking the Certificate + SSLDevice(const char* address, const short int port); + //! copy constructor + SSLDevice(const SSLDevice& other); + //! does not close the SSL strem - use closeSocket before deleting the Device. + virtual ~SSLDevice(); + //! closes the SSL Stream + void closeSocket(); + + //! read n Bytes from SSL Stream + virtual streamsize read(char* s, streamsize n); + //! write n Bytes to SSL stream + virtual streamsize write(const char* s, streamsize n); + + //! indicates an error while checking the certificate + class CertificateError { + public: + CertificateError(const string &s): msg(s) {}; + CertificateError(const char* s): msg(s) {}; + string msg; + }; +private: + void init(const char* address, const short int port); + void verify_certificate( gnutls_session session, string hostname); + + gnutls_session *m_session; + gnutls_certificate_credentials m_xcred; + int m_socket; + + static int countInstances; +}; + +#else /* HSADMIN_SSLCLIENT */ +class SSLDevice; +#endif /* HSADMIN_SSLCLIENT */ diff --git a/hsacppcli/hsadminc/source/transaction.cpp b/hsacppcli/hsadminc/source/transaction.cpp new file mode 100644 index 0000000..d8b1c2a --- /dev/null +++ b/hsacppcli/hsadminc/source/transaction.cpp @@ -0,0 +1,502 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "transaction.h" +#include "xmlparser.h" +#include "httpclient.h" +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +using boost::lexical_cast; +using boost::bad_lexical_cast; +using namespace xmlParser; + +Transaction::Transaction(vector options) : + abstractcommandlineparser::CmdLineParser(options), + m_nextAttributeValue(""), + m_globalFault(false), + m_currentCall(0) { + if(!this->m_parseSuccessful) return; + + vector >& calls = m_parsed->m_call; + + for( vector >::iterator c = calls.begin(); c != calls.end(); c++ ) { + shared_ptr call = *c; + + vector >::iterator orderhere = call->m_order.end(); + if( call->m_globalOrderIndex >= 0 ) orderhere = call->m_order.begin()+call->m_globalOrderIndex; + + call->m_order.insert( orderhere, m_parsed->m_globalOrder.begin(), m_parsed->m_globalOrder.end() ); + call->m_where.insert( call->m_where.end(), m_parsed->m_only.begin(), m_parsed->m_only.end() ); + call->m_set.insert( call->m_set.end(), m_parsed->m_setall.begin(), m_parsed->m_setall.end() ); + call->m_unset.insert( call->m_unset.end(), m_parsed->m_unsetall.begin(), m_parsed->m_unsetall.end() ); + + if( m_parsed->m_ignoreerrors ) call->m_ignoreerror = true; + } +}; + +void Transaction::operator()(shared_ptr cfgfile) { + + class { + public: + void post(string &url) { + GenericHttpClient * client = createHttpClient(url); + m_response = client->post(m_request); + }; + + void execCall(Transaction *t, string &username, string &url, shared_ptr cfgfile) { + m_request = t->getParsed()->toXML(username,cfgfile); + Logger::log(Logger::XML,"--XML request--\n"+m_request+"\n---"); + + this->post(url); + + ResponseParser parse; + if( !parse(m_response, t) ) Logger::log(Logger::XML,"parse error"); + Logger::log(Logger::XML,"response parsed:"); + + if(Logger::XML && Logger::levels[Logger::level]) logNode(t->m_docelem,0); + } + + void logNode(Node* node, int ind) { + Text *text; + Element *elm; + string indent = ""; + for( int j = 0; j < ind; j++ ) indent += " "; + string attributes; + + switch(node->m_type) { + case ELEMENT: + elm = (Element*)node; + for(map::iterator i = elm->m_attributes.begin(); i != elm->m_attributes.end(); i++) + attributes += " "+(i->first)+"=\""+(i->second)+"\""; + Logger::log(Logger::XML,indent+"<"+elm->m_name+attributes+">"); + for( vector::iterator i = elm->m_nodes.begin(); i != elm->m_nodes.end(); i++ ) + logNode(*i,ind+1); + Logger::log(Logger::XML,indent+"m_name+">"); + break; + case TEXT: + text = (Text*)node; + Logger::log(Logger::XML,indent+text->m_content); + break; + } + } + + private: + int connectToHost(const string hostname, const int port) const { + int sock; + + struct sockaddr_in server_addr; + server_addr.sin_family = AF_INET; + if( (server_addr.sin_addr.s_addr = inet_addr(hostname.c_str())) == INADDR_NONE ) { + struct hostent* hp = gethostbyname(hostname.c_str()); + if( hp == 0 ) { + string msg = Logger::getMessageFormatString(Logger::CantResolveHostname); + boost::format fmt(msg); + fmt % hostname; + Logger::log(Logger::FATAL,fmt.str()); + exit(1); + } + bcopy(hp->h_addr, (char*) &server_addr.sin_addr, hp->h_length); + } + server_addr.sin_port = htons(port); + + if( (sock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0 ) { + Logger::log(Logger::FATAL,Logger::getMessageFormatString(Logger::CantOpenSocket)); + exit(1); + } + if( connect(sock, (struct sockaddr*) &server_addr, sizeof(server_addr)) < 0 ) { + string msg = Logger::getMessageFormatString(Logger::CantConnetcToHost); + boost::format fmt(msg); + fmt % hostname % port; + Logger::log(Logger::FATAL,fmt.str()); + close(sock); + exit(1); + } + return sock; + } + + string m_request; + string m_response; + } XMLRPCrequest; + + + string username = ""; + ConfigFileParser::config cfg = cfgfile->getConfig(username); + string url = cfg.server; + username = this->getUser(); + cfg = cfgfile->getConfig(username); + if( cfg.server != "" ) url = cfg.server; + + Logger::log(Logger::DEBUG,"now I know which Config to use"); + + XMLRPCrequest.execCall(this,username,url,cfgfile); +} + + + +// XML Parser stuff +Element* Transaction::stepin(int count,Element* value) { + if( count<= 0 ) return value; + for( ; count > 0; count-- ) + if(value->m_nodes[0]->m_type == xmlParser::ELEMENT ) value = (Element*)value->m_nodes[0]; + return value; +} + +string Transaction::getContent(Element* value) { + while( value->m_nodes.size() > 0 && value->m_nodes[0]->m_type == xmlParser::ELEMENT ) value = (Element*)value->m_nodes[0]; + + if( value->m_nodes.size() > 0 ) { + Text* txt = (Text*)value->m_nodes[0]; + + if( value->m_name == "boolean") { + int b = boost::lexical_cast(replaceEntities(txt->m_content)); + return (b == 0)?"false":"true"; + } else if( value->m_name == "dateTime.iso8601") { + string datestring = replaceEntities(txt->m_content); + string year = datestring.substr(0,4); + string month = datestring.substr(4,2); + string day = datestring.substr(6,2); + string hour = datestring.substr(9,2); + string minute= datestring.substr(12,2); + string second= datestring.substr(15,2); + return day+"."+month+"."+year+" "+hour+":"+minute+":"+second; + } else if( value->m_name == "base64") { + string encoded = replaceEntities(txt->m_content); + string decoded; + char next = '\0'; + int shift = 0; + while( encoded.size() ) { + int d = encoded[0]; + encoded = encoded.substr(1,encoded.size()-1); + if ( d >= 'A' && d <= 'Z') d -= 'A'; + else if ( d >= 'a' && d <= 'z') d = (d-'a')+26; + else if ( d >= '0' && d <= '9') d = (d-'0')+52; + else if ( d == '+') d = 62; + else if ( d == '/') d = 63; + else continue; + + next += d << shift; + if( !shift ) { decoded += (char)(next&255); next = next >> 8; } + + shift = (shift-2)%8; + } + if( shift ) decoded += next; + return decoded; + } else { + return replaceEntities(txt->m_content); + } + } + return string(""); +} + +void Transaction::handleElem(Element * elem) { + if( m_tagstack.size() == 0 ) { + m_docelem = elem; + return; + } + + Element *array, *data; + int tab = 8; + + switch( m_tagstack.size() ) { + case 6: // fill next call + if(elem->m_name != "value" ) break; + array = (Element*)(elem->m_nodes[0]); + + if( array->m_name == "struct" ) { + map errorstruct; + if(array->m_nodes.size() != 0) for(vector::iterator n = array->m_nodes.begin(); n != array->m_nodes.end(); n++) { + Element* member = (Element*)(*n); + if(member->m_nodes.size() >= 2) { + Element *name, *value; + name = (Element*)member->m_nodes[0]; + if( name->m_name == "value" ) { + value = name; + name = (Element*)member->m_nodes[1]; + } else + value = (Element*)member->m_nodes[1]; + + while( name->m_nodes.size() > 0 && name->m_nodes[0]->m_type == xmlParser::ELEMENT ) name = (Element*)name->m_nodes[0]; + while( value->m_nodes.size() > 0 && value->m_nodes[0]->m_type == xmlParser::ELEMENT ) value = (Element*)value->m_nodes[0]; + if( value->m_nodes.size() > 0 && name->m_nodes.size() > 0 ) { + string namtxt = getContent(name); + string valtxt = getContent(value); + errorstruct[namtxt] = valtxt; + } + } + } + string msg = Logger::getMessageFormatString(Logger::ServerErrorCode); + + int errnum = boost::lexical_cast(errorstruct["errorcode"]); + string errorstring = Logger::getErrnoMessage(errnum); + if( errorstring != "" ) errorstruct["errorstring"] = errorstring; + + boost::format fmt(msg); + fmt % errorstruct["errorcode"] % errorstruct["errorstring"]; + Logger::log(Logger::ERROR,fmt.str()); + + break; + } + + data = (Element*)(array->m_nodes[0]); + + if(data->m_nodes.size() != 0) { + vector headlines; + int tabpos = 0; + vector tabstops; + + Element* headlinesdata = stepin(3,data); + + if( m_parsed->m_call[m_currentCall]->m_display == "" ) { + if(headlinesdata->m_nodes.size() != 0) for(vector::iterator in = headlinesdata->m_nodes.begin(); in != headlinesdata->m_nodes.end(); in++) { + string output = ""; + if((*in)->m_type == xmlParser::ELEMENT ) { + output = getContent((Element*)(*in)); + } else { + Text* txt = (Text*)(*in); + output = replaceEntities(txt->m_content); + } + std::cout << output; + tabstops.push_back(tabpos); + tabpos += output.length(); + if( in+1 != headlinesdata->m_nodes.end() )do { + std::cout << " "; + tabpos++; + } while( tabpos % tab ); + } + std::cout << "\n"; + for(;tabpos;tabpos--) std::cout << "-"; + std::cout << "\n"; + } else { + if(headlinesdata->m_nodes.size() != 0) for(vector::iterator in = headlinesdata->m_nodes.begin(); in != headlinesdata->m_nodes.end(); in++) { + string headline = getContent((Element*)(*in)); + if( headline != "" ) headlines.push_back( headline ); + } + } + + + Element* contentvalue; + if(data->m_nodes[1]->m_type == xmlParser::ELEMENT ) contentvalue = (Element*)data->m_nodes[1]; + else contentvalue = data; + Element* contentdata = stepin(2,contentvalue); + + if(contentdata->m_nodes.size() != 0) for(vector::iterator n = contentdata->m_nodes.begin(); n != contentdata->m_nodes.end(); n++) { + if( m_parsed->m_call[m_currentCall]->m_display == "" ) { + tabpos = 0; + int i = 0; + + Element* innerdata = stepin(2,(Element*)(*n)); + if(innerdata->m_nodes.size() != 0) for(vector::iterator in = innerdata->m_nodes.begin(); in != innerdata->m_nodes.end(); in++) { + string oputput = getContent((Element*)(*in)); + + while( tabpos < tabstops[i] ) { + std::cout << " "; tabpos++; + } + std::cout << oputput; + tabpos += oputput.length(); + i++; + } + std::cout << "\n"; + } else { + map values; + int i = 0; + + Element* innerdata = stepin(2,(Element*)(*n)); + if(innerdata->m_nodes.size() != 0) for(vector::iterator in = innerdata->m_nodes.begin(); in != innerdata->m_nodes.end(); in++) { + string oputput = getContent((Element*)(*in)); + + if( oputput != "" ) { + values[headlines[i]] = oputput; + i++; + } + } + std::cout << m_parsed->m_call[m_currentCall]->evalDisplay(values); + } + } + } + m_currentCall++; + break; + default: + break; + } + + m_tagstack.top().m_nodes.push_back(elem); +} + +void Transaction::handleGlobalFaultElem(xmlParser::Element * elem) { + if( m_tagstack.size() == 0 ) { + m_docelem = elem; + return; + } + + Text *txt; + switch( m_tagstack.size() ) { + case 5: + if(elem->m_name == "value" ) + Logger::log(Logger::FATAL,getContent(elem)); + break; + default: + break; + } + + m_tagstack.top().m_nodes.push_back(elem); +} + +string Transaction::replaceEntities(const string &input) { + string rval; + for( string::const_iterator i = input.begin(); i != input.end(); i++ ) { + if( *i != '&' ) rval += *i; + else { + string tmp; + int j; + + for( j = 1; *(i+j) != ';' && i+j != input.end(); j++ ) tmp += *(i+j); + + if( *(i+j) != ';' ) { rval += "&"; continue; } + + if( tmp == "amp" ) { + rval += "&"; + i+=j; + } else if( tmp == "gt" ) { + rval += ">"; + i+=j; + } else if( tmp == "lt" ) { + rval += "<"; + i+=j; + } else if( tmp == "quot" ) { + rval += "\""; + i+=j; + } else if( tmp == "apos" ) { + rval += "'"; + i+=j; + } else if( tmp[0] == '#' ) { + if( tmp[1] != 'x' ) { + wchar_t value[2]; + value[0] = lexical_cast(tmp.substr(1)); + value[1] = 0; + char u[255]; + bzero(u,255); + + wcstombs(u,value,254); + rval += u; + i+=j; + } else { + wchar_t value[2]; + value[0] = 0; + value[1] = 0; + if ( tmp[2] >= '0' && tmp[2] <= '9' ) value[0] = tmp[2]-'0'; + else if( tmp[2] >= 'a' && tmp[2] <= 'f' ) value[0] = tmp[2]-'a'; + else if( tmp[2] >= 'A' && tmp[2] <= 'F' ) value[0] = tmp[2]-'A'; + else { rval += "&"; continue;} + value[0] = value[0] << 4; + if ( tmp[3] >= '0' && tmp[3] <= '9' ) value[0] += tmp[3]-'0'; + else if( tmp[3] >= 'a' && tmp[3] <= 'f' ) value[0] += tmp[3]-'a'; + else if( tmp[3] >= 'A' && tmp[3] <= 'F' ) value[0] += tmp[3]-'A'; + else { rval += "&"; continue; } + char u[255]; + bzero(u,255); + + wcstombs(u,value,254); + rval += u; + i+=j; + } + } else { + rval += "&"; + } + } + } + return rval; +} + +bool Transaction::operator()(int type, string content) { + string tmp; + Element elem, currentelem; + Text text; + + switch( type ) { + case responseParserHook::ELEMENT: + break; + case responseParserHook::ATTRIBUTE: + m_nextAttributeList[content] = m_nextAttributeValue; + m_nextAttributeValue = ""; + break; + case responseParserHook::TEXT: + if( m_tagstack.size() ) { + m_tagstack.top().m_nodes.push_back(new Text(content)); + } else return false; + break; + case responseParserHook::CDATA: + if( m_tagstack.size() ) { + m_tagstack.top().m_nodes.push_back(new Text(content)); + } else return false; + break; + case responseParserHook::PROCESSING_INSTRUCTION: + if( m_nextAttributeList["version"] != "1.0" || content != "xml" ) return false; + tmp = ""; + for(map::iterator i = m_nextAttributeList.begin(); i != m_nextAttributeList.end(); i++) + tmp += " "+(i->first)+"="+(i->second); + m_nextAttributeList.clear(); + break; + case responseParserHook::COMMENT: + break; + case responseParserHook::DOCUMENT: + break; + case responseParserHook::START_ELEMENT: + if(m_tagstack.size() == 1 && content == "fault") m_globalFault = true; + elem = Element(content,m_nextAttributeList,vector()); + m_nextAttributeList.clear(); + m_tagstack.push(elem); + break; + case responseParserHook::END_ELEMENT: + currentelem = m_tagstack.top(); + m_tagstack.pop(); + if( currentelem.m_name != content ) { + return false; + } + if( !m_globalFault ) handleElem(new Element(currentelem)); + else handleGlobalFaultElem(new Element(currentelem)); + break; + case responseParserHook::EMPTY_ELEMENT: + if(m_tagstack.size() == 1 && content == "fault") m_globalFault = true; + if( !m_globalFault ) handleElem(new Element(content,m_nextAttributeList,vector())); + else handleGlobalFaultElem(new Element(content,m_nextAttributeList,vector())); + m_nextAttributeList.clear(); + break; + case responseParserHook::ATTRIBUTE_VALUE: + m_nextAttributeValue = content; + break; + default: + string msg = Logger::getMessageFormatString(Logger::UnknownCallbackInXMLParser); + boost::format fmt(msg); + fmt % type % content; + Logger::log(Logger::FATAL,fmt.str()); + break; + } + return true; +} diff --git a/hsacppcli/hsadminc/source/transaction.h b/hsacppcli/hsadminc/source/transaction.h new file mode 100644 index 0000000..7bdba03 --- /dev/null +++ b/hsacppcli/hsadminc/source/transaction.h @@ -0,0 +1,77 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "cmdlineparser.h" +#include "xmlparser.h" + +#include +#include +#include +#include +#include + +#ifndef HSADMIN_TRANSACTION +#define HSADMIN_TRANSACTION + +using boost::shared_ptr; +using std::stack; +using std::map; +using std::vector; +using std::string; + +//! encapsulates a transaction. +class Transaction: + public abstractcommandlineparser::CmdLineParser, + public xmlParser::responseParserHook { + public: + //! parses all the commandline-Parameters + Transaction(vector options); + + string& getUser() { return m_parsed->m_user; }; + //! actually execute the transaction - just needs the config and does everything else for you + void operator()(shared_ptr cfgfile); + + //! callback for XML-Parser + virtual bool operator()(int type, string content); + + //! returns the parsed parameters + shared_ptr getParsed() { return m_parsed; }; + + private: + bool m_globalFault; + int m_currentCall; + stack m_tagstack; + string m_nextAttributeValue; + map m_nextAttributeList; + + void handleElem(xmlParser::Element * elem); + void handleGlobalFaultElem(xmlParser::Element * elem); + + string replaceEntities(const string &input); + string getContent(xmlParser::Element* value); + xmlParser::Element* stepin(int count,xmlParser::Element* value); + + public: + xmlParser::Element *m_docelem; +}; + +#else +class Transaction; +#endif /* HSADMIN_TRANSACTION */ diff --git a/hsacppcli/hsadminc/source/xmlparser.cpp b/hsacppcli/hsadminc/source/xmlparser.cpp new file mode 100644 index 0000000..9e5152c --- /dev/null +++ b/hsacppcli/hsadminc/source/xmlparser.cpp @@ -0,0 +1,209 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "xmlparser.h" +#include "logger.h" + +namespace xmlParser { + +bool parser::operator()(const string& content, int &pos, responseParserHook *hook) { return false; } + +bool spaceParser::operator()(const string& content, int &pos, responseParserHook *hook) { + if( content[pos] == ' ' || content[pos] == '\t' || content[pos] == '\n' || content[pos] == '\r' ) { + pos++; return true; + } + return false; +} + +bool commentParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content.substr(pos,4) == "" && pos < content.length() ) pos++; + if(pos < content.length()) { + pos += 3; return (*hook)(8,content.substr(oldpos+4,(pos-oldpos)-7)); + } + pos = oldpos; + return false; + } + return false; +} + +bool nameParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( !( (content[pos] >= '0' && content[pos] <= '9' ) || + (content[pos] >= 'a' && content[pos] <= 'z' ) || + (content[pos] >= 'A' && content[pos] <= 'Z' ) || + content[pos] == '.' || + content[pos] == ':' || + content[pos] == '_' ) ) + return false; + while( (content[pos] >= '0' && content[pos] <= '9' ) || + (content[pos] >= 'a' && content[pos] <= 'z' ) || + (content[pos] >= 'A' && content[pos] <= 'Z' ) || + content[pos] == '.' || + content[pos] == ':' || + content[pos] == '_' ) pos++; + return true; +} + +bool attributeValueParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content[pos] == '"' ) { + pos++; + while( content[pos] != '"' && pos < content.length() ) pos++; + if( pos >= content.length() ) { pos = oldpos; return false; } + pos++; + } + else if( content[pos] == '\'' ) { + pos++; + while( content[pos] != '\'' && pos < content.length() ) pos++; + if( pos >= content.length() ) { pos = oldpos; return false; } + pos++; + } else { + pos = oldpos; + return false; + } + return (*hook)(32,content.substr(oldpos+1,(pos-oldpos)-2)); +} + +bool attributeParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( ! space(content,pos,hook) ) return false; + while(space(content,pos,hook) && pos < content.length() ); + int namestartpos = pos; + if( ! name(content,pos,hook) ) { pos = oldpos; return false; } + int nameendpos = pos; + if( content[pos] != '=' ) { pos = oldpos; return false; } + pos++; + if( ! value(content,pos,hook) ) { pos = oldpos; return false; } + return (*hook)(2,content.substr(oldpos+1,(nameendpos-oldpos)-1)); +}; + +bool emptyelemParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content[pos] != '<' ) return false; + pos++; + if( !name(content,pos,hook) ) { pos = oldpos; return false; } + int nameendpos = pos; + + while(attrib(content,pos,hook) && pos < content.length() ); + while(space(content,pos,hook) && pos < content.length() ); + if( content.substr(pos,2) != "/>" ) { pos = oldpos; return false; } + pos += 2; + return (*hook)(18,content.substr(oldpos+1,(nameendpos-oldpos)-1)); +} + +bool startelemParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content[pos] != '<' ) return false; + pos++; + if( !name(content,pos,hook) ) { pos = oldpos; return false; } + int nameendpos = pos; + + while(attrib(content,pos,hook) && pos < content.length() ); + while(space(content,pos,hook) && pos < content.length() ); + if( content[pos] != '>' ) { pos = oldpos; return false; } + pos ++; + + return (*hook)(16,content.substr(oldpos+1,(nameendpos-oldpos)-1)); +} + +bool endelemParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content.substr(pos,2) != "' ) { pos = oldpos; return false; } + pos ++; + + return (*hook)(17,content.substr(oldpos+2,(nameendpos-oldpos)-2)); +} + +bool textParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content[pos] == '<' ) + return false; + while( content[pos] != '<' && pos < content.length() ) pos++; + return (*hook)(3,content.substr(oldpos,pos-oldpos)); +}; + +bool cdataParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content.substr(pos,9) != "") ) && pos < content.length() ) pos++; + if( !foundend ) { pos = oldpos; return false; } + pos += 3; + return (*hook)(4,content.substr(oldpos+9,(pos-oldpos)-12)); +}; + +bool elemParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( emptyelem(content,pos,hook) ) return (*hook)(1,content.substr(oldpos,pos-oldpos)); + if( ! elemstart(content,pos,hook) ) return false; + + bool foundend = false; + while( !(foundend = endelem(content,pos,hook)) && pos < content.length() ) { + if( ! ( comspace(content,pos,hook) || + text(content,pos,hook) || + (*this)(content,pos,hook) || + cdata(content,pos,hook) ) ) { + pos = oldpos; + return false; + } + } + if( foundend ) return (*hook)(1,content.substr(oldpos,pos-oldpos)); + return false; +} + +bool xmlpcParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( content.substr(pos,5) != "" ) { pos = oldpos; return false; } + pos += 2; + return (*hook)(7,string("xml")); +} + +bool XMLParser::operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + while(space(content,pos,hook) && pos < content.length() ); + if( ! xmlpc(content,pos,hook) ) { pos = oldpos; return false; } + while(comspace(content,pos,hook) && pos < content.length() ); + if( ! elem(content,pos,hook) ) { pos = oldpos; return false; } + while(comspace(content,pos,hook) && pos < content.length() ); + return (*hook)(9,content.substr(oldpos,pos-oldpos)); +} + +bool ResponseParser::operator()(const string& content, responseParserHook *hook) { + int pos = 0; + bool rval = xml(content,pos,hook); + if( pos < content.length() ) return false; + return rval; +} + +} diff --git a/hsacppcli/hsadminc/source/xmlparser.h b/hsacppcli/hsadminc/source/xmlparser.h new file mode 100644 index 0000000..2d57009 --- /dev/null +++ b/hsacppcli/hsadminc/source/xmlparser.h @@ -0,0 +1,296 @@ +/*************************************************************************** + * Copyright (C) 2005 by Christof Donat * + * cdonat@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include +#include +#include + +#ifndef HSADMIN_XMLPARSER +#define HSADMIN_XMLPARSER + +/** \brief a general XML Parser + * + * well, it works for me. The API is inspired a bit by SAX, but I didn't + * whant to create the full SAX API. + */ +namespace xmlParser { + +using std::string; +using std::map; +using std::vector; + +//! Node Types +typedef enum { + UNKNOWN = 0, + ELEMENT = 1, + ATTRIBUTE = 2, + TEXT = 3, + CDATA = 4, + PROCESSING_INSTRUCTION = 7, + COMMENT = 8, + DOCUMENT = 9, + +} nodeType; + +//! base class for all Nodes +class Node { + public: + Node(nodeType type): m_type(type) {}; + Node(): m_type(UNKNOWN) {}; + nodeType m_type; +}; + +//! Text node +class Text: public Node { + public: + Text(): m_content(""), Node::Node(TEXT) {}; + //! create a Text node from a C++ String + Text(string content): m_content(content), Node::Node(TEXT) {}; + //! copy-construct a Text node + Text(const Text &text): m_content(text.m_content), Node::Node(TEXT) {}; + + //! the actual text + string m_content; +}; + +//! Element node +class Element: public Node { + public: + Element(): + m_nodes(vector(0)), + m_attributes(map()), + m_name(""), + Node::Node(ELEMENT) {}; + //! create a Element from its tag-name , a List of Attributes and a List of Child-Nodes + Element(string name, map attributes, vector content): + m_nodes(content), + m_attributes(attributes), + m_name(name), + Node::Node(ELEMENT) {}; + //! copy-construct a Element Node + Element(const Element &elm): + m_nodes(elm.m_nodes), + m_attributes(elm.m_attributes), + m_name(elm.m_name), + Node::Node(ELEMENT) {}; + + //! The tag name + string m_name; + //! the attributes + map m_attributes; + //! che child nodes + vector m_nodes; +}; + +//! the XML parser calls the operator() for everything it finds +class responseParserHook { + public: + enum { + ELEMENT = 1, + ATTRIBUTE = 2, + TEXT = 3, + CDATA = 4, + PROCESSING_INSTRUCTION = 7, + COMMENT = 8, + DOCUMENT = 9, + START_ELEMENT = 16, + END_ELEMENT = 17, + EMPTY_ELEMENT = 18, + ATTRIBUTE_VALUE = 32, + }; + + virtual bool operator()(int type, string content) = 0; +}; + +//! a dummy Parser; the general parser base class +class parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +/** \brief Template to construct a Parser from two parsers. + * + * combines the results of the two parsers with 'or'. + */ +template class orRule : public parser { + public: + inline bool operator()(const string& content, int &pos, responseParserHook *hook) { + int oldpos = pos; + if( !car(content,pos,hook) ) return cdr(content,pos,hook); + return true; + }; + private: + first car; + second cdr; +}; + +//! parse everything that is a space +class spaceParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse XML comments +class commentParser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse either spaces or comments +typedef orRule comspaceParser; + +//! parse XML names +class nameParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse XML attribute values +class attributeValueParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse XML attributes with name and value +class attributeParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + nameParser name; + spaceParser space; + attributeValueParser value; +}; + +//! parse an empty element +class emptyelemParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + nameParser name; + attributeParser attrib; + spaceParser space; +}; + +//! parse the start of an element +class startelemParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + nameParser name; + attributeParser attrib; + spaceParser space; +}; + +//! parse the end of an element +class endelemParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + nameParser name; + spaceParser space; +}; + +//! parse Text +class textParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse CDATA-sections +class cdataParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); +}; + +//! parse general Elements +class elemParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + emptyelemParser emptyelem; + startelemParser elemstart; + comspaceParser comspace; + endelemParser endelem; + textParser text; + cdataParser cdata; +}; + +//! parse the xml Processing instruction at the beginning of each XML-File +class xmlpcParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + + private: + nameParser name; + attributeParser attrib; + spaceParser space; +}; + +//! parse an XML-File +class XMLParser: public parser { + public: + bool operator()(const string& content, int &pos, responseParserHook *hook); + private: + spaceParser space; + xmlpcParser xmlpc; + comspaceParser comspace; + elemParser elem; +}; + +//! just a convenient wraper around the XMLParser +class ResponseParser { + public: + bool operator()(const string& content, responseParserHook *hook); + private: + XMLParser xml; +}; + +} + +#else /* HSADMIN_XMLPARSER */ + +namespace xmlParser { + +class responseParserHook; +class parser; +template class orRule; +class spaceParser; +class commentParser; +class nameParser; +class attributeValueParser; +class attributeParser; +class emptyelemParser; +class startelemParser; +class endelemParser; +class textParser; +class cdataParser; +class elemParser; +class xmlpcParser; +class XMLParser; +class ResponseParser; + +} + +#endif /* HSADMIN_XMLPARSER */