From: root@iserv.zuhause.test Date: Sat, 12 Jul 2008 01:45:54 +0000 (+0200) Subject: imported sources X-Git-Tag: REL_3.0-beta~37 X-Git-Url: https://git.rohieb.name/iserv-mod-room-reservation.git/commitdiff_plain/5760b2a8d146d7c186daab1743c84683d0d84cea?room=%22.qu%28stripslashes%28%24room%29%29.%22;start=%24nFirstWeek imported sources --- 5760b2a8d146d7c186daab1743c84683d0d84cea diff --git a/Doxyfile b/Doxyfile new file mode 100755 index 0000000..960f7fe --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1225 @@ +# Doxyfile 1.5.5 + +# 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 +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = iserv-room-reservation + +# 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 = 3.0 + +# 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/source + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = YES + +# 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 is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = YES + +# 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 = YES + +# 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 = + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = YES + +# 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 = YES + +# 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 = 4 + +# 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 + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If 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 = YES + +# 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 = + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = + +# 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 = + +# 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 = + +# 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 = + +# 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 = + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = YES + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST = YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# 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 = + +#--------------------------------------------------------------------------- +# 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 = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# 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 = includes + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# 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 = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The 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, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# 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 (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = NO + +# 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 = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_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 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 = + +# 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 = + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = YES + +# 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 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = YES + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = + +# 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 = + +# 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 = + +# 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 = + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = NO + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# 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 = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/Makefile b/Makefile new file mode 100755 index 0000000..c006596 --- /dev/null +++ b/Makefile @@ -0,0 +1,98 @@ +# +# @file Makefile +# Makefile for installing, creating documentation etc +# @author: Roland Hieber (roland.hieber@wilhelm-gym.net) +# @date: 12.11.2007 +# +# Copyright © 2007 Roland Hieber +# +# Permission is hereby granted, free of charge, to any person obtaining +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# + +SOURCEFILES=src/*.php includes/*.inc +MODULE_DOC_FILES=doc/source/html/* doc/source/latex/* +LN=ln -f +RM=rm -rf +MKDIR=mkdir -p + +# hardlink the files to their destinations +# TODO move documentation where Jörg wants it ;) +links: + $(MKDIR) /usr/share/doc/iserv/mod/room-reservation/source/ + $(LN) doc/{LICENSE*,TODO,changelog*} /usr/share/doc/iserv/mod/room-reservation/ + $(LN) doc/source/html/* /usr/share/doc/iserv/mod/room-reservation/source/ + + $(LN) img/16/*.png /usr/share/iserv/www/img/default/16/ + $(LN) img/24/*.png /usr/share/iserv/www/img/default/24/ + $(LN) img/32/*.png /usr/share/iserv/www/img/default/32/ + + $(MKDIR) /usr/share/iserv/www/inc/mod_room-reservation + $(LN) includes/*.inc /usr/share/iserv/www/inc/mod_room-reservation/ + chmod 664 /usr/share/iserv/www/inc/mod_room-reservation/config.inc + chown www-data /usr/share/iserv/www/inc/mod_room-reservation/config.inc + + $(LN) lang/*.po /usr/share/iserv/locale/de/ + + $(LN) nav/*.mod /usr/share/iserv/www/nav/ + $(LN) nav/admin/*.mod /usr/share/iserv/www/nav/admin + + $(LN) priv/* /usr/share/iserv/priv/ + + $(LN) sql/*.sql /usr/share/iserv/db/ + + $(MKDIR) /usr/share/iserv/www/mod_room-reservation/admin + $(LN) src/{index.php,stat.png.php} /usr/share/iserv/www/mod_room-reservation/ + $(LN) src/admin/config.php /usr/share/iserv/www/mod_room-reservation/admin/ + +# build doxygen documentation from source +sourcedoc: + doxygen + +# install everything +install: sourcedoc links + chkdb -r + chkpriv + + @if [ -z "`psql -qc "SELECT * FROM log_module;" 2>&1 |grep ERROR`" -a -z \ + "`psql -qc \"SELECT COUNT(*) FROM log_module WHERE module = 'Room Reservation Schedule';\" 2>&1 |grep ' 1'`" ]; then \ + echo psql -c "INSERT INTO log_module VALUES('Room Reservation Schedule');"; \ + psql -c "INSERT INTO log_module VALUES('Room Reservation Schedule');"; \ + fi; + chklocale + +# uninstalling +uninstall: + $(RM) /usr/share/doc/iserv/mod/mod_room-reservation + $(RM) /usr/share/iserv/locale/de/mod_room-reservation.po + $(RM) /usr/share/iserv/db/mod_room-reservation.sql + $(RM) /usr/share/iserv/www/nav/79mod_room-reservation.mod + $(RM) /usr/share/iserv/priv/mod_room-reservation + $(RM) /usr/share/iserv/www/nav/admin/99mod_room-reservation.mod + $(RM) /usr/share/iserv/www/img/default/{16,24,32}/mod_room-reservation_{timeslice,index,config}.png + $(RM) /usr/share/iserv/www/inc/mod_room-reservation + $(RM) /usr/share/iserv/www/mod_room-reservation + + chklocale + + @echo ---------------------------------------------------------------------- + @echo If you do not need the SQL tables anymore, remove them by running + @echo ' psql -c "DROP TABLE mod_room-reservation;"' + @echo ' psql -c "DROP SEQUENCE mod_room-reservation_rr_uid_seq;"' + @echo After that, all bookings are unrecoverably deleted! + @echo ---------------------------------------------------------------------- diff --git a/doc/LICENSE b/doc/LICENSE new file mode 100755 index 0000000..117b83d --- /dev/null +++ b/doc/LICENSE @@ -0,0 +1,46 @@ +== License == + +The module has been released under the terms of the MIT License, as printed +following in its original version. Some images which have been used have been +released under the terms of the GNU Lesser General Public License (see +http://www.fsf.org/licensing/licenses/lgpl.html). These are in particular: + * /usr/share/iserv/www/img/default/16/mod_room-reservation_config.png + * /usr/share/iserv/www/img/default/16/mod_room-reservation_index.png + * /usr/share/iserv/www/img/default/32/mod_room-reservation_config.png + * /usr/share/iserv/www/img/default/32/mod_room-reservation_index.png + +If you enjoy this software, you are free to support his author with a small +donation: + + Roland Hieber + IBAN: DE98 250 500 000 150 2141 79 + BIC: NOLADE2HXXX (Braunschweigische Landessparkasse) + +You can also send material donations to + Roland Hieber + 21944471 + Packstation 103 + 38106 Braunschweig + GERMANY + + +=== License terms === +Copyright (c) 2007 Roland Hieber + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/doc/LICENSE.de b/doc/LICENSE.de new file mode 100755 index 0000000..0a0c9ef --- /dev/null +++ b/doc/LICENSE.de @@ -0,0 +1,67 @@ +== Lizenz == + +Das Modul wurde unter der MIT-Lizenz veröffentlicht, die nachfolgend in ihrer +Originalversion wiedergegeben ist. Einige Symbole, die benutzt werden, wurden +unter der GNU Lesser General Public License veröffentlicht (siehe +http://www.fsf.org/licensing/licenses/lgpl.html). Dies sind im folgenden: + * /usr/share/iserv/www/img/default/16/mod_room-reservation_config.png + * /usr/share/iserv/www/img/default/16/mod_room-reservation_index.png + * /usr/share/iserv/www/img/default/32/mod_room-reservation_config.png + * /usr/share/iserv/www/img/default/32/mod_room-reservation_index.png + +Das Modul ist Donationware, d. h. wenn der Benutzer Gefallen daran findet, +ist es ihm freigestellt, den Autor mit einer kleinen Spende zu unterstützen: + + Roland Hieber + Kto. Nr. 150 214 179 + Braunschweigische Landessparkasse + BLZ 250 500 00 + +Materielle Spenden an: + Roland Hieber + 21944471 + Packstation 103 + 38106 Braunschweig + + +=== Lizenztext === +Copyright (c) 2008 Roland Hieber + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +=== Deutsche Übersetzung: === +Copyright (c) 2008 Roland Hieber + +Hiermit wird die Erlaubnis an jede Person, die eine Kopie der Software und der +zugehörigen Dokumentationen (der "Software") erhält, gegeben, die Software +kostenlos zu benutzen, inklusive dem Recht, diese zu verändern, fusionieren, +verlegen, verbreiten, unterlizenzieren und/oder verkaufen, und Personen, die +diese Software erhalten, diese Rechte zu geben, unter den nachfolgenden +Bedingungen: + +Der obige Urheberrechtsvermerk und dieser Erlaubnisvermerk sind in alle Kopien +oder Teilkopien der Software zu inkludieren. + +DIE SOFTWARE WIRD OHNE JEDE SPEZIELLE ODER IMPLIZIERTE GARANTIE VERGEBEN, DIES +SCHLIESST DIE GARANTIE ZUR BENUTZUNG FÜR EINEN BESTIMMTEN ZWECK UND RECHTS- +VERLETZUNG EIN, IST ABER NICHT DARAUF BESCHRÄNKT. AUF KEINEN FALL SIND DIE +AUTOREN ODER COPYRIGHTINHABER FÜR JEGLICHEN SCHADEN VERANTWORTLICH, OB IN EINEM +VERTRAG, DELIKT ODER ANDERS, WELCHER DURCH DIE BENUTZUNG DER SOFTWARE ENTSTEHT. + diff --git a/doc/TODO b/doc/TODO new file mode 100755 index 0000000..47ce0ea --- /dev/null +++ b/doc/TODO @@ -0,0 +1,24 @@ += TO DO = + +== Wichtig == +- VOR PACKAGE: config.inc auf Standardwerte setzen + + +=== Bugs: === +- Wenn eine einmalige Buchung erstellt wird, kann an diesem Termin keine feste Buchung mehr erstellt werden. + Feste Buchungen sind aber vorrangig! + => am besten bei fester Buchung Abfrage, ob der Benutzer mit lockerer Buchung per Mail benachrichtigt werden soll +- Räume mit + sind nicht möglich => URL-Kodierung fehlt (https://mzbs.de/idesk/msg/msg.php?forums/public/Module/Raumbelegungsplan/156) +- Nach dem Löschen wieder zur vorigen Ansicht zurückkehren (https://mzbs.de/idesk/msg/msg.php?forums/public/Module/Raumbelegungsplan/157) +- Zeitauswahl bei Buchung auch mit Stunden (1.-10. Stunde statt 7:45-16:15) oder gleich beides möglich machen + + +== Features == +- ordentliche Statistik? +- Räume "buchbar" machen, d.h. andere Räume werden nicht zur Buchungsauswahl angezeigt + => Realisierung per SQL-Tabelle, um die Fremdschlüssel einhalten zu können + +== Erstmal unwichtig == +- Ferientermine mit einbauen => keine Buchungen dann möglich bzw. Warnung + Vielleicht als ICS-Import oder gleich aus dem Kalender übernehmen? +- Dokumentation der SQL-Tabelle und der Konfigurationsoptionen \ No newline at end of file diff --git a/doc/changelog.html b/doc/changelog.html new file mode 100755 index 0000000..5a2c964 --- /dev/null +++ b/doc/changelog.html @@ -0,0 +1,100 @@ + + + IServ – Raumbelegungsplan – Changelog + + + + + +

Changelog

+

iserv-room-reservation-3.0

+ +Release: +
    +
  • Umbenennung, um Kollisionen zu vermeiden
    • +
  • Angepasst an IServ 2
      +
    • Zugriffssteuerung über Sonderrechte (Gruppen-Verwaltung)
      + Achtung: Wenn eines der drei vom Raumbelegungsplan benutzten Sonderrechte keiner Gruppe + zugewiesen wird, besitzen alle Benutzer dieses Portalservers das entsprechende Sonderrecht!
      • +
    • Räume werden in der Rechnerverwaltung angelegt
      • +
    • Komplette Neuentwicklung des Quellcodes auf Basis von PHP 5
      • +
    • +
  • Alle Formulare werden innerhalb der Tabelle angezeigt, ebenso die + dazugehörigen Meldungen
      +
    • Neu eingefügte Buchungen werden farblich markiert
      • +
    • Administrations-Seite zum Anlegen von periodischen Buchungen entfällt
      • +
    • + +
  • Algorithmus zum Zeichnen der Buchungstabelle schlanker gemacht
    • +
  • Dokumentation des Quellcodes
    • +
  • Konfiguration durch sinnvolle Vorgaben vereinfacht
    • +
  • Statistik ist weggefallen; macht auch nur wirklich Sinn, solange Buchungen nicht gelöscht werden
    • +
  • Reparierte Fehler:
    • +
+ +

iserv-rooms-2.3

+Release: 2. Juni 2007 +
    +
  • Wiederkehrende und einmalige Buchungen werden farblich unterschieden
    • +
  • Löschen von Buchungen möglich
      +
    • Benutzer können selbst vorgenommene Buchungen löschen
      • +
    • Raumbelegunsplan-Admins können alle Buchungen löschen
      • +
    • Raumbelegunsplan-Admins können in der Konfiguration festgelegt werden
      • +
    • +
  • Reparierte Fehler:
    • +
+ +

iserv-rooms-2.2

+Release: 1. Mai 2007 +
    +
  • Konfiguration: Fehlerüberprüfung für Zeitangaben hinzugefügt
    • +
  • Konfiguration: Zeitangaben auch in der Form 7.45 statt 7:45 möglich
    • +
  • Statistik nur für Mitglieder der erlaubten Gruppen sichtbar machen
    • +
  • Lizenz: Notiz, dass manche Symbole unter der GNU LGPL stehen
    • +
  • Reparierte Fehler:
      +
    • Code gegen unerwünschtes HTML, Cross-Site Scripting und SQL-Injections abgesichert
      • +
    • Fehler bei Neuinstallation als RPM und anschließender Konfiguration lieferte Warning: implode(): Bad arguments. in /opt/iserv/idesk/rooms/admin/config.php on line 168
    +
+ +

iserv-rooms-2.1

+Release: 25. Februar 2007 + + +

iserv-rooms-2.0-2

+Release: 28. August 2006 +
    +
  • RPM repariert, die SQL-Tabellen wurden bei einem Update erst angelegt und dann wieder gelöscht
    • +
  • Admin-Bereich: Wochentage werden wieder angezeigt
    • +
+ +

iserv-rooms-2.0-1

+Release: 28. August 2006 +
    +
  • Statistik hinzugefügt und damit Option „Abgelaufene Buchungen löschen“ repariert
    • +
  • SQL-Tabelle wird bei der Installation erstellt, nicht vom Konfigurations-Skript, dadurch Zugriffsprobleme beseitigt.
    • +
  • Modul ist nur von bestimmten Gruppen nutzbar, in Konfiguration einstellbar
    • +
  • Stundenplanansicht im Benutzerbereich
    • +
  • Lizenz: Donationware
    • +
  • Konfiguration wird bei Update nicht mehr überschrieben
    • +
  • Wochenende optional anschaltbar
    • +
