From c1e4a2a84ea753afb96ac7920cf71327f1dc73d8 Mon Sep 17 00:00:00 2001 From: rettenbe Date: Mon, 4 Aug 2008 09:44:12 +0000 Subject: [PATCH] Doxygen configuration file and comment lines for doxygen at clMessages git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@12132 594d385d-05f5-0310-b6e9-bd551577e9d8 --- gosa-si/Doxyfile | 305 ++++++++++++++++++++++++++++ gosa-si/server/events/clMessages.pm | 112 +++++----- 2 files changed, 370 insertions(+), 47 deletions(-) create mode 100644 gosa-si/Doxyfile diff --git a/gosa-si/Doxyfile b/gosa-si/Doxyfile new file mode 100644 index 000000000..250d3774c --- /dev/null +++ b/gosa-si/Doxyfile @@ -0,0 +1,305 @@ +# Doxyfile 1.5.6 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = GOsa-SI +PROJECT_NUMBER = 1.0 +OUTPUT_DIRECTORY = /var/www/gosa/trunk/gosa-si/ +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = /home/rettenbe/ +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_DIRECTORIES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = /var/www/gosa/trunk/gosa-si/ +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.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 \ + *.vhd \ + *.vhdl \ + *.C \ + *.CC \ + *.C++ \ + *.II \ + *.I++ \ + *.H \ + *.HH \ + *.H++ \ + *.CS \ + *.PHP \ + *.PHP3 \ + *.M \ + *.MM \ + *.PY \ + *.F90 \ + *.F \ + *.VHD \ + *.VHDL \ + *.pm +RECURSIVE = YES +EXCLUDE = /var/www/gosa/trunk/gosa-si/debian/ +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = doxygenfilter +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +HTML_DYNAMIC_SECTIONS = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NONE +TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = YES +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +DOT_FONTNAME = FreeSans +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 1000 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO diff --git a/gosa-si/server/events/clMessages.pm b/gosa-si/server/events/clMessages.pm index 3a77ea982..4157f2153 100644 --- a/gosa-si/server/events/clMessages.pm +++ b/gosa-si/server/events/clMessages.pm @@ -1,9 +1,6 @@ ## @file # @brief Implementation of a GOsa-SI event module. # @details A GOsa-SI event module containing all functions to handle incoming messages from clients. -# @author Andreas Rettenberger -# @date 2008 -# @version 1.0 package clMessages; use Exporter; @@ -36,25 +33,6 @@ BEGIN {} END {} -### Start ###################################################################### - -# labled for deleting: rettenbe 20080730 -#my $ldap_uri; -#my $ldap_base; -#my $ldap_admin_dn; -#my $ldap_admin_password; -# -#my %cfg_defaults = ( -#"server" => { -# "ldap-uri" => [\$ldap_uri, ""], -# "ldap-base" => [\$ldap_base, ""], -# "ldap-admin-dn" => [\$ldap_admin_dn, ""], -# "ldap-admin-password" => [\$ldap_admin_password, ""], -# }, -#); -#&read_configfile($main::cfg_file, %cfg_defaults); -# - ## @method get_events() # @details A brief function returning a list of functions which are exported by importing the module. @@ -63,7 +41,11 @@ sub get_events { return \@events; } - +## @method confirm_usr_msg() +# @details Confirmed messages are set in the messaging_db from d (deliverd) to s(seen). +# @param msg - STRING - xml message with tags 'message', 'subject' and 'usr' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub confirm_usr_msg { my ($msg, $msg_hash, $session_id) = @_; my $message = @{$msg_hash->{'message'}}[0]; @@ -80,29 +62,11 @@ sub confirm_usr_msg { } - -#sub read_configfile { -# my ($cfg_file, %cfg_defaults) = @_; -# my $cfg; -# -# if( defined( $cfg_file) && ( (-s $cfg_file) > 0 )) { -# if( -r $cfg_file ) { -# $cfg = Config::IniFiles->new( -file => $cfg_file ); -# } else { -# &main::daemon_log("ERROR: clMessages.pm couldn't read config file!", 1); -# } -# } else { -# $cfg = Config::IniFiles->new() ; -# } -# foreach my $section (keys %cfg_defaults) { -# foreach my $param (keys %{$cfg_defaults{ $section }}) { -# my $pinfo = $cfg_defaults{ $section }{ $param }; -# ${@$pinfo[0]} = $cfg->val( $section, $param, @$pinfo[1] ); -# } -# } -#} - - +## @method save_fai_log() +# @details Creates under /var/log/fai/ the directory '$macaddress' and stores within all FAI log files from client. +# @param msg - STRING - xml message with tags 'macaddress' and 'save_fai_log' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub save_fai_log { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -142,7 +106,11 @@ sub save_fai_log { return; } - +## @method LOGIN() +# @details Reported user from client is added to login_users_db. +# @param msg - STRING - xml message with tag 'LOGIN' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub LOGIN { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -165,6 +133,11 @@ sub LOGIN { } +## @method LOGOUT() +# @details Reported user from client is deleted from login_users_db. +# @param msg - STRING - xml message with tag 'LOGOUT' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub LOGOUT { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -179,6 +152,11 @@ sub LOGOUT { } +## @method CURRENTLY_LOGGED_IN() +# @details Reported users from client are updated in login_users_db. Users which are no longer logged in are deleted from DB. +# @param msg - STRING - xml message +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub CURRENTLY_LOGGED_IN { my ($msg, $msg_hash, $session_id) = @_; my ($sql_statement, $db_res); @@ -234,6 +212,11 @@ sub CURRENTLY_LOGGED_IN { } +## @method GOTOACTIVATION() +# @details Client is set at job_queue_db to status 'processing' and 'modified'. +# @param msg - STRING - xml message with tag 'macaddress' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub GOTOACTIVATION { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -257,6 +240,11 @@ sub GOTOACTIVATION { } +## @method PROGRESS() +# @details Message reports installation progress of the client. Installation job at job_queue_db is going to be updated. +# @param msg - STRING - xml message with tags 'macaddress' and 'PROGRESS' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub PROGRESS { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -281,6 +269,11 @@ sub PROGRESS { } +## @method FAIREBOOT() +# @details Message reports a FAI reboot. Job at job_queue_db is going to be updated. +# @param msg - STRING - xml message with tag 'macaddress' and 'FAIREBOOT' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub FAIREBOOT { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -305,6 +298,11 @@ sub FAIREBOOT { } +## @method TASKSKIP() +# @details Message reports a skipped FAI task. Job at job_queue_db is going to be updated. +# @param msg - STRING - xml message with tag 'macaddress'. +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub TASKSKIP { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -329,6 +327,11 @@ sub TASKSKIP { } +## @method TASKBEGIN() +# @details Message reports a starting FAI task. If the task is equal to 'finish', 'faiend' or 'savelog', job at job_queue_db is being set to status 'done' and FAI state is being set to 'localboot'. If task is equal to 'chboot', 'test' or 'confdir', just do nothing. In all other cases, job at job_queue_db is going to be updated or created if not exists. +# @param msg - STRING - xml message with tag 'macaddress'. +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub TASKBEGIN { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -451,6 +454,11 @@ sub TASKBEGIN { } +## @method TASKEND() +# @details Message reports a finished FAI task. If task is equal to 'savelog', job at job_queue_db is going to be set to status 'done'. Otherwise, job is going to be updated. +# @param msg - STRING - xml message with tag 'macaddress'. +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub TASKEND { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -488,6 +496,11 @@ sub TASKEND { } +## @method TASKERROR() +# @details Message reports a FAI error. Job at job_queue_db is going to be updated. +# @param msg - STRING - xml message with tag 'macaddress' and 'TASKERROR' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub TASKERROR { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; @@ -515,6 +528,11 @@ sub TASKERROR { } +## @method HOOK() +# @details Message reports a FAI hook. Job at job_queue_db is going to be updated. +# @param msg - STRING - xml message with tag 'macaddress' and 'HOOK' +# @param msg_hash - HASHREF - message information parsed into a hash +# @param session_id - INTEGER - POE session id of the processing of this message sub HOOK { my ($msg, $msg_hash, $session_id) = @_; my $header = @{$msg_hash->{'header'}}[0]; -- 2.30.2