+ + + diff --git a/img/16/mod_room-reservation_config.png b/img/16/mod_room-reservation_config.png new file mode 100644 index 0000000..5b5261b Binary files /dev/null and b/img/16/mod_room-reservation_config.png differ diff --git a/img/16/mod_room-reservation_index.png b/img/16/mod_room-reservation_index.png new file mode 100644 index 0000000..8d5b17b Binary files /dev/null and b/img/16/mod_room-reservation_index.png differ diff --git a/img/24/mod_room-reservation_timeslice.png b/img/24/mod_room-reservation_timeslice.png new file mode 100755 index 0000000..ee35861 Binary files /dev/null and b/img/24/mod_room-reservation_timeslice.png differ diff --git a/img/32/mod_room-reservation_config.png b/img/32/mod_room-reservation_config.png new file mode 100644 index 0000000..ddaaeb0 Binary files /dev/null and b/img/32/mod_room-reservation_config.png differ diff --git a/img/32/mod_room-reservation_index.png b/img/32/mod_room-reservation_index.png new file mode 100644 index 0000000..ccb3211 Binary files /dev/null and b/img/32/mod_room-reservation_index.png differ diff --git a/includes/config.inc b/includes/config.inc new file mode 100755 index 0000000..8ae6f37 --- /dev/null +++ b/includes/config.inc @@ -0,0 +1,15 @@ +flushTimeslices(); +$this->addTimeslice(new mod_roomReservationTimeslice(25200, 30600)); +$this->addTimeslice(new mod_roomReservationTimeslice(32400, 37800)); +$this->addTimeslice(new mod_roomReservationTimeslice(39600, 45000)); +$this->addTimeslice(new mod_roomReservationTimeslice(50400, 55800)); +$this->addTimeslice(new mod_roomReservationTimeslice(57600, 63000)); +$this->addTimeslice(new mod_roomReservationTimeslice(64800, 70200)); +$this->setShowWeekend(true); +$this->setShowLessons(false); +?> \ No newline at end of file diff --git a/includes/exceptions.inc b/includes/exceptions.inc new file mode 100755 index 0000000..8d7c688 --- /dev/null +++ b/includes/exceptions.inc @@ -0,0 +1,44 @@ + \ No newline at end of file diff --git a/includes/functions.inc b/includes/functions.inc new file mode 100755 index 0000000..1704bc5 --- /dev/null +++ b/includes/functions.inc @@ -0,0 +1,276 @@ + 0); +} + +/** + * Get the real user name for an account name + * @param $strAct (string) Account name of the user to look up + * @return (string) The real name of the user. If the function fails, it returns null. + * Call getLastError() to get more information about the error. + */ +function getRealUserName($strAct) { + $hQuery = db_query("SELECT firstname, lastname FROM users WHERE act = $1;", $strAct); + if(!is_resource($hQuery)) { + // TODO throw exception + setLastError(RS_ERROR_SQL); + return null; + } + if(pg_num_rows($hQuery) == 0) { + return $strAct; // User not found in database, return account name + } + $arResult = pg_fetch_array($hQuery); + return user_join_name($arResult); +} + +/** + * Determine if a specified group exists + * @param $strAct (string) Account name of the group + * @return (bool / null) If the function fails, it returns null. Call getLastError() to + * get more information about the error. + */ +function isGroup($strAct) { + $hQuery = db_query("SELECT * FROM groups WHERE act = $1;", $strAct); + if(!is_resource($hQuery)) { + // TODO throw exception + setLastError(RS_ERROR_SQL); + return null; + } + return (pg_num_rows($hQuery) > 0); +} + +/** + * Look up the name of a group + * @param $strAct (string) Account name of the group + * @return (string) The name of the group. If the function fails, it returns null. + * Call getLastError() to get more information about the error. + */ +function getGroupName($strAct) { + $hQuery = db_query("SELECT * FROM groups WHERE act = $1;", $strAct); + if(!is_resource($hQuery)) { + // TODO throw exception + setLastError(RS_ERROR_SQL); + return null; + } + if(pg_num_rows($hQuery) == 0) { + return $strAct; // Group not found in database, return account name + } + $arResult = pg_fetch_array($hQuery); + return $arResult["name"]; +} + +/** + * Create a link to write a mail to the specified account name. + * This function returns a link if the specified account exists, otherwise it returns the + * account name. + * @param $strAct (string) Account name + * @param $strColor (string) Background color for icon() + * @param $strParams (string) additional URL parameters + * @return string + */ +function mailToUserLink($strAct, $strColor = "bl", $strParams = "") { + if(!isAct($strAct)) { + return $strAct; + } + return popup(relroot("msg/write/?to=".user_mail_addr($strAct).$strParams), + 600, 400, nobr(icon("mail-reply-usr", array("size" => 16, "bg" => + $strColor)) . getRealUserName($strAct))); +} + +/** + * Determine if a specified string is a valid mail address + * @param $strAddr string + * @return string + */ +function isMailAddress($strAddr) { + return ((preg_match("/([a-zA-Z0-9_\-\.]*(@[a-zA-Z0-9\-\.]*)?(\s*,\s*)?)+/", $strAddr) > 0) + and (preg_match("/(\s*,\s*)$/", $strAddr) == 0)); +} + +/** + * Module-specific logging function. + * Prefixes the log message with a module-specific string and writes it to the logs. + * @param $strLog (string) Log message + * @return void + */ +function rrInsertLog($strLog) { + log_insert("Raumbelegungsplan: " . $strLog); +} + +/** + * Get the SQL day number from a given timestamp. + * @param $ts (timestamp) + * @return (int) 0-6 for Sunday to Monday + */ +function rrDateToSQLDayNumber($ts) { + $aDays = array("Sun" => 0, "Mon" => 1, "Tue" => 2, + "Wed" => 3, "Thu" => 4, "Fri" => 5, "Sat" => 6); + return $aDays[date("D", $ts)]; +} + +/** + * Convert a UNIX timestamp to an SQL date string + * @param $ts (timestamp) + * @return string + */ +function dateToSql($ts) { return date("Y\-m\-d", intval($ts)); } + +/** + * Calculate the timestamp of the monday in the current week + * @param $ts (timestamp) Calculate the value relative to this date + * @return timestamp + */ +function rrGetMonday($ts = null) { + if($ts === null) { + $ts = time(); + } + if(date("D", $ts) == "Mon") { + // Today is monday + return strtotime("00:00", $ts); + } else { + return strtotime("last monday", $ts); + } +} + +/** (array of strings) Additional CSS rules */ +$rsLocalCss = array(); + +/** + * Add CSS rules to the page + * @param $s (string) + * @return void + */ +function rrAddCss($s) { + rrDebug("rsAddCss: add \"$s\""); + $GLOBALS["rsLocalCss"][] = $s; +} + +/** + * Get CSS rules that have been added with rmAddCss() + * @return string + */ +function rrGetCSS() { + rrDebug("rsGetCss: Local CSS is ".var_export($GLOBALS["rsLocalCss"], true)); + return implode("\n", $GLOBALS["rsLocalCss"]); +} + +function rrDebug($s, $bReturn = false) { + if(isset($_GET["debug"])) { + if(!$bReturn) { + echo "\n"; + } else { + return $s; + } + } +} + +/** + * sprintf with support for ordinal numbers. + * This version of sprintf replaces all substrings of the type /\\d+#/ + * (i.e. a decimal number with a hash sign appended) in the input string with + * the corresponding english ordinal number prefices (st, nd, rd, th). + * @param $str (string) Input string + * @param $args (mixed) Additional parameters to be passed to sprintf() + * @return (string) + */ +function _sprintf_ord($str, $args /*leave this parameters for doxygen*/) { + $args = func_get_args(); + if(preg_match_all("/%[bcdufosxX]/", $args[0], $temp) != func_num_args()-1) { + trigger_error("Too few arguments", E_USER_ERROR); + return false; + } + $str = call_user_func_array("sprintf", $args); + while(preg_match("/(.*)(\d+)#(.*)/", $str, $m)) + $str = $m[1]._(append_ord_suffix($m[2])).$m[3]; + return $str; +} +?> diff --git a/includes/globals.inc b/includes/globals.inc new file mode 100755 index 0000000..067ab4c --- /dev/null +++ b/includes/globals.inc @@ -0,0 +1,47 @@ + diff --git a/includes/mod_roomReservationBooking.inc b/includes/mod_roomReservationBooking.inc new file mode 100755 index 0000000..a6a1c8a --- /dev/null +++ b/includes/mod_roomReservationBooking.inc @@ -0,0 +1,201 @@ +setUid(null); + $this->setRoom($strRoom); + $this->setDate($tsDate); + $this->setTsFirst($nTsFirst); + $this->setTsLast($nTsLast); + $this->setAct($strAct); + $this->setReason($strReason); + $this->setInterval($nInterval); + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the unique ID in database + * @param $n (int) Unique ID in database + * @return void + */ + public function setUid($n) { + if(is_null($n)) { + $this->nUid = null; + } else { + $this->nUid = intval($n); + } + } + + /** + * Set the name of the room + * @param $str (string) Name of the room + * @return void + */ + public function setRoom($str) { $this->strRoom = $str; } + + /** + * Set the date when the booking takes place + * @param $ts (timestamp) Date, only the date part is taken care of + * @return void + */ + public function setDate($ts) { + // Only take the date part + $this->tsDate = intval(strtotime(date("Y\-m\-d", intval($ts)))); } + + /** + * Set the first timeslice + * @param $n (int) Number of the first timeslice + * @return void + */ + public function setTsFirst($n) { $this->nTsFirst = intval($n); } + + /** + * Set the end timeslice + * @param $n (int) Number of the last timeslice (may be the start timeslice) + * @return void + */ + public function setTsLast($n) { $this->nTsLast = intval($n); } + + /** + * Set the account name of the owner + * @param $str (string) Account name + * @return void + */ + public function setAct($str) { $this->strAct = $str; } + + /** + * Set the reason for the booking + * @param $str (string) Reason + * @return void + */ + public function setReason($str) { $this->strReason = $str; } + + /** + * Set the flag whether the booking repeates every week + * @param $n (int) interval in weeks, 0 for no recurrence + * @return void + */ + public function setInterval($n) { $this->nInterval = intval(abs($n)); } + + /** + * Get the unique ID in database + * @return int / null + */ + public function getUid() { return intval($this->nUid); } + + /** + * Get the name of the room + * @return string + */ + public function getRoom() { return $this->strRoom; } + + /** + * Get the date when the booking takes place + * @return timestamp + */ + public function getDate() { return intval($this->tsDate); } + + /** + * Get the the number of the first timeslice + * @return int + */ + public function getTsFirst() { return intval($this->nTsFirst); } + + /** + * Get the number of the last timeslice (may be the start timeslice) + * @return int + */ + public function getTsLast() { return intval($this->nTsLast); } + + /** + * Get the account name of the owner + * @return string + */ + public function getAct() { return $this->strAct; } + + /** + * Get the reason for the booking + * @return string + */ + public function getReason() { return $this->strReason; } + + /** + * Get the recurrence interval + * @return int + */ + public function getInterval() { return $this->nInterval; } + + /**@}*/ +} +?> diff --git a/includes/mod_roomReservationBookingPage.inc b/includes/mod_roomReservationBookingPage.inc new file mode 100755 index 0000000..f01423c --- /dev/null +++ b/includes/mod_roomReservationBookingPage.inc @@ -0,0 +1,212 @@ +oCfg = $oCfg; + $this->oRm = $oRm; + $this->oBm = $oBm; + + // create the booking table here, so the CSS is already added + /** @todo maybe move it into beforeAddCSS()... ? */ + $this->oBt = new mod_roomReservationBookingsTable($this->oCfg, $this->oRm, + $this->oBm, "?bookingpage[action]=edit", "?bookingpage[action]=delete"); + + parent::__construct($oCfg); + $this->setTitle(_c("Room Reservation Schedule")); + $this->setIcon("mod_room-reservation_index"); + } + + /***************************************************************************/ + /** + * @} + * @name Initialization + * @{ + */ + + /** + * Process the REQUEST variables and preset the some variables + * @return void + */ + protected function processRequestVariables() { + // take all settings from the booking table + $this->setRoom($this->oBt->getRoom()); + $this->setStart($this->oBt->getDate()); + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the starting date + * @param $ts (timestamp) + */ + public function setStart($ts) { $this->tsStart = intval($ts); } + + /** + * Set the room to show in the booking table + * @param $str (string) Name of the room + */ + public function setRoom($str) { $this->strRoom = $str; } + + /** + * Get the starting date + * @return int + */ + public function getStart() { return intval($this->tsStart); } + + /** + * Get the name of the room to show in the booking table + * @return string + */ + public function getRoom() { return $this->strRoom; } + + /***************************************************************************/ + /** + * @} + * @name Output + * @{ + */ + + /** + * Show the page. + * @return void + */ + public function doShow() { + // Protect access + if(!$this->oCfg->userCanView()) { + echo sprintf("

%s

", + MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED); + _PageBlue(); + die(); + } + + if($this->oRm->getRooms() == array()) { + echo sprintf("

%s

\n", _c("room-reservation:No rooms have been ". + "configured yet.")); + _PageBlue(); + die(); + } + + Title(_c("room-reservation:Book rooms")); + + // Form for room selection + /** @todo checkbox for recurring booking */ + echo sprintf("
", + $_SERVER["PHP_SELF"]); + echo sprintf("\n", $this->getStart()); + echo _c("room-reservation:Room:") . sprintf("  <%s value='%s' />

\n", + $GLOBALS["stdbtn"], _("Change")); + + // Print line with next 5 or so weeks + $strSep = " | "; + $strLink = sprintf("%%s", + $_SERVER["PHP_SELF"]); + echo "

".sprintf($strLink, time(), qu($this->getRoom()), + _c("room-reservation:Current Week")) . $strSep; + echo sprintf($strLink, strtotime("1 week ago", $this->getStart()), + qu($this->getRoom()), _c("room-reservation:< Back")) . $strSep; + echo sprintf("%s", _sprintf_ord(_c("room-reservation:%d# week"), + date("W", $this->getStart()))) . $strSep; + for($i = 1; $i <= 5; $i++) { + $nNextWeek = strtotime("$i week", $this->getStart()); + echo sprintf($strLink, $nNextWeek, qu($this->getRoom()), _sprintf_ord( + _c("room-reservation:%d# week"), date("W", $nNextWeek))); + echo $strSep; + } + echo sprintf($strLink, strtotime("1 week", $this->getStart()), + qu($this->getRoom()), _c("room-reservation:Next >"))."

\n"; + + $this->oBt->show(); + + parent::endShow(); + } +} +?> diff --git a/includes/mod_roomReservationBookingTable.inc b/includes/mod_roomReservationBookingTable.inc new file mode 100755 index 0000000..c325d88 --- /dev/null +++ b/includes/mod_roomReservationBookingTable.inc @@ -0,0 +1,766 @@ +oCfg = $oCfg; + $this->oRm = $oRm; + $this->oBm = $oBm; + + $this->processRequestVariables(); + $this->addCSS(); + } + + /***************************************************************************/ + /** + * @} + * @name Initialization + * @{ + */ + + /** + * Process the REQUEST variables and preset the some variables + * @return void + */ + protected function processRequestVariables() { + + ######################## + # FIXME remove this + var_export($_GET); echo "

"; + var_export($_POST); echo "

"; + ######################## + + // default values + $aoRooms = $this->oRm->getRooms(); + if($aoRooms != array()) { + $or = $aoRooms[0]; + $this->setRoom($or->getName()); + } + $this->setDate(time()); + $this->setAction(MOD_ROOM_RESERVATION_BT_ACTION_SHOW); + $this->nPostInterval = 0; + + // handle GET parameters + if(isset($_GET["mod_roomReservationBookingTable"])) { + $ga = isset($_GET["mod_roomReservationBookingTable"]["action"]) ? + $_GET["mod_roomReservationBookingTable"]["action"] : ""; + $this->setAction(($ga == "book") ? + MOD_ROOM_RESERVATION_BT_ACTION_BOOK : (($ga == "edit") ? + MOD_ROOM_RESERVATION_BT_ACTION_EDIT : (($ga == "delete") ? + MOD_ROOM_RESERVATION_BT_ACTION_DELETE : (($ga == "submit") ? + MOD_ROOM_RESERVATION_BT_ACTION_SUBMIT : (($ga == "submitdelete") ? + MOD_ROOM_RESERVATION_BT_ACTION_SUBMITDELETE : + MOD_ROOM_RESERVATION_BT_ACTION_SHOW))))); + $this->setDate(isset($_GET["mod_roomReservationBookingTable"]["date"]) ? + intval($_GET["mod_roomReservationBookingTable"]["date"]) : time()); + $this->setRoom(isset($_GET["mod_roomReservationBookingTable"]["room"]) ? + $_GET["mod_roomReservationBookingTable"]["room"] : ""); + $this->setTsFirst( + isset($_GET["mod_roomReservationBookingTable"]["tsfirst"]) ? + intval($_GET["mod_roomReservationBookingTable"]["tsfirst"]) : 0); + $this->setTsLast($this->getTsFirst()); + + // if deletion form is requested, set the right date, room etc. + if($this->getAction() == MOD_ROOM_RESERVATION_BT_ACTION_DELETE) { + if(isset($_GET["mod_roomReservationBookingTable"]["uid"]) && + $_GET["mod_roomReservationBookingTable"]["uid"] >= 0) { + $this->setUid(intval( + $_GET["mod_roomReservationBookingTable"]["uid"])); + } else { + trigger_error("The UID is invalid.", E_USER_ERROR); + } + $ob = mod_roomReservationBookingsManager::getBookingByUid( + $this->getUid()); + $this->setRoom($ob->getRoom()); + if($ob->getInterval() > 0) { + // don't show the first date when the booking was created, but the + // date of the page where the user clicked the delete button + $this->setDate( + isset($_GET["mod_roomReservationBookingTable"]["date"]) ? + intval($_GET["mod_roomReservationBookingTable"]["date"]) : time()); + } else { + $this->setDate($ob->getDate()); + } + $this->setTsFirst($ob->getTsFirst()); + } + } + + if(isset($_POST["mod_roomReservationBookingTable"])) { + if(isset($_POST["mod_roomReservationBookingTable"]["submitbooking"])) { + // submission of the booking form + // let POST variables overwrite the variables + $this->setDate( + isset($_POST["mod_roomReservationBookingTable"]["date"]) ? + intval($_POST["mod_roomReservationBookingTable"]["date"]) : time()); + $this->setRoom( + isset($_POST["mod_roomReservationBookingTable"]["room"]) ? + $_POST["mod_roomReservationBookingTable"]["room"] : ""); + $this->setTsFirst( + isset($_POST["mod_roomReservationBookingTable"]["tsfirst"]) ? + intval($_POST["mod_roomReservationBookingTable"]["tsfirst"]) : 0); + $this->setTsLast( + isset($_POST["mod_roomReservationBookingTable"]["tslast"]) ? + intval($_POST["mod_roomReservationBookingTable"]["tslast"]) : + $this->getTsFirst()); + $this->setReason( + isset($_POST["mod_roomReservationBookingTable"]["reason"]) ? + $_POST["mod_roomReservationBookingTable"]["reason"] : ""); + $this->nPostInterval = + isset($_POST["mod_roomReservationBookingTable"]["interval"]) ? + intval($_POST["mod_roomReservationBookingTable"]["interval"]) : 0; + $this->strPostAccount = + isset($_POST["mod_roomReservationBookingTable"]["account"]) ? + $_POST["mod_roomReservationBookingTable"]["account"] : ""; + } + + if(isset($_POST["mod_roomReservationBookingTable"]["submitdelete"])) { + // submission of the deletion form + if(isset($_POST["mod_roomReservationBookingTable"]["uid"]) && + $_POST["mod_roomReservationBookingTable"]["uid"] >= 0) { + $this->setUid( + intval($_POST["mod_roomReservationBookingTable"]["uid"])); + } else { + trigger_error("The UID is invalid.", E_USER_ERROR); + } + // set the right date, room etc. + $ob = mod_roomReservationBookingsManager::getBookingByUid( + $this->getUid()); + $this->setRoom($ob->getRoom()); + $this->setDate($ob->getDate()); + $this->setTsFirst($ob->getTsFirst()); + $this->setSubmitButtonValue(isset( + $_POST["mod_roomReservationBookingTable"]["submitdelete"]) ? + $_POST["mod_roomReservationBookingTable"]["submitdelete"] : ""); + } + } + + ################ + /** FIXME remove this */ + echo sprintf("date: %s
", $this->getDate()); + echo sprintf("room: %s
", $this->getRoom()); + echo sprintf("reason: %s
", $this->getReason()); + echo sprintf("tsfirst: %s
", $this->getTsFirst()); + echo sprintf("tslast: %s
", $this->getTsLast()); + echo sprintf("action: %s
", $this->getAction()); + ################ + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the action that should be done + * @param $c (constant) See @ref bookingtable_actions for possible values + */ + protected function setAction($c) { $this->cAction = intval($c); } + + /** + * Set the starting timeslice of the requested booking + * @param $n (int) + */ + protected function setTsFirst($n) { $this->nTsFirst = intval($n); } + + /** + * Set the ending timeslice of the requested booking + * @param $n (int) + */ + protected function setTsLast($n) { $this->nTsLast = intval($n); } + + /** + * Set the date of the requested booking or the date to be shown in the + * booking table + * @param $ts (timestamp) + */ + public function setDate($ts) { $this->tsDate = intval($ts); } + + /** + * Set the room of the requested booking or the room to be shown in the + * booking table + * @param $str (string) + */ + protected function setRoom($str) { $this->strRoom = $str; } + + /** + * Set the reason of the requested booking + * @param $str (string) + */ + protected function setReason($str) { $this->strReason = $str; } + + /** + * Set the UID of the booking to be deleted / edited + * @param $n (int) + */ + protected function setUid($n) { $this->nUid = intval($n); } + + /** + * Set the value of the submit button that the user clicked + * @param $str (string) + */ + protected function setSubmitButtonValue($str) { + $this->strSubmitButtonValue = $str; + } + + /** + * Get the name of the room of the requested booking or the room to show in + * the booking table + * @return string + */ + public function getRoom() { return $this->strRoom; } + + /** + * Get the action that should be done + * @return constant See @ref bookingtable_actions for possible values + */ + public function getAction() { return $this->cAction; } + + /** + * Get the the starting timeslice of the requested booking + * @return int + */ + public function getTsFirst() { return $this->nTsFirst; } + + /** + * Get the the ending timeslice of the requested booking + * @return int + */ + public function getTsLast() { return $this->nTsLast; } + + /** + * Get the the date of the requested booking or the date to be shown in the + * booking table + * @return timestamp + */ + public function getDate() { return $this->tsDate; } + + /** + * Get the the reason of the requested booking + * @return string + */ + public function getReason() { return $this->strReason; } + + /** + * Get the UID of the booking to be deleted / edited + * @return int + */ + public function getUid() { return $this->nUid; } + + /** + * Get the value of the submit button that the user clicked + * @return string + */ + public function getSubmitButtonValue() { + return $this->strSubmitButtonValue; + } + + /***************************************************************************/ + /** + * @} + * @name Output + * @{ + */ + + /** + * Add the CSS rules needed for this page + * @return void + */ + protected function addCSS() { + $strCss = <<oCfg->isShowWeekend()) { + $strCss .= "#mod_roomReservationBookingTable td.cell { width:13%; }"; + } else { + $strCss .= "#mod_roomReservationBookingTable td.cell { width:18.2%; }"; + } + rrAddCss($strCss); + } + + /** + * Show the timetable + * @return void + * @throws AccessException + * @todo increase the height of the cells a little + */ + public function show() { + // Protect access + if(!$this->oCfg->userCanView()) { + throw new AccessException(MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED); + return; + } + + // Print the header with the days + $ncTs = sizeof($this->oCfg->getTimeslices()); + $nDays = ($this->oCfg->isShowWeekend()) ? 7 : 5; + + echo ""; + + // Print header with day names + echo "", $strClass, $strTitle); + } + echo "\n"; + + // Print timetable + // To take care of bookings with more than one timeslice, we use an array + // that tells us which cell in the current column is the next to fill + $anNextRow = array_fill(0, $nDays, 0); + // Iterate over the timeslices + for($nTs = 0; $nTs < $ncTs; $nTs++) { + $strLessons = $this->oCfg->isShowLessons() ?_sprintf_ord( + _c("room-reservation:%s# lesson"), $nTs + 1) . "
" : ""; + $oTs = $this->oCfg->getTimeslice($nTs); + $strTs = sprintf("%s - %s", strftime(_("%#I:%M %p"), $oTs->getBegin()), + strftime(_("%#I:%M %p"), $oTs->getEnd())); + // First column: Lesson + echo sprintf("", $strLessons . $strTs); + + // Iterate over the days + for($ts = rrGetMonday($this->getDate()), $i = 0; $i <= $nDays; + $ts = strtotime("1 day", $ts), $i++) { + // Don't print if there is a spanning booking on the current cell + if(isset($anNextRow[$i]) && $anNextRow[$i] == $nTs) { + if(($ob = $this->oBm->getBookingByTimeslice($this->getRoom(), $ts, + $nTs)) !== null) { + // a booking exists here + // print booking or deletion form or handle the deletion form + + // deletion form is requested: + if(($this->getAction() == MOD_ROOM_RESERVATION_BT_ACTION_DELETE) && + (date("Ymd", $this->getDate()) == date("Ymd", $ts)) && + ($this->getTsFirst() == $nTs) && + ($this->getRoom() == $this->getRoom())) { + $anNextRow[$i] += $this->printBooking($nTs, $ts, $ob, + MOD_ROOM_RESERVATION_BTPB_DELETE); + + // deletion form is submitted: + } else if(($this->getAction() == + MOD_ROOM_RESERVATION_BT_ACTION_SUBMITDELETE) && + (date("Ymd", $this->getDate()) == date("Ymd", $ts)) && + ($this->getTsFirst() == $nTs) && + ($this->getRoom() == $this->getRoom())) { + if($this->getSubmitButtonValue() == _("Delete")) { + // the user clicked the "delete" button + $bSuccess = false; + try { + $bSuccess = $this->oBm->delete($this->getUid()); + } catch(Exception $e) { + $anNextRow[$i] += $this->printBooking($nTs, $ts, $ob, 0, + array($e->getMessage())); + } + // print booking link and a success message + if($bSuccess) { + $anNextRow[$i] += $this->printBookingLink($nTs, $ts, + array(_c("room-reservation:The booking was deleted."))); + } + } else { + // the user cancelled the request + $anNextRow[$i] += $this->printBooking($nTs, $ts, $ob); + } + + // Something else -- print booking + } else { + $anNextRow[$i] += $this->printBooking($nTs, $ts, $ob); + } + } else { + // no booking is here + // print booking link, booking form or handle booking form + $asErrors = array(); + + // booking form is requested: + if(($this->getAction() == MOD_ROOM_RESERVATION_BT_ACTION_BOOK) && + (date("Ymd", $this->getDate()) == date("Ymd", $ts)) && + ($this->getTsFirst() == $nTs) && + ($this->getRoom() == $this->getRoom())) { + $anNextRow[$i] += $this->printBookingForm($nTs, $ts, $asErrors); + + // booking form is submitted: + } else if(($this->getAction() == + MOD_ROOM_RESERVATION_BT_ACTION_SUBMIT) && + // only handle the request if the form was in the current cell + (date("Ymd", $this->getDate()) == date("Ymd", $ts)) && + ($this->getTsFirst() == $nTs) && + ($this->getRoom() == $this->getRoom())) { + + // try writing the booking to the database + $nNewUid = -1; + $oNewBooking = new mod_roomReservationBooking($this->getRoom(), + $this->getDate(), $this->getTsFirst(), $this->getTsLast(), + (trim($this->strPostAccount) == "") ? $_SESSION["act"] : + $this->strPostAccount, $this->getReason(), + $this->nPostInterval); + try { + $nNewUid = $this->oBm->write($oNewBooking); + } catch(Exception $s) { + // print the booking form again with the user's input + // @todo check for overlapping bookings and print them + $asErrors[] = $s->getMessage(); + $anNextRow[$i] += $this->printBookingForm($nTs, $ts, + $asErrors); + } + if($nNewUid > 0) { + // print new booking and increment the "next row" variable by + // the current span + $anNextRow[$i] += $this->printBooking($nTs, $ts, $oNewBooking, + MOD_ROOM_RESERVATION_BTPB_NEW); + } + + // Something else -- print booking link: + } else { + $anNextRow[$i] += $this->printBookingLink($nTs, $ts); + } + } + } + } + echo "\n"; + } + echo "
"; + for($ts = rrGetMonday($this->getDate()), $i=0; $i < $nDays; + $ts = strtotime("1 day", $ts), $i++) { + // Use a different color for the current day + $strClass = "heading"; + $strTitle = strftime("%A
%x", $ts); + if(date("Ymd") === date("Ymd", $ts)) { + $strClass .= " today"; + $strTitle .= " "._c("room-reservation:(today)"); + } + echo sprintf("		%s
%s

"; + } + + /** + * Print a single booking in the booking table. + * @param $nTs (int) current timeslice + * @param $ts (timestamp) current date + * @param $ob (mod_roomReservationBooking) the booking + * @param $cFlags (constant) Flags, + * See @ref bookingtable_printbooking_flags for more information. + * @param $asMsgs (array of strings) Additional messages to be printed + * inside the cell, one array element per message + * @return (int) the span of the booking + */ + protected function printBooking($nTs, $ts, mod_roomReservationBooking $ob, + $cFlags = 0, $asMsgs = array()) { + $strAfter = ""; + $strBefore = ""; + + // messages + if(count($asMsgs) > 0) { + $strBefore .= "

".nl2br(q(join("\n", $asMsgs)))."

\n"; + } + + // calculate the timespan of the current booking + $nSpan = $ob->getTsLast() - $ob->getTsFirst() + 1; + + if(($cFlags & MOD_ROOM_RESERVATION_BTPB_DELETE) == + MOD_ROOM_RESERVATION_BTPB_DELETE) { + + // Restrict access + if(!($this->oBm->userIsOwner($ob->getUid()) or + $this->oCfg->userIsAdmin())) { + $strBefore .= "

" . + MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED . "

\n"; + #return $nSpan; + } else { + // print delete form + $strWarning = sprintf("
%s%s
", icon("dlg-warn", + array("bg" =>"gb")), _c("room-reservation:Attention: This ". + "booking is a recurring booking. If you delete it, the period will ". + "be deallocated for every week, not just this single week!")); + $strAfter .= sprintf("

%s%s
<%s name='mod_roomReservationBookingTable". + "[submitdelete]' value='%s' /> <%s name='". + "mod_roomReservationBookingTable[submitdelete]' value='%s' />". + "

", $_SERVER["PHP_SELF"], + _c("room-reservation:Delete this booking?"), + ($ob->getInterval() > 0 ? $strWarning : ""), $GLOBALS["smlbtn"], + _("Delete"), $GLOBALS["smlbtn"], _("Cancel"), $ob->getUid(), + $this->getRoom(), $this->getDate()); + } + } else { + // delete and edit links, show only if user is allowed to + if($this->oBm->userIsOwner($ob->getUid()) || + $this->oCfg->userIsAdmin()) { + /** @todo edit form */ + $strAfter .= sprintf("
(". + "%s)", + $_SERVER["PHP_SELF"], $ob->getUid(), $ts, + _c("room-reservation:Edit this booking"), + _c("room-reservation:edit"), $_SERVER["PHP_SELF"], $ob->getUid(), + $ts, _c("room-reservation:Delete this booking"), + _c("room-reservation:delete")); + } + } + + // test if booking is new and should be highlighted + $strClass = "cell booking".($ob->getInterval() > 0 ? " recurring" : ""); + if(($cFlags & MOD_ROOM_RESERVATION_BTPB_NEW) == + MOD_ROOM_RESERVATION_BTPB_NEW) { + $strClass .= " new"; + } + // Use a different style for the current day + $strClass .= (date("Ymd", $ob->getDate()) == date("Ymd") ? " today" : ""); + /** @todo: add ?subject=... to mailto link */ + echo sprintf("%s%s
%s%s\n", + $nSpan, $strClass, $strBefore, mailto($ob->getAct()), + q(getRealUserName($ob->getAct())), q($ob->getReason()), $strAfter); + + return $nSpan; + } + + /** + * Print the booking form. + * @param $nTs (int) current timeslice + * @param $ts (timestamp) current date + * @param $asErrors (array of strings) Additional error message to be printed + * inside the cell, one array element per message + * @return (int) the span of the booking (i.e., 1) + */ + protected function printBookingForm($nTs, $ts, $asErrors = array()) { + // Restrict access + if(!($this->oCfg->userCanBook() or $this->oCfg->userIsAdmin())) { + printf("%s\n", + MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED); + return 1; + } + + $strErrors = "

".nl2br(q(join("\n", $asErrors)))."

"; + + // form to allow fixed bookings for admins + $sWeeklyForm = ""; + if($this->oCfg->userIsAdmin()) { + $sWeeklyForm = sprintf(" %s
". + " <%s name='". + "mod_roomReservationBookingTable[account]' id='account' value='%s' ". + "size='15' />
", _c("room-reservation:Repetition:"), + select("mod_roomReservationBookingTable[interval]", + $this->nPostInterval, array(0 => _c("Select:None"), 1 => + _c("room-reservation:every week")), array("add" => "id='interval'")), + _c("room-reservation:Account, if not yourself:"), $GLOBALS["stdedt"], + $this->strPostAccount); + } + + echo sprintf("%s". + "
%s". + "
<%s id='reason' size='15' ". + "value='%s' name='mod_roomReservationBookingTable[reason]' />
%s". + "<%s name='mod_roomReservationBookingTable[submitbooking]' value='%s' />". + "
\n", (count($asErrors) > 0) ? $strErrors : "", + $_SERVER["PHP_SELF"], _c("room-reservation:until:"), + select("mod_roomReservationBookingTable[tslast]", $this->getTsLast(), + $this->oCfg->getTimesliceEndings(true)), _c("room-reservation:Reason:"), + $GLOBALS["stdedt"], $this->getReason(), $sWeeklyForm, $GLOBALS["smlbtn"], + _c("room-reservation:Book"), $this->getDate(), $this->getRoom(), + $this->getTsFirst()); + return 1; + } + + /** + * Print the booking link + * @param $nTs (int) current timeslice + * @param $ts (timestamp) current date + * @param $asMsgs (array of strings) Additional messages to be printed + * inside the cell, one array element per message + * @return (int) the span of the booking (i.e., 1) + */ + protected function printBookingLink($nTs, $ts, $asMsgs = array()) { + + // Restrict access + if(!($this->oCfg->userCanBook() or $this->oCfg->userIsAdmin())) { + echo "\n"; + return 1; + } + + // messages + $strBefore = ""; + if(count($asMsgs) > 0) { + $strBefore .= "

".join("
", $asMsgs)."

\n"; + } + + // print link to booking if the timeslice is later than now + $oTs = $this->oCfg->getTimeslice($nTs); + $tsCur = strtotime(date("Y-m-d ", $ts) . date(" G:i", + $oTs->getEnd())); + if($tsCur > time()) { + $strURL = $_SERVER["PHP_SELF"] . + sprintf("?mod_roomReservationBookingTable[action]=book&". + "mod_roomReservationBookingTable[date]=%d&". + "mod_roomReservationBookingTable[room]=%s&". + "mod_roomReservationBookingTable[tsfirst]=%d#form", $ts, + qu($this->getRoom()), $nTs); + echo sprintf("%s%s\n", + $strBefore, $strURL, _c("room-reservation:Book this room from here"), + _c("room-reservation:(Book from here)")); + } else { + // only print the messages + echo sprintf("%s\n", + $strBefore); + } + return 1; + } + /** @} */ +} +?> diff --git a/includes/mod_roomReservationBookingsManager.inc b/includes/mod_roomReservationBookingsManager.inc new file mode 100755 index 0000000..573f340 --- /dev/null +++ b/includes/mod_roomReservationBookingsManager.inc @@ -0,0 +1,263 @@ +oCfg = $oCfg; + } + + /***************************************************************************/ + /** + * @} + * @name Retrieving bookings + * @{ + */ + + /** + * Fetch a booking with the given unique ID from the SQL table + * @param $nUid (int) Unique ID of the booking + * @return mod_roomReservationBooking + */ + public static function getBookingByUid($nUid) { + $h = db_query("SELECT * FROM mod_roomreservation_bookings WHERE rrb_uid = $1;", $nUid); + $a = pg_fetch_array($h); + $o = new mod_roomReservationBooking($a["rrb_room"], strtotime($a["rrb_date"]), + intval($a["rrb_tsfirst"]), intval($a["rrb_tslast"]), $a["rrb_act"], + $a["rrb_reason"], intval($a["rrb_interval"])); + $o->setUid(intval($a["rrb_uid"])); + return $o; + } + + /** + * Test if there is a booking which takes place on the specified position at + * the specified date. + * @param $strRoom (string) Name of the room + * @param $tsDate (timestamp) The date + * @param $nTimeslice (int) The number of the timeslice + * @return mod_roomReservationBooking The booking which takes place on the + * specified time or null if no booking could be found. + */ + public static function getBookingByTimeslice($strRoom, $tsDate, + $nTimeslice) { + $a = mod_roomReservationBookingsManager::getOverlappingBookings( + new mod_roomReservationBooking($strRoom, $tsDate, $nTimeslice, + $nTimeslice, null, null)); + return isset($a[0]) ? $a[0] : null; + } + + /** + * Get all bookings in database which overlap with the given booking. + * @param $ob (mod_roomReservationBooking) New booking that should be tested + * if it overlaps + * @return array with elements of type mod_roomReservationBooking + */ + public static function getOverlappingBookings( + mod_roomReservationBooking $ob) { + // TODO: Test for bookings that only take place every n.th week (modulo n) + + // Two bookings overlap, when they are on the same day and if + // old beginning < new ending AND old ending > new beginning + $hQuery = db_query("SELECT * FROM mod_roomreservation_bookings WHERE ". + "rrb_room = $1 AND ((rrb_interval > 0 AND EXTRACT(DOW FROM rrb_date) ". + "= $2) OR (rrb_interval = 0 AND rrb_date = $3)) AND rrb_tsfirst <= ". + "$4 AND rrb_tslast >= $5 ORDER BY rrb_tsfirst;", $ob->getRoom(), + date("w", $ob->getDate()), date("Y-m-d", $ob->getDate()), + intval($ob->getTsLast()), intval($ob->getTsFirst())); + $aoReturn = array(); + while($aResult = pg_fetch_array($hQuery)) { + $aoReturn[] = mod_roomReservationBookingsManager::getBookingByUid( + $aResult["rrb_uid"]); + } + return $aoReturn; + } + + /***************************************************************************/ + /** + * @} + * @name Management of bookings + * @{ + */ + + /** + * Insert or update a booking in the database. + * The function throws an AccessException if the user was not allowed to + * write the booking, or an SQLException if there was an error while trying + * to insert or update the booking into the database. + * @param $ob (mod_roomReservationBooking) Booking to write to the database + * @return (int) The UID of the written booking + * @throws SQLException, AccessException + * @todo document + */ + function write(mod_roomReservationBooking $ob) { + // protect access + if(($ob->getUid() != null and !$this->oCfg->userIsAdmin() and + !$this->userIsOwner($ob->nUid)) or + ($ob->getUid() == null and !$this->oCfg->userCanBook())) { + throw new AccessException(MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED); + } + + $strWhere = null; + $strLog = ""; + + // check if everything is right and throw exceptions + if(trim($ob->getAct()) == "") { + $ob->setAct($SESSION["act"]); + } elseif(!isAct($ob->getAct())) { + throw new Exception(MOD_ROOM_RESERVATION_ERROR_NO_SUCH_ACCOUNT); + return false; + } + if($ob->getTsFirst() > $ob->getTsLast()) { + throw new SQLException(MOD_ROOM_RESERVATION_ERROR_END_BEFORE_BEGIN); + return false; + } + if(trim($ob->getReason()) == "") { + throw new SQLException(MOD_ROOM_RESERVATION_ERROR_NO_REASON); + return false; + } + + // Test for overlapping bookings + if($this->getOverlappingBookings($ob) != array()) { + throw new SQLException(MOD_ROOM_RESERVATION_ERROR_BOOKING_OVERLAPS); + return false; + } + + // @todo Show real times in log, take it from config + + // Update or insert? + if($ob->getUid() == null) { + // No UID yet, insert new booking + $strLog = sprintf("Raum „%s“ am %s von %s bis %s gebucht", + $ob->getRoom(), date("d\.m\.Y", $ob->getDate()), + intval($ob->getTsFirst()), intval($ob->getTsLast())); + } else { + // Update an existing booking + // @todo write old and new times into log + $strWhere = "rs_uid = ".qdb(intval($ob->getUid())); + $strLog = sprintf("Buchung im Raum „%s“ auf %s von %s bis %s ". + "geändert (Begründung: „%s“)", $ob->getRoom(), date("d\.m\.Y", + $ob->getDate()), intval($ob->getTsFirst()), + intval($ob->getTsLast()), $ob->getReason()); + } + $aPut["rrb_room"] = $ob->getRoom(); + $aPut["rrb_date"] = date("Y\-m\-d", $ob->getDate()); + $aPut["rrb_tsfirst"] = intval($ob->getTsFirst()); + $aPut["rrb_tslast"] = intval($ob->getTsLast()); + $aPut["rrb_act"] = $ob->getAct(); + $aPut["rrb_reason"] = $ob->getReason(); + $aPut["rrb_interval"] = intval($ob->getInterval()); + + // @todo test if the foreign keys are being violated and throw an error + // message if neccessary + db_store("mod_roomreservation_bookings", $aPut, $strWhere); + + $hQuery = db_query("SELECT currval('mod_roomreservation_bookings_rrb_uid_seq') ". + "FROM mod_roomreservation_bookings;"); + $nNewUid = pg_fetch_result($hQuery, 0, "currval"); + + rrInsertLog($strLog); + + // Return new UID + return $nNewUid; + } + + /** + * Delete a booking from the database + * @param $nUid (int) Unique ID of the booking + * @return (bool) true on success, otherwise false. + * @todo test + */ + public function delete($nUid) { + // Only administrators and owners are allowed to delete bookings + if(!($this->oCfg->userIsAdmin() or $this->userIsOwner($nUid))) { + throw new AccessException(MOD_ROOM_RESERVATION_ERROR_ACCESS_DENIED); + return false; + } + + // @todo: Show real times in log, take it from config + $ob = $this->getBookingByUid($nUid); + $strLog = sprintf("Buchung in Raum „%s“ am %s von %s bis %s ". + "gelöscht", $ob->getRoom(), date("d\.m\.Y", $ob->getDate()), + $ob->getTsFirst(), $ob->getTsLast()); + // Delete it from the database + if(!db_query("DELETE FROM mod_roomreservation_bookings WHERE ". + "rrb_uid = $1;", $nUid)) { + throw new SQLException(MOD_ROOM_RESERVATION_ERROR_SQL); + return false; + } else { + rrInsertLog($strLog); + return true; + } + } + + /** + * Determine if the current user is the owner of a specified error report. + * If this function fails, call getLastError() to get more information. + * @param $nID (int) Unique ID of the error report + * @throws SQLException + * @return bool + */ + public static function userIsOwner($nID) { + if(!isset($_SESSION["act"])) { + return false; // user is not logged in + } else { + $hQuery = db_query("SELECT rrb_act FROM mod_roomreservation_bookings WHERE ". + "rrb_uid = $1;", intval($nID)); + if(!is_resource($hQuery)) { + throw new SQLException(MOD_ROOM_RESERVATION_ERROR_SQL); + return false; + } + $arResult = pg_fetch_array($hQuery); + return ($arResult["rrb_act"] == $_SESSION["act"]); + } + } +} +?> diff --git a/includes/mod_roomReservationConfig.inc b/includes/mod_roomReservationConfig.inc new file mode 100755 index 0000000..9c02e3e --- /dev/null +++ b/includes/mod_roomReservationConfig.inc @@ -0,0 +1,385 @@ + 0; +} + +/** + * Retrieve all groups that have a privilege assigned + * @param $strPriv (string) Privilege to test + * @return array + */ +function rrPrivilegedGroups($strPriv) { + $aReturn = array(); + $h = db_query("SELECT act FROM privileges_assign WHERE privilege = $1 ". + "ORDER BY act;", $strPriv); + if(pg_num_rows($h) > 0) { + while($a = pg_fetch_array($h)) { + $aReturn[] = $a["act"]; + } + } + return $aReturn; +} + +/** + * User-defined compare function to compare timeslices + * @param $oTs1 (mod_roomReservationTimeslice) + * @param $oTs2 (mod_roomReservationTimeslice) + * @return (int) -1 if $oTs1 begins before $oTs2, + * 0 if the $oTs1 and $oTs2 have the same beginning, + * 1 if $oTs1 begins after $oTs2. + */ +function rrConfigSortTimeslices(mod_roomReservationTimeslice $oTs1, + mod_roomReservationTimeslice $oTs2) { + if($oTs1->getBegin() == $oTs2->getBegin()) { + return 0; + } else { + return ($oTs1->getBegin() > $oTs2->getBegin()) ? 1 : -1; + } +} + +define("MOD_ROOM_RESERVATION_CONFIGFILE_HEADER", "flushTimeslices(); + $this->setShowWeekend(false); + $this->setShowLessons(true); + $this->asMessages = array(); + + $this->readConfig(); + } + + /** + * ************************************************************************** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Add a timeslice. A check is done that the timeslices do not overlap, and + * in this case, an Exception is thrown. + * @param $oTs (mod_roomReservationTimeslice) + * @throws Exception + * @return void + */ + public function addTimeslice(mod_roomReservationTimeslice $oTs) { + // Check for overlapping timeslices + foreach($this->aoTimeslices as $oOldTs) { + if(($oOldTs->getBegin() < $oTs->getEnd() and + $oOldTs->getEnd() > $oTs->getBegin())) { + throw new Exception( + MOD_ROOM_RESERVATION_ERROR_CONFIG_OVERLAPPING_TIMESLICE); + } + } + $this->aoTimeslices[] = $oTs; + usort($this->aoTimeslices, "rrConfigSortTimeslices"); + return; + } + + /** + * Delete a timeslice + * @param $oTs (mod_roomReservationTimeslice) the timeslice to delete. If + * the timeslice is not found, an Exception is thrown. + * @throws Exception + * @return void + */ + public function deleteTimeslice(mod_roomReservationTimeslice $oTs) { + for($i = 0; $i < count($this->aoTimeslices); $i++) { + if($this->aoTimeslices[$i]->getBegin() == $oTs->getBegin() and + $this->aoTimeslices[$i]->getEnd() == $oTs->getEnd()) { + // use array_splice because it renumbers the keys + array_splice($this->aoTimeslices, $i, 1); + return; + } + } + throw new Exception(MOD_ROOM_RESERVATION_ERROR_CONFIG_NO_SUCH_TIMESLICE); + } + + /** + * Delete all timeslices. + * @return void + */ + public function flushTimeslices() { $this->aoTimeslices = array(); } + + /** + * Show or hide the weekend + * @param $b (bool) + */ + public function setShowWeekend($b) { $this->bShowWeekend = ($b == true); } + + /** + * Show or hide the lesson strings in the booking table + * @param $b (bool) + */ + public function setShowLessons($b) { $this->bShowLessons = ($b == true); } + + /** + * Add a message to the internal array of (error) messages + * @param $sMessage (string) + */ + public function addMessage($sMessage) { + array_merge($this->asMessages, array($sMessage)); + } + + /** + * Get all timeslices in chronological order + * @return array of rmTimeslice + */ + public function getTimeslices() { return $this->aoTimeslices; } + + /** + * Return the starting times of every timeslice + * @param $bFormat (bool) true: Format the times according to the + * current locale + * false: return just the timestamps + * @return array + */ + public function getTimesliceBeginnings($bFormat = false) { + $aot = $this->getTimeslices(); + $aRet = array(); + foreach($aot as $ao) { + $aRet[] = $bFormat ? _date("%#I:%M %p", $ao->getBegin()) : + $ao->getBegin(); + } + return $aRet; + } + + /** + * Return the ending times of every timeslice + * @param $bFormat (bool) true: Format the times according to the + * current locale + * false: return just the timestamps + * @return array + */ + public function getTimesliceEndings($bFormat = false) { + $aot = $this->getTimeslices(); + $aRet = array(); + foreach($aot as $ao) { + $aRet[] = $bFormat ? _date("%#I:%M %p", $ao->getEnd()) : $ao->getEnd(); + } + return $aRet; + } + + /** + * Get a timeslice + * @param $n (int) index of the timeslice in the array + * @return rmTimeslice + */ + public function getTimeslice($n) { return $this->aoTimeslices[$n]; } + + /** + * Determine if the weekend is shown + * @return bool + */ + public function isShowWeekend() { return ($this->bShowWeekend == true); } + + /** + * Determine if the lesson strings in the booking table are shown + * @return bool + * FIXME needed? + */ + public function isShowLessons() { return ($this->bShowLessons == true); } + + /** + * Determine if the current user has admin rights. This function tests + * if the user is in a group which has the privilege of admin rights. + * @todo test + * @return bool + */ + public function userIsAdmin() { + return secure_privilege("mod_roomreservation_admin"); + } + + /** + * Determine if the current user can book rooms. This function tests + * if the user is in a group which has the privilege to book rooms. + * If no group has this privilege, all users can book. + * @todo test + * @return bool + */ + public function userCanBook() { + if(!rrPrivilegeAssigned("mod_roomreservation_book")) { + // If the privilege is not assigned to any group, all users can book + return true; + } else { + // If user is admin, it makes sense that he can book rooms ;-) + return secure_privilege("mod_roomreservation_book") || + secure_privilege("mod_roomreservation_admin"); + } + } + + /** + * Determine if the current user can view bookings. This function tests + * if the user is in a group which has been configured as a group who + * can view bookings. If no groups are configured, any user can view the + * bookings table. + * @todo test + * @return bool + */ + public function userCanView() { + if(!rrPrivilegeAssigned("mod_roomreservation_view")) { + // If the privilege is not assigned to any group, all users can view + return true; + } else { + // If user is admin or can book, it makes sense that he can view bookings + return secure_privilege("mod_roomreservation_admin") || + secure_privilege("mod_roomreservation_book") || + secure_privilege("mod_roomreservation_view"); + } + } + + /** + * Get the messages that have been produced + * @return string + */ + public function getMessages() { + return join("\n", $this->asMessages); + } + + /***************************************************************************/ + /** + * @} + * @name Operations + * @{ + */ + + /** + * Write the current state of this instance to the config file. + * @throws IOException + * @return bool + */ + public function writeConfig() { + // Open config file + $hFile = fopen("mod_room-reservation/config.inc", "w", true); + if(!is_resource($hFile)) { + throw new IOException(MOD_ROOM_RESERVATION_ERROR_OPEN_FILE); + return false; + } + // Try to lock file repeatedly + for($n = 0; !flock($hFile, LOCK_EX); $n++) { + if($n > 10) { + throw new IOException(MOD_ROOM_RESERVATION_ERROR_OPEN_FILE); + return false; // Give up + } else { + sleep(0.2); // Retry after 100 ms + } + } + + // Create text for config file + $strFile = MOD_ROOM_RESERVATION_CONFIGFILE_HEADER; + + // Timeslices + $strFile .= "\$this->flushTimeslices();\n"; + foreach($this->getTimeslices() as $oTs) { + $strFile .= sprintf("\$this->addTimeslice(new ". + "mod_roomReservationTimeslice(%d, %d));\n", $oTs->getBegin(), + $oTs->getEnd()); + } + + // Show weekend + $strFile .= sprintf("\$this->setShowWeekend(%s);\n", + $this->isShowWeekend() ? "true" : "false"); + + // Show lessons + $strFile .= sprintf("\$this->setShowLessons(%s);\n", + $this->isShowLessons() ? "true" : "false"); + + $strFile .= "?>"; + + // Write to config file and unlock it + if(fwrite($hFile, $strFile) == false) { + throw new IOException(MOD_ROOM_RESERVATION_ERROR_WRITE_FILE); + return false; + } + if(!flock($hFile, LOCK_UN)) { + throw new IOException(MOD_ROOM_RESERVATION_ERROR_UNLOCK_FILE); + return false; + } + + rrInsertLog("Konfiguration verändert"); + return true; + } + + /** + * Read configuration from file. Returns false if an error occured, + * in this case getMessages() contains error messages. + * @return bool + */ + public function readConfig() { + global $g_rmCfg; + try { + require("mod_room-reservation/config.inc"); + } catch(Exception $e) { + $this->addMessage($e->getMessage()); + } + } + + /** @} */ +} +?> diff --git a/includes/mod_roomReservationConfigPage.inc b/includes/mod_roomReservationConfigPage.inc new file mode 100755 index 0000000..4c74132 --- /dev/null +++ b/includes/mod_roomReservationConfigPage.inc @@ -0,0 +1,173 @@ +setTitle(_c("room-reservation:Configuration")); + $this->setIcon("mod_room-reservation_config"); + } + + public function processRequestVariables() { + // default values + $this->bPostShowWeekend = $this->oCfg->isShowWeekend(); + $this->bPostShowLessons = $this->oCfg->isShowLessons(); + + if(isset($_POST["mod_roomReservationConfigPage"])) { + if(isset($_POST["mod_roomReservationConfigPage"]["showweekend"])) { + $this->bPostShowWeekend = + ($_POST["mod_roomReservationConfigPage"]["showweekend"] == true); + } + ########### + echo "bPostShowWeekend is ".($this->bPostShowWeekend?"true ":"false "); + ########### + + if(isset($_POST["mod_roomReservationConfigPage"]["showlessons"])) { + $this->bPostShowLessons = + ($_POST["mod_roomReservationConfigPage"]["showlessons"] == true); + } + ########### + echo "bPostShowLessons is ".($this->bPostShowLessons?"true ":"false "); + ########### + + // process the request + if(isset($_POST["mod_roomReservationConfigPage"]["submit"])) { + $this->oCfg->setShowWeekend($this->bPostShowWeekend); + $this->oCfg->setShowLessons($this->bPostShowLessons); + try { + $this->oCfg->writeConfig(); + } catch(Exception $e) { + $this->asMessages[] = $e->getMessage(); + } + } + } + } + + public function doShow() { + // error messages + if(count($this->asMessages) > 0) { + printf("

%s

", nl2br(q(join("\n", $this->asMessages)))); + } + + echo "". + "
\n"; // two rows + + GroupBox(_("Privileges"), "keys"); + $asAdminGroups = rrPrivilegedGroups("mod_roomreservation_admin"); + $asBookGroups = rrPrivilegedGroups("mod_roomreservation_book"); + $asViewGroups = rrPrivilegedGroups("mod_roomreservation_view"); + echo sprintf("

%s

\n

%s

\n

%s

", _c("room-reservation:This is ". + "a short summary of the privileges related to the room reservation ". + "schedulde and the groups which have them assigned."), + sprintf(_c("room-reservation:If one of these privileges is not assigned to ". + "any group, all users on this server are allowed to perform the specified ". + "action. Please use the %sgroup administration%s to assign and revoke ". + "privileges."), "", ""), + _c("room-reservation:Please note that every group with the booking ". + "privilege can also implicitly view the booking table and every group with ". + "the administration privilege can also implicitly book and view the ". + "booking table.")); + echo "

\n"; + echo sprintf("\n", icon("keys"), + _("View the booking table").":", $asViewGroups == array() ? + _c("room-reservation:all users") : icon("act-group") . join(", ", + array_map("getGroupName", $asViewGroups))); + echo "\n"; + echo sprintf("\n", icon("keys"), + _("Book rooms").":", $asBookGroups == array() ? + _c("room-reservation:all users") : icon("act-group") . join(", ", + array_map("getGroupName", $asBookGroups))); + echo "\n"; + echo sprintf("\n", icon("keys"), + _("Administration of the room reservation schedule"), + $asAdminGroups == array() ? _c("room-reservation:all users") : + icon("act-group") . join(", ", array_map("getGroupName", $asAdminGroups))); + echo "
%s%s%s
%s%s%s
%s%s%s

\n"; + _GroupBox(); + + GroupBox(_c("room-reservation:Further options"), "manage"); + printf("
". + "\n", $_SERVER["PHP_SELF"]); + + printf("\n"; + printf("", $GLOBALS["stdbtn"], _("OK")); + echo "
<%s name='mod_roomReservationConfigPage". + "[showweekend]' id='mod_roomReservationConfigPageShowWeekend' ". + "value='1' %s />
". + "%s

", + $GLOBALS["smlchk"], $this->bPostShowWeekend ? "checked='checked' " : "", + _c("room-reservation:Show weekend"), _c("room-reservation:If ". + "selected, the weekdays saturday and sunday are also shown in the ". + "booking table.")); + + echo "
<%s name='mod_roomReservationConfigPage". + "[showlessons]' id='mod_roomReservationConfigPageShowLessons' ". + "value='1'%s />
". + "%s

", + $GLOBALS["smlchk"], $this->bPostShowLessons ? "checked='checked' " : "", + _c("room-reservation:Show „lesson” texts"), + _c("room-reservation:Check this box to show texts like ". + "„nth lesson&rdquo in the booking page. If this box is ". + "unchecked, none of these texts are shown.")); + + printf("
<%s name='mod_roomReservationConfigPage". + "[submit]' value='%s' />
\n"; + _GroupBox(); + + // second row + echo "		\n"; + + GroupBox(_c("room-reservation:Periods"), "mod_room-reservation_timeslice"); + printf("

%s

", _c("room-reservation:Here you can fill in the ". + "periods where bookings can be undertaken. A booking period can ". + "e. g. correspond to a lesson.")); + echo "
"; + $otlb = new mod_roomReservationTimesliceListBox($this->oCfg); + $otlb->show(); + echo "
"; + _GroupBox(); + + echo "
\n"; + } +} +?> \ No newline at end of file diff --git a/includes/mod_roomReservationPage.inc b/includes/mod_roomReservationPage.inc new file mode 100755 index 0000000..ee54f3d --- /dev/null +++ b/includes/mod_roomReservationPage.inc @@ -0,0 +1,150 @@ +oCfg = $oCfg; + + $this->processRequestVariables(); + } + + /***************************************************************************/ + /** + * @} + * @name Initialization + * @{ + */ + + /** + * Process the REQUEST variables and preset the some variables. Override + * this function to process GET and POST parameters. + * @return void + */ + protected function processRequestVariables() { } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the page title + * @param $str (string) + * @return void + */ + public function setTitle($str) { $this->strTitle = $str; } + + /** + * Set the title icon + * @param $str (string) + * @return void + */ + public function setIcon($str) { $this->strIcon = $str; } + + /** + * Get the page title + * @return string + */ + public function getTitle() { return $this->strTitle; } + + /** + * Get the title icon + * @return string + */ + public function getIcon() { return $this->strIcon; } + + /***************************************************************************/ + /** + * @} + * @name Output + * @{ + */ + + /** + * Show the beginning of the page. + * @return void + */ + protected function beginShow() { + html_header("\n"); + PageBlue(q($this->getTitle()), $this->getIcon()); + + // print error messages from the configuration + if($s = trim($this->oCfg->getMessages()) != "") { + printf("

%s

\n", nl2br(q($s))); + } + } + + /** + * Show the beginning of the page. Override this function to print your + * HTML code. + * @return void + */ + protected abstract function doShow(); + + /** + * Show the end of the page. + * + */ + protected function endShow() { + _PageBlue(); + } + + /** + * Show the full page. You don't need to override this function. Instead, + * override doShow(). + * @return void + */ + public function show() { + $this->beginShow(); + $this->doShow(); + $this->endShow(); + } + +} +?> \ No newline at end of file diff --git a/includes/mod_roomReservationRoom.inc b/includes/mod_roomReservationRoom.inc new file mode 100755 index 0000000..f49aa22 --- /dev/null +++ b/includes/mod_roomReservationRoom.inc @@ -0,0 +1,138 @@ +setName($strName); + $this->setRoomNo($strRoomNo); + $this->setFloor($strFloor); + $this->setBuilding($strBuilding); + $this->setLocation($strLocation); + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the name of the room + * @param $str (string) + * @return void + */ + public function setName($str) { $this->strName = $str; } + + /** + * Set the room number + * @param $str (string) + * @return void + */ + public function setRoomNo($str) { $this->strRoomNo = $str; } + + /** + * Set the floor + * @param $str (string) + * @return void + */ + public function setFloor($str) { $this->strFloor = $str; } + + /** + * Set the building + * @param $str (string) + * @return void + */ + public function setBuilding($str) { $this->strBuilding = $str; } + + /** + * Set the location + * @param $str (string) + * @return void + */ + public function setLocation($str) { $this->strLocation = $str; } + + /** + * Get the name of the room + * @return string + */ + public function getName() { return $this->strName; } + + /** + * Get the room number + * @return string + */ + public function geRoomNo() { return $this->strRoomNo; } + + /** + * Get the floor + * @return string + */ + public function getFloor() { return $this->strFloor; } + + /** + * Get the building + * @return string + */ + public function getBuilding() { return $this->strBuilding; } + + /** + * Get the location + * @return string + */ + public function getLocation() { return $this->strLocation; } + + /**@}*/ +} +?> diff --git a/includes/mod_roomReservationRoomsManager.inc b/includes/mod_roomReservationRoomsManager.inc new file mode 100755 index 0000000..8271a04 --- /dev/null +++ b/includes/mod_roomReservationRoomsManager.inc @@ -0,0 +1,131 @@ +oCfg = $oCfg; + } + + /** + * Insert or update a room in the database + * param $or (rsRoom) Room to store in the database + * return (int) The UID of the booking, or -1 in case of a failure. + * Call getLastError() to get more information about the error. + */ +/** public function write(rsRoom $or) { + // Only administrators are allowed to create and alter rooms + if(!$this->oCfg->userIsAdmin()) { + // TODO throw exception + setLastError(RS_ERROR_ACCESS_DENIED); + return -1; + } + + $strWhere = ""; + $strLog = ""; + + // Update or insert? + if($or->getUid() == null) { + // No UID yet, insert new room + $strLog = sprintf("Raum „%s“ angelegt", $or->getName()); + } else { + $strWhere = "rsr_uid = ".qp(intval($or->getUid())); + $strLog = sprintf("Raum „%s“ geändert", $or->getName()); + } + + $aPut["rsr_name"] = $or->getName(); + db_store("rooms", $aPut, $strWhere == "" ? null : $strWhere); + + $hQuery = db_query("SELECT currval('roomschedule_rooms_rsr_uid_seq') ". + "FROM roomschedule_rooms;"); + $nNewUid = pg_fetch_result($hQuery, 0, "currval"); + + rrInsertLog($strLog); + + // Return new UID + return $nNewUid; + } + */ + /** + * Delete a room from the database + * param $nUid (int) Unique ID of the room + * return (bool) true on success, otherwise false. + * Call getLastError() to get more information about the error. + */ +/* public function delete($nUid) { + // Only administrators are allowed to delete rooms + if(!$this->oCfg->userIsAdmin()) { + // TODO throw exception + setLastError(RS_ERROR_ACCESS_DENIED); + return false; + } + // Delete it from the database + $strRoom = $this->getRoomName($nUid); + if(!db_query("DELETE FROM roomschedule_rooms WHERE rsr_uid = $1;", + intval($nUid))) { + // TODO throw exception + setLastError(RS_ERROR_SQL); + return false; + } else { + rsInsertLog(sprintf("Raum „%s“ gelöscht", $strRoom)); + return true; + } + } +*/ + + /** + * Get all rooms from the database + * @return array of mod_roomReservationRoom + */ + function getRooms() { + $aoReturn = array(); + $hQuery = db_query("SELECT * FROM rooms ORDER BY name;"); + while($arResult = pg_fetch_array($hQuery)) { + $aoReturn[] = new mod_roomReservationRoom($arResult["name"], + $arResult["room_no"], $arResult["floor"], $arResult["building"], + $arResult["location"]); + } + return $aoReturn; + } +} +?> diff --git a/includes/mod_roomReservationTimeslice.inc b/includes/mod_roomReservationTimeslice.inc new file mode 100755 index 0000000..f6bd997 --- /dev/null +++ b/includes/mod_roomReservationTimeslice.inc @@ -0,0 +1,102 @@ +setBegin($tsBegin); + $this->setEnd($tsEnd); + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the beginning. Only the time part is used, the date part is ignored. + * If the timestamp is invalid, an Exception is thrown. + * @param $ts (timestamp) + * @throws Exception + */ + public function setBegin($ts) { + if(intval($ts) >= $this->getEnd()) { + throw new Exception(MOD_ROOM_RESERVATION_ERROR_END_BEFORE_BEGIN); + } else { + $this->tsBegin = (intval($ts) % 86400); + } + } + + /** + * Set the ending. Only the time part is used, the date part is ignored. + * If the timestamp is invalid, an Exception is thrown. + * @param $ts (timestamp) + * @throws Exception + */ + public function setEnd($ts) { + if($this->getBegin() >= intval($ts)) { + throw new Exception(MOD_ROOM_RESERVATION_ERROR_END_BEFORE_BEGIN); + } else { + $this->tsEnd = (intval($ts) % 86400); + } + } + + /** + * Get the beginning. + * @return timestamp + */ + public function getBegin() { return $this->tsBegin; } + + /** + * Get the ending. + * @return timestamp + */ + public function getEnd() { return $this->tsEnd; } + + /** @} */ +} +?> diff --git a/includes/mod_roomReservationTimesliceListBox.inc b/includes/mod_roomReservationTimesliceListBox.inc new file mode 100755 index 0000000..7c958af --- /dev/null +++ b/includes/mod_roomReservationTimesliceListBox.inc @@ -0,0 +1,267 @@ +oCfg = $oCfg; + + $this->processRequestVariables(); + } + + /***************************************************************************/ + /** + * @} + * @name Initialization + * @{ + */ + + /** + * Process the REQUEST variables and preset the some variables + * @return void + */ + protected function processRequestVariables() { + + if(isset($_GET["mod_roomReservationTimesliceListBox"])) { + // action + if(isset($_GET["mod_roomReservationTimesliceListBox"]["action"])) { + $ga = $_GET["mod_roomReservationTimesliceListBox"]["action"]; + $this->setAction((($ga == "add") ? MOD_ROOM_RESERVATION_TLB_ACTION_ADD : + (($ga == "delete") ? MOD_ROOM_RESERVATION_TLB_ACTION_DELETE : + MOD_ROOM_RESERVATION_TLB_ACTION_SHOW))); + } + + // new beginning and new ending + $this->setNewBegin(isset( + $_GET["mod_roomReservationTimesliceListBox"]["begin"]) ? + $_GET["mod_roomReservationTimesliceListBox"]["begin"] : ""); + $this->setNewEnd(isset( + $_GET["mod_roomReservationTimesliceListBox"]["end"]) ? + $_GET["mod_roomReservationTimesliceListBox"]["end"] : ""); + } + + // perform the requested action + if($this->getAction() == MOD_ROOM_RESERVATION_TLB_ACTION_ADD) { + // add a timeslice to the configuration file + + $bErrors = false; + + // Note: we want to handle the timestamps in GMT format, hence the "+0000" + if(strtotime($this->getNewBegin()." +0000") === false) { + $this->asFormErrors[] = _c("room-reservation:The beginning time is ". + "invalid."); + $bErrors = true; + } + if(strtotime($this->getNewEnd()." +0000") === false) { + $this->asFormErrors[] = _c("room-reservation:The ending time is ". + "invalid."); + $bErrors = true; + } + + if(!$bErrors) { + try { + $this->oCfg->addTimeslice(new mod_roomReservationTimeslice( + strtotime($this->getNewBegin()." +0000") % 86400, + strtotime($this->getNewEnd()." +0000") % 86400)); + $this->oCfg->writeConfig(); + $this->setNewBegin(""); + $this->setNewEnd(""); + } catch(Exception $e) { + $this->asFormErrors[] = $e->getMessage(); + } + } + + } elseif($this->getAction() == MOD_ROOM_RESERVATION_TLB_ACTION_DELETE) { + // FIXME delete a timeslice from the configuration file + if(isset($_POST["mod_roomReservationTimesliceListBox"])) { + if(isset($_POST["mod_roomReservationTimesliceListBox"]["l"])) { + $ao = $this->oCfg->getTimeslices(); + foreach($_POST["mod_roomReservationTimesliceListBox"]["l"] as + $n => $b) { + if($b) { + $this->oCfg->deleteTimeslice(new mod_roomReservationTimeslice( + $ao[$n]->getBegin(), $ao[$n]->getEnd())); + } + } + $this->oCfg->writeConfig(); + } + } + } + } + + /***************************************************************************/ + /** + * @} + * @name Access to attributes + * @{ + */ + + /** + * Set the action to be done (GET data) + * @param $c (constant) Action. See @ref timeslicelistbox_actions. + */ + protected function setAction($c) { $this->cAction = intval($c); } + + /** + * Set the beginning for a new timeslice (GET data) + * @param $s (string) + */ + protected function setNewBegin($s) { $this->sNewBegin = $s; } + + /** + * Set the beginning for a new timeslice (GET data) + * @param $s (string) + */ + protected function setNewEnd($s) { $this->sNewEnd = $s; } + + /** + * Get the action to be done (GET data). See @ref timeslicelistbox_actions. + * @return constant + */ + function getAction() { return $this->cAction; } + + /** + * Get the beginning for a new timeslice (GET data) + * @return string + */ + public function getNewBegin() { return $this->sNewBegin; } + + /** + * Get the beginning for a new timeslice (GET data) + * @return string + */ + public function getNewEnd() { return $this->sNewEnd; } + + /***************************************************************************/ + /** + * @} + * @name Output + * @{ + */ + + /** + * Show the control + * @return void + */ + public function show() { + TreeView(array(_c("room-reservation:Begin"), _c("room-reservation:End"))); + + // addition form + printf("
"); + hidden("mod_roomReservationTimesliceListBox[action]", "add"); + TreeViewTitle(_("Add")); + if(count($this->asFormErrors) > 0) { + TreeViewLine(sprintf("
%s
", + nl2br(q(trim(join("\n", $this->asFormErrors)))))); + } + TreeViewLine(array(sprintf("<%s name='mod_roomReservationTimesliceListBox". + "[begin]' value='%s' size='8'/>", $GLOBALS["stdedt"], + $this->getNewBegin()), sprintf("<%s name='". + "mod_roomReservationTimesliceListBox[end]' value='%s' size='8'/> <%s ". + "name='mod_roomReservationTimesliceListBox[submit]' value='%s' />", + $GLOBALS["stdedt"], $this->getNewEnd(), $GLOBALS["stdbtn"], _("Add")))); + echo "
\n"; + + // deletion form + TreeViewTitle(_c("room-reservation:Periods")); + $aoTs = $this->oCfg->getTimeslices(); + if(count($aoTs) > 0) { + echo "
"; + $i = 0; + foreach($aoTs as $oTs) { + $sBox = sprintf("". + "<%s name='mod_roomReservationTimesliceListBox[l][%d]' value='1' />", + $i, $GLOBALS["smlchk"], $i); + // Note: we have only GMT timestamps in the timeslice objects + TreeViewLine(array($sBox . gmstrftime(_("%#I:%M %p"), $oTs->getBegin()), + gmstrftime(_("%#I:%M %p"), $oTs->getEnd()))); + $i++; + } + // toolbar + printf("", $GLOBALS["treeview_cols"]); + CheckCombo(); + printf("<%s name='mod_roomReservationTimesliceListBox[submit]' ". + "value='%s' />", $GLOBALS["stdbtn"], _("Delete")); + echo "\n"; + } else { + TreeViewEmpty(); + } + + echo "
\n"; + _TreeView(); + } + /** @} */ +} +?> \ No newline at end of file diff --git a/lang/mod_room-reservation.po b/lang/mod_room-reservation.po new file mode 100755 index 0000000..2d1f0d5 --- /dev/null +++ b/lang/mod_room-reservation.po @@ -0,0 +1,233 @@ +# @file mod_room-reservation.po +# Translation for iserv-room-reservation +# @author Roland Hieber (roland.hieber@wilhelm-gym.net) +# @date 23.11.2007 +# +# Copyright © 2007 Roland Hieber +# +# Permission is hereby granted, free of charge, to any person obtaining +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# + +# Privileges +msgid "Room Reservation Schedule" +msgstr "Raumbelegungsplan" + +msgid "View the booking table" +msgstr "Raumbuchungen einsehen" + +msgid "Book rooms" +msgstr "Räume buchen" + +msgid "Administration of the room reservation schedule" +msgstr "Administration des Raumbelegungsplans" + +# Other things +msgid "room-reservation:Access denied." +msgstr "room-reservation:Zugriff verweigert." + +msgid "room-reservation:Error while trying to query the database." +msgstr "room-reservation:Fehler bei der Datenbankabfrage." + +msgid "room-reservation:Could not open file." +msgstr "room-reservation:Datei konnte nicht geöffnet werden." + +msgid "room-reservation:Could not write to file." +msgstr "room-reservation:Datei konnte nicht geschrieben werden." + +msgid "room-reservation:Could not lock file." +msgstr "room-reservation:Datei konnte nicht verriegelt werden." + +msgid "room-reservation:Could not unlock file." +msgstr "room-reservation:Datei konnte nicht entriegelt werden." + +msgid "room-reservation:The current booking overlaps with an existing booking." +msgstr "room-reservation:Die aktuelle Buchung überschneidet sich mit vorhandenen Buchungen." + +msgid "room-reservation:The period overlaps with an existing one." +msgstr "room-reservation:Der Zeitabschnitt überschneidet sich mit einem bereits vorhandenen." + +msgid "room-reservation:The specified period does not exist." +msgstr "room-reservation:Der angegebene Zeitabschnitt existiert nicht." + +msgid "room-reservation:The specified account does not exist." +msgstr "room-reservation:Der angegebene Account existiert nicht." + +msgid "room-reservation:(Book from here)" +msgstr "room-reservation:(Ab hier buchen)" + +msgid "room-reservation:Book this room from here" +msgstr "room-reservation:Diesen Raum von hier an buchen" + +msgid "room-reservation:delete" +msgstr "room-reservation:löschen" + +msgid "room-reservation:Delete this booking" +msgstr "room-reservation:Diese Buchung löschen" + +msgid "room-reservation:Delete this booking?" +msgstr "room-reservation:Diese Buchung löschen?" + +msgid "room-reservation:Attention: This booking is a recurring " + "booking. If you delete it, the period will be deallocated for " + "every week, not just this single week!" +msgstr "room-reservation:Achtung: Diese Buchung wiederholt sich. " + "Wenn sie gelöscht wird, wird der Zeitraum in allen Wochen wieder " + "freigegeben, nicht nur in dieser einzelnen Woche!" + +msgid "room-reservation:edit" +msgstr "room-reservation:bearbeiten" + +msgid "room-reservation:Edit this booking" +msgstr "room-reservation:Diese Buchung bearbeiten" + +msgid "room-reservation:The booking was deleted." +msgstr "room-reservation:Die Buchung wurde gelöscht." + +msgid "room-reservation:Room:" +msgstr "room-reservation:Raum:" + +msgid "room-reservation:(today)" +msgstr "room-reservation:(heute)" + +msgid "room-reservation:%s# lesson" +msgstr "room-reservation:%s. Stunde" + +msgid "room-reservation:Book rooms" +msgstr "room-reservation:Räume buchen" + +msgid "room-reservation:Current Week" +msgstr "room-reservation:Aktuelle Woche" + +msgid "room-reservation:< Back" +msgstr "room-reservation:< Zurück" + +msgid "room-reservation:Next >" +msgstr "room-reservation:Vor >" + +msgid "room-reservation:%d# week" +msgstr "room-reservation: %d. Woche" + +msgid "room-reservation:No rooms have been configured yet." +msgstr "room-reservation:Es wurden noch keine Räume eingerichtet." + +msgid "room-reservation:Schedule of room bookings" +msgstr "room-reservation:Raumbelegungsplan" + +msgid "room-reservation:Book a room" +msgstr "room-reservation:Einen Raum buchen" + +msgid "room-reservation:Your name:" +msgstr "room-reservation:Ihr Name:" + +msgid "room-reservation:until:" +msgstr "room-reservation:bis:" + +msgid "room-reservation:Reason:" +msgstr "room-reservation:Grund:" + +msgid "room-reservation:Book" +msgstr "room-reservation:Buchen" + +msgid "room-reservation:The ending of your booking cannot lie before the " + "beginning." +msgstr "room-reservation:Das Ende Ihrer Buchung kann nicht vor dem Anfang " + "liegen." + +msgid "room-reservation:Please give a reason." +msgstr "room-reservation:Bitte geben Sie einen Grund an." + +msgid "room-reservation:Configuration" +msgstr "room-reservation:Konfiguration" + +msgid "room-reservation:This is a short summary of the privileges related to " + "the room reservation schedulde and the groups which have them assigned." +msgstr "room-reservation:Dies ist eine kurze Übersicht über die vom " + "Raumbelegungsplan genutzten Sonderrechte und den Gruppen, denen sie " + "zugewiesen wurden." + +msgid "room-reservation:If one of these privileges is not assigned to any " + "group, all users on this server are allowed to perform the specified " + "action. Please use the %sgroup administration%s to assign and revoke " + "privileges." +msgstr "room-reservation:Falls eines dieser Sonderrechte keiner Gruppe " + "zugewiesen wurde, dürfen alle Benutzer dieses Servers die entsprechende " + "Aktion vornehmen. Sonderrechte können in der %sGruppenverwaltung%s " + "zugeteilt und entzogen werden." + +msgid "room-reservation:Please note that every group with the booking " + "privilege can also implicitly view the booking table and every group with " + "the administration privilege can also implicitly book and view the booking " + "table." +msgstr "room-reservation:Es ist zu beachten, dass jede Gruppe mit Buchungs-" + "Sonderrecht implizit auch die Buchungstabelle einsehen kann, und jede " + "Gruppe mit Administrations-Sonderrecht kann ebenso implizit Buchungen " + "vornehmen und die Buchungstabelle einsehen." + +msgid "room-reservation:Here you can fill in the periods where bookings can " + "be undertaken. A booking period can e. g. correspond to a lesson." +msgstr "room-reservation:Hier die Zeitstunden der Buchungszeiträume eingeben. " + "Ein Buchungszeitraum kann z. B. einer Schulstunde entsprechen." + +msgid "room-reservation:all users" +msgstr "room-reservation:alle Benutzer" + +msgid "room-reservation:Periods" +msgstr "room-reservation:Zeitabschnitte" + +msgid "room-reservation:Begin" +msgstr "room-reservation:Anfang" + +msgid "room-reservation:End" +msgstr "room-reservation:Ende" + +msgid "room-reservation:The beginning time is invalid." +msgstr "room-reservation:Die Anfangszeit ist ungültig." + +msgid "room-reservation:The ending time is invalid." +msgstr "room-reservation:Die Endzeit ist ungültig." + +msgid "room-reservation:Further options" +msgstr "room-reservation:Weitere Optionen" + +msgid "room-reservation:Show weekend" +msgstr "room-reservation:Wochenende anzeigen" + +msgid "room-reservation:If selected, the weekdays saturday and sunday are " + "also shown in the booking table." +msgstr "room-reservation:Wenn ausgewählt, werden in der Buchungsansicht auch " + "die Tage Samstag und Sonntag angezeigt." + +msgid "room-reservation:Show „lesson” texts" +msgstr "room-reservation:„Stunden”-Texte anzeigen" + +msgid "room-reservation:Check this box to show texts like „nth " + "lesson&rdquo in the booking page. If this box is unchecked, none of these " + "texts are shown." +msgstr "room-reservation:Aktivieren Sie diese Option, um Texte in der Form " + "„n. Stunde&rdquo auf der Buchungsseite anzuzeigen. " + "Andernfalls werden diese Texte nicht angezeigt." + +msgid "room-reservation:Account, if not yourself:" +msgstr "room-reservation:Account, falls nicht Sie selbst:" + +msgid "room-reservation:Repetition:" +msgstr "room-reservation:Wiederholung:" + +msgid "room-reservation:every week" +msgstr "room-reservation:jede Woche" diff --git a/nav/79mod_room-reservation.mod b/nav/79mod_room-reservation.mod new file mode 100755 index 0000000..f9c7b61 --- /dev/null +++ b/nav/79mod_room-reservation.mod @@ -0,0 +1,7 @@ +userCanView()) { + TreeNode(_c("room-reservation:Book rooms"), "/idesk/mod_room-reservation/", + "mod_room-reservation_index"); +} +?> diff --git a/nav/admin/99mod_room-reservation.mod b/nav/admin/99mod_room-reservation.mod new file mode 100755 index 0000000..547a6dc --- /dev/null +++ b/nav/admin/99mod_room-reservation.mod @@ -0,0 +1,4 @@ + diff --git a/priv/mod_room-reservation b/priv/mod_room-reservation new file mode 100755 index 0000000..97df142 --- /dev/null +++ b/priv/mod_room-reservation @@ -0,0 +1,12 @@ +mod_roomreservation_view: +module Room Reservation Schedule +description View the booking table + +mod_roomreservation_book: +module Room Reservation Schedule +description Book rooms + +mod_roomreservation_admin: +module Room Reservation Schedule +description Administration of the room reservation schedule + diff --git a/sql/mod_room-reservation.sql b/sql/mod_room-reservation.sql new file mode 100755 index 0000000..7afffef --- /dev/null +++ b/sql/mod_room-reservation.sql @@ -0,0 +1,27 @@ +-- +-- Table with bookings for module iserv-room-reservation +-- +CREATE TABLE mod_roomreservation_bookings ( + rrb_uid SERIAL NOT NULL PRIMARY KEY, -- Unique ID + rrb_room TEXT NOT NULL -- Name of the room + REFERENCES rooms(name) + ON DELETE CASCADE + ON UPDATE CASCADE, + rrb_date DATE NOT NULL, -- Date of the booking + rrb_tsfirst SMALLINT NOT NULL, -- Number of the first timeslice + rrb_tslast SMALLINT NOT NULL -- Number of the last timeslice + CHECK(rrb_tsfirst <= rrb_tslast), + rrb_act TEXT NOT NULL -- Owner of the booking + REFERENCES users(Act) + ON DELETE CASCADE + ON UPDATE CASCADE, + rrb_reason TEXT NOT NULL, -- Reason + rrb_interval SMALLINT NOT NULL -- Interval in weeks for recurring bookings + DEFAULT 0 +); + +-- +-- Permissions +-- +GRANT SELECT, INSERT, UPDATE, DELETE ON mod_roomreservation, mod_roomreservation_rr_uid_seq TO webusr; +GRANT SELECT, INSERT, UPDATE, DELETE ON mod_roomreservation, mod_roomreservation_rr_uid_seq TO webadm; diff --git a/src/admin/config.php b/src/admin/config.php new file mode 100755 index 0000000..e53b70a --- /dev/null +++ b/src/admin/config.php @@ -0,0 +1,37 @@ +show(); +?> diff --git a/src/index.php b/src/index.php new file mode 100755 index 0000000..8b48d53 --- /dev/null +++ b/src/index.php @@ -0,0 +1,247 @@ +setTitle(_c("room-reservation:Schedule of room bookings")); +$page->show(); + +/** +require_once("sec/secure.inc"); +require_once("mod_rooms.inc"); +TestConfig(); + +// Ist der User berechtigt? +$bAllowAccess = false; +foreach($user[groups] as $group) +{ + foreach($cfgRooms["AllowedGroups"] as $allowed) + { + $bAllowAccess |= (($group == $allowed) == true); + } +} +if(!$bAllowAccess and $cfgRooms["RestrictAccess"] == true) + die_nice("Fehler: Sie sind nicht berechtigt, diese Seite zu benutzen. Wenden Sie sich an einen Administrator."); + +$bookings = new AllBookings(false); + +// Zeitstunden in Schulstunden umrechnen +$lessons_begin = array_flip($cfgRooms["TimeslicesBegin"]); +$lessons_end = array_flip($cfgRooms["TimeslicesEnd"]); + +$action = $_GET["action"]; +$room = isset($_GET["room"]) ? $_GET["room"] : $cfgRooms["Rooms"][0]; +$start = isset($_GET["start"]) ? $_GET["start"] : Monday(); +$act = $user[act]; +$id = isset($_POST["id"]) ? $_POST["id"] : $_GET["id"]; +$class = isset($_POST["class"]) ? $_POST["class"] : $_GET["class"]; +$room_form = isset($_POST["room_form"]) ? $_POST["room_form"] : $_GET["room"]; +$date = isset($_POST["date"]) ? $_POST["date"] : $_GET["date"]; +$timebegin = isset($_POST["timebegin"]) ? $_POST["timebegin"] : $_GET["timebegin"]; +$timeend = isset($_POST["timeend"]) ? $_POST["timeend"] : (isset($_GET["timeend"]) ? $_GET["timeend"] : $cfgRooms["TimeslicesEnd"][$lessons_begin[$timebegin]]); // Standardmäßig auf einen Zeitraum später als Anfangszeit +$reason = isset($_POST["reason"]) ? $_POST["reason"] : $_GET["reason"]; +$submit = $_POST["submit"]; +$cancel = $_POST["cancel"]; + +PageBlue("Raumbelegungsplan", "rooms_index"); + +// Formular anzeigen +function ShowForm() +{ + global $cfgRooms; + global $act, $class, $room_form, $date, $timebegin, $timeend, $reason, $user; + + Title("Einen Raum buchen"); + $form = "

Füllen Sie das Formular aus und klicken Sie dann auf die Schaltfläche „Raum buchen“.

+
+ + + +"; + + // Klasse nur anzeigen, wenn angeschaltet + if($cfgRooms["ShowClassEdit"]) + $form .= "\n \n"; + + $form .= "\n \n\n"; + $form .= " \n\n"; + $form .= " \n\n"; + $form .= " \n\n"; + $form .= " \n
Ihr Name:{$user[name]}
".q(stripslashes($cfgRooms["ClassEditText"])).":
Raum:
Datum:
Zeit:vonbis
Grund für die Belegung:
  
"; + + echo $form; +} + + +if($action == "book") +{ + ShowForm(); +} +// ...oder Buchung löschen? +else if($action == "delete") +{ + // Rausfinden, wo unsere gewünschte ID im Array steht + for($n = 0; isset($bookings->objBookings[$n]->sqlData->id) and ($id != $bookings->objBookings[$n]->sqlData->id); $n++); + + // Auf Besitz oder Admin prüfen + $bAdminMode = FALSE; + $bAdminMode |= ($bookings->objBookings[$n]->UserIsOwner() and !$bookings->objBookings[$n]->rawData->fixed); // Benutzer dürfen keine festen Buchungen löschen + $bAdminMode |= $bookings->UserIsAdmin(); + + if(!$bAdminMode) + echo "
Sie sind nicht berechtigt, diese Buchung zu löschen!
\n"; + else + { + if($_POST["surely_delete"] == "Löschen" && $_POST["surely_delete_fixed"] == "true") + { + $bookings->Delete($id); + echo "
Ihre Buchung wurde gelöscht.
\n"; + } + else + { + echo "

Eine Buchung löschen

\n"; + if($bookings->objBookings[$n]->rawData->fixed and $_POST["surely_delete_fixed"] == "false") + echo "

Sie müssen bestätigen, dass Sie die Warnung über das Löschen von festen Buchungen zur Kenntnis genommen haben.

\n"; + // Formular zur Bestätigung anzeigen + echo "

Wollen Sie diese Buchung löschen?

\n"; + $bookings->PrintBooking($id); + echo "
\n"; + echo "

\n"; + if($bookings->objBookings[$n]->rawData->fixed) + // Bestätigungsfeld für feste Buchungen + echo "

".icona("dlg-warn", 16)."Achtung: Diese Buchung ist eine feste Buchung. Wenn sie gelöscht wird, wird der Zeitraum nicht in dieser Woche, sondern in allen Wochen wieder freigegeben.

\n

<$smlchk name='surely_delete_fixed' value='true' />

\n"; + else + echo "\n"; + echo "<$stdbtn name='surely_delete' value='Löschen' />
\n"; + } + } + + // Zurück-Link anzeigen + Option(_("Back"), "", "href='?room=$room&start=$start'", "back"); +} + +// ... oder alle Buchungen anzeigen / Buchung eintragen? +else +{ + if($action == "insert" and $submit == "Raum buchen") + { + $err = $bookings->Insert(null, $room_form, $date, $timebegin, $timeend, $act, $class, $reason, false); + if(!$err) + { + switch($bookings->lastError) + { + case ALLBOOKINGS_SQL_ERROR: + ReportError("\$booking->Insert", $booking->lastError, __FILE__, __LINE__); + default: + } + ShowForm(); + die_nice(); + } + else + { + // Log-Eintrag, wenn erwünscht + if($cfgRooms["LogOnInsert"]) + InsertLog("Raum $room_form am $date von $timebegin bis $timeend gebucht. Begründung: $reason"); + + // Passenderweise gleich die Woche mit der eingetragenen Buchung anzeigen + $tmp = explode(".", $date); + $start = Monday(strtotime($tmp[2]."-".$tmp[1]."-".$tmp[0])); + $room = $room_form; + Title("Raumbelegungen für den Raum $room in Woche ".date("W", $start)); + echo "

".icona("dlg-info", 16, "bl")."Ihre Buchung wurde eingetragen.

\n"; + } + } + else + { + Title("Raumbelegungen für den Raum $room in Woche ".date("W", $start)); + } + + $nPrevWeek = strtotime("last monday", Monday($start)); // der Montag vor dem Montag in der Startwoche + $nFirstWeek = Monday(); // der Montag in der aktuellen Woche + $nLastWeek = strtotime("last monday", Monday($bookings->GetLastBookingDate())); + $nNextWeek = strtotime("next monday", Monday($start)); // der Montag nach dem Montag der Startwoche + + echo "
+Raum:

"; + + // Navigation für die Wochen ausgeben + echo "

Vorherige Woche | Aktuelle Woche | "; + // Fünf Wochen zur direkten Anwahl anbieten + for($i = 1; $i <= 5; $i++) + { + $nCurWeek = Monday(strtotime("$i week", $start)); + echo "Woche ".date("W", $nCurWeek)." | "; + } + echo "Letzte Buchung | Nächste Woche

"; + echo "

    +
  • Um eine Buchung vorzunehmen dort auf „Ab hier buchen“ klicken, wo die Buchung beginnen soll.
    • +
  • Neu: Eigene Buchungen (außer den wiederkehrenden Buchungen in dunkelblau) können gelöscht werden, indem auf den Link „Buchung löschen“ geklickt wird.
    • +
  • Mit Klick auf den Benutzernamen kann eine E-Mail an den Benutzer geschrieben werden.
    • +

\n"; + + $bookings->PrintTimeTable($start, $room); + + echo "
"; +} + +_PageBlue(); +*/ +?> diff --git a/update-iserv1-iserv2.pl b/update-iserv1-iserv2.pl new file mode 100755 index 0000000..3105f77 --- /dev/null +++ b/update-iserv1-iserv2.pl @@ -0,0 +1,254 @@ +#!/usr/bin/perl -w + +use strict; +use warnings; +use IServ::DB; +use Time::Local; + +my $OLDCFG = "/old/opt/iserv/idesk/rooms/admin/config.inc.rpmsave"; +# FIXME insert real path +my $NEWCFG = "test.inc"; + +my @tsbegin; +my @tsend; +my @tsbeginold; +my @tsendold; +my @allowedgroups; +my @admingroups; +my $restrictaccess = 0; +my $showweekend = 0; +my $showlessons = 1; + +# convert the config file +open IN, "<", $OLDCFG or die "ERROR: old config file could not be opened: $!"; +while() { + # skip unused variables + if(/\$cfgRooms\[(\"LogOnInsert\"|\'LogOnInsert\')\]/) { + #print "NOTICE: config variable \"LogOnInsert\" is no longer used.\n"; + } elsif(/\$cfgRooms\[(\"OldBookings\"|\'OldBookings\')\]/) { + #print "NOTICE: config variable \"OldBookings\" is no longer used.\n"; + } elsif(/\$cfgRooms\[(\"ShowClassEdit\"|\'ShowClassEdit\')\]/) { + #print "NOTICE: config variable \"ShowClassEdit\" is no longer used.\n"; + } elsif(/\$cfgRooms\[(\"ClassEditText\"|\'ClassEditText\')\]/) { + #print "NOTICE: config variable \"ClassEditText\" is no longer used.\n"; + + # AbsTime is now named ShowLessons + } elsif(/\$cfgRooms\[(\"AbsTime\"|\'AbsTime\')\]\s*=\s*(true|false|0|1)\s*/) { + print "AbsTime is $2\n"; + $showlessons = ($2 eq "true" or $2 eq "1") ? 1 : 0; + + # ShowWeekend + } elsif(/\$cfgRooms\[(\"ShowWeekend\"|\'ShowWeekend\')\]\s*=\s*(true|false|0|1)/) { + print "ShowWeekend is $2\n"; + $showweekend = ($2 eq "true" or $2 eq "1") ? 1 : 0; + + # timeslice beginnings + } elsif(/\$cfgRooms\[(\"TimeslicesBegin\"|\'TimeslicesBegin\')\]\s*=\s*array\s*\(/) { + print "processing timeslice beginnings...\n"; + while() { + if(/\);/) { + last; + } else { + /\s*(\d)\s*=>\s*[\'\"](\d\d?):(\d\d)[\'\"]\s*/; + my $hr = $2; + $hr = "0$hr" if length $hr < 2; + push @tsbeginold, "$hr:$3:00"; + push @tsbegin, Time::Local::timelocal 0, $3, $hr, 1, 0, 1970; + print " found beginning: $hr:$3\n"; + } + } + + # timeslice endings + } elsif(/\$cfgRooms\[(\"TimeslicesEnd\"|\'TimeslicesEnd\')\]\s*=\s*array\s*\(/) { + print "processing timeslice endings...\n"; + while() { + if(/\);/) { + last; + } else { + /\s*(\d)\s*=>\s*[\'\"](\d\d?):(\d\d)[\'\"]\s*/; + my $hr = $2; + $hr = "0$hr" if length $hr < 2; + push @tsendold, "$hr:$3:00"; + push @tsend, Time::Local::timelocal 0, $3, $hr, 1, 0, 1970; + print " found ending: $hr:$3\n"; + } + } + + # add rooms to the database, if they do not exist yet + } elsif(/\$cfgRooms\[(\"Rooms\"|\'Rooms\')\]\s*=\s*array\s*\(/) { + print "processing rooms...\n"; + while() { + if(/\);/) { + last; + } else { + /\s*\d\s*=>\s*((\'([^\']*)\')|(\"([^\"]*)\"))\s*/; + my $sqlval = IServ::DB::Val $3; + if(IServ::DB::Rows "SELECT * FROM rooms WHERE name = $sqlval;") { + print " room '$3' found in database.\n"; + } else { + print "NOTICE: room '$3' not found in database, adding it.\n"; + IServ::DB::Put "rooms", { "name" => $3 } or die $!; + } + } + } + + # convert old user rights to privileges + } elsif(/\$cfgRooms\[(\"RestrictAccess\"|\'RestrictAccess\')\]\s*=\s*(false|true|0|1)/) { + #print "config variable \"RestrictAccess\" is no longer used.\n"; + $restrictaccess = ($2 eq "true" or $2 eq "1") ? 1 : 0; + + } elsif(/\$cfgRooms\[(\"AllowedGroups\"|\'AllowedGroups\')\]\s*=\s*array\s*\(/) { + print "processing allowed groups...\n"; + while() { + if(/\);/) { + last; + } else { + /\s*\d\s*=>\s*((\'([^\']*)\')|(\"([^\"]*)\"))\s*/; + my $name = IServ::DB::Val $3; + my @act = IServ::DB::GetArr "SELECT act FROM groups WHERE name=$name;"; + if(@act) { + print " found group $name.\n"; + push @allowedgroups, $act[0]{"act"}; + } else { + print "NOTICE: group $name not found in database, ignoring it.\n"; + } + } + } + + } elsif(/\$cfgRooms\[(\"GroupsAdmin\"|\'GroupsAdmin\')\]\s*=\s*array\s*\(/) { + #print "config variable AdminGroups is not longer used\n" + print "processing admin groups...\n"; + while() { + if(/\);/) { + last; + } else { + /\s*\d\s*=>\s*((\'([^\']*)\')|(\"([^\"]*)\"))\s*/; + my $name = IServ::DB::Val $3; + my @act = IServ::DB::GetArr "SELECT act FROM groups WHERE name=$name;"; + if(@act) { + print " found group $name.\n"; + push @admingroups, $act[0]{"act"}; + } else { + print "NOTICE: group $name not found in database, ignoring it.\n"; + } + } + } + } +} + +print "converting old user rights to privileges...\n"; +# change the privilege names to the right ones +if($restrictaccess) { + foreach(@allowedgroups) { + my $priv = "mod_roomreservation_view"; + my $act = "$_"; + my @act = IServ::DB::GetArr "SELECT act FROM privileges_assign ". + "WHERE privilege='$priv' AND act='$act';"; + if(@act) { + print " group $_ is already allowed to see the bookings, ignoring it.\n"; + } else { + IServ::DB::Put "privileges_assign", { "act" => $_, + "privilege" => $priv } or die $!; + print " allowed viewing for group '$_'\n"; + } + + $priv = "mod_roomreservation_book"; + @act = "SELECT act FROM privileges_assign ". + "WHERE privilege='$priv' AND act='$act';"; + if(@act) { + print " group $_ is already allowed to book, ignoring it.\n"; + } else { + IServ::DB::Put "privileges_assign", { "act" => $_, + "privilege" => $priv } or die $!; + print " allowed booking for group '$_'\n"; + } + } +} +foreach(@admingroups) { + my $priv = "mod_roomreservation_admin"; + my $act = "$_"; + my @act = IServ::DB::GetArr "SELECT act FROM privileges_assign ". + "WHERE privilege='$priv' AND act='$act';"; + if(@act) { + print " group $_ has already adminship, ignoring it.\n"; + } else { + IServ::DB::Put "privileges_assign", { "act" => $_, + "privilege" => $priv } or die $!; + print " allowed administration for group '$_'\n"; + } +} + +print "writing config file...\n"; +system "touch $NEWCFG"; +open OUT, ">", $NEWCFG or die "ERROR: new config file could not be opened: $!"; +print OUT "flushTimeslices();\n"; +for(my $i = 0; $i <= $#tsbegin; $i++) { + print OUT "\$this->addTimeslice(new rsTimeslice($tsbegin[$i],$tsend[$i]));\n"; +} +print OUT "\$this->setShowWeekend($showweekend);\n"; +print OUT "\$this->setShowLessons($showlessons);\n"; +print OUT "?>"; +close OUT; +close IN; + +print "\nconverting the database. Have a lot of fun...\n"; +open IN, "cat /old/rooms.sql | iconv -f utf8 -t utf8 |" or die +#open IN, " "timeslice" ("15:00:00" => "3") +my $i = 0; +my %tsbeginoldkeys; +my %tsendoldkeys; +foreach (@tsbeginold) { + $tsbeginoldkeys{$_} = $i; + $i++; +} +$i = 0; +foreach (@tsendold) { + $tsendoldkeys{$_} = $i; + $i++; +} + +#my ($key, $val); +#while(($key, $val) = each(%tsbeginoldkeys)) { +# print "$key => $val\n"; +#} +#while(($key, $val) = each(%tsendoldkeys)) { +# print "$ke:y => $val\n"; +#} + +# FIXME database conversion +print "Importing old bookings...\n"; +IServ::DB::Exec "CREATE TABLE mod_roomreservation_bookings_old (id INT NOT NULL PRIMARY KEY, room TEXT NOT NULL, date DATE NOT NULL, timebegin TIME NOT NULL, timeend TIME NOT NULL, act TEXT REFERENCES users(Act) ON DELETE CASCADE ON UPDATE CASCADE NOT NULL, class TEXT, reason TEXT NOT NULL, fixed BOOL);"; +while() { + $_ =~ s/INSERT INTO rooms/INSERT INTO mod_roomreservation_bookings_old/; + #print "$_"; + IServ::DB::Exec($_); +} +#IServ::DB::Exec "INSERT INTO mod_roomreservation_bookings"; +IServ::DB::Exec "DROP TABLE mod_roomreservation_bookings_old;"; + +die 333; +$i = 0; + +my $maxid = 0; +while() { + if(/COPY \"rooms\" FROM stdin;/) { + while() { + if(/\\\./) { + last; + } elsif(/(\d+)\t([^\t]*)\t(\d{4}-\d\d-\d\d)\t(\d\d:\d\d:\d\d)\t(\d\d:\d\d:\d\d)\t([a-zA-Z0-9\.-]+)\t([^\t]*)\t([^\t]*)\t(t|f)/) { + $i++; + # FIXME convert the timeslices!!! + # FIXME insert the right table name and rs_weekly + # ignore uid, it is serial, also class is not used anymore + # print $tsbeginoldkeys{$4}; print "\n"; + IServ::DB::Put "roomschedule", { "rs_room" => $2, "rs_date" => $3, + "rs_tsfirst" => $tsbeginoldkeys{$4}, "rs_tslast" => $tsendoldkeys{$5}, + "rs_act" => $6, "rs_reason" => $8, "rs_weekly" => $9 }; + } + } + } +} +print "$i datasets converted.\ndone!\n";