From 3b7320ef4e2bd9f24b6dce72a8e8bf94c3695796 Mon Sep 17 00:00:00 2001 From: Johann Latocha Date: Wed, 2 Mar 2011 02:08:42 +0100 Subject: Win32 clean out --- AUTHORS | 4 +- CMakeLists.txt | 274 ++-- INSTALL | 23 +- KNOWNBUGS | 26 - README | 13 +- doc/LaTeX/Makefile | 20 - doc/LaTeX/appendix/0000-chapter.tex | 6 - doc/LaTeX/bilder/ConnectionList.png | Bin 47986 -> 0 bytes doc/LaTeX/bilder/DBus.pdf | Bin 13988 -> 0 bytes .../bilder/FictionalPolicyChainClassDiagram.dia | Bin 1330 -> 0 bytes doc/LaTeX/bilder/ImplementedPolicies.dia | Bin 3297 -> 0 bytes .../bilder/InputEventHandlerChain-Sequence.dia | Bin 2702 -> 0 bytes doc/LaTeX/bilder/InputEventHandlerClassDiagram.dia | Bin 2770 -> 0 bytes doc/LaTeX/bilder/Klassendiagramm.pdf | Bin 17321 -> 0 bytes doc/LaTeX/bilder/Klassendiagramm.svg | 581 -------- doc/LaTeX/bilder/PVSPrivInputDArchitecture.dia | Bin 3137 -> 0 bytes doc/LaTeX/bilder/PhasesOfKeyboardHandling.dia | Bin 1695 -> 0 bytes doc/LaTeX/bilder/PolicyChainClassDiagram.dia | Bin 1844 -> 0 bytes doc/LaTeX/bilder/SayHelloHandler-PolicyHier.dia | Bin 1749 -> 0 bytes doc/LaTeX/bilder/UebertragungsEbenen.dia | Bin 1994 -> 0 bytes doc/LaTeX/bilder/clientChatDialog.png | Bin 37299 -> 0 bytes doc/LaTeX/bilder/clientConfigDialog.png | Bin 38714 -> 0 bytes doc/LaTeX/bilder/clientToolbar.png | Bin 8131 -> 0 bytes doc/LaTeX/bilder/connectionframe.png | Bin 55648 -> 0 bytes doc/LaTeX/bilder/dum.jpg | Bin 410679 -> 0 bytes doc/LaTeX/bilder/dum.png | Bin 31700 -> 0 bytes doc/LaTeX/bilder/mainwindow.png | Bin 61181 -> 0 bytes doc/LaTeX/bilder/menu-key.png | Bin 2179 -> 0 bytes doc/LaTeX/bilder/processlist.png | Bin 82069 -> 0 bytes doc/LaTeX/bilder/pvsmgr.jpg | Bin 114924 -> 0 bytes doc/LaTeX/bilder/pvsmgrAll.jpg | Bin 331431 -> 0 bytes doc/LaTeX/bilder/runprocess.png | Bin 41192 -> 0 bytes doc/LaTeX/bilder/siegel-neu.jpg | Bin 768543 -> 0 bytes doc/LaTeX/bilder/siegel-neu.png | Bin 1217444 -> 0 bytes doc/LaTeX/bilder/studentctlpanel.png | Bin 41591 -> 0 bytes doc/LaTeX/bilder/vnc-frame-buttons.png | Bin 7050 -> 0 bytes doc/LaTeX/bilder/vnc-frame-buttons.xcf | Bin 19912 -> 0 bytes doc/LaTeX/devel/0000-chapter.tex | 0 doc/LaTeX/devel/0100-build.tex | 69 - doc/LaTeX/devel/0200-gui-lib.tex | 31 - doc/LaTeX/devel/0300-pvs.tex | 505 ------- doc/LaTeX/devel/0310-service-discovery.tex | 84 -- doc/LaTeX/devel/0400-pvs-console.tex | 176 --- doc/LaTeX/devel/0500-pvs-client.tex | 243 ---- doc/LaTeX/header.tex | 58 - doc/LaTeX/intro/0000-chapter.tex | 17 - doc/LaTeX/intro/0100-funktionen.tex | 21 - doc/LaTeX/intro/0900-textaufbau.tex | 13 - doc/LaTeX/mystyle-pdf.tex | 112 -- doc/LaTeX/pvs-doc.tex | 37 - doc/LaTeX/user/0000-chapter.tex | 0 doc/LaTeX/user/0100-pvs-steuer.tex | 144 -- doc/LaTeX/user/0300-pvs-client.tex | 80 -- doc/LaTeX/zusfassung.tex | 10 - doc/Makefile | 20 + doc/appendix/0000-chapter.tex | 6 + doc/bilder/ConnectionList.png | Bin 0 -> 47986 bytes doc/bilder/DBus.pdf | Bin 0 -> 13988 bytes doc/bilder/FictionalPolicyChainClassDiagram.dia | Bin 0 -> 1330 bytes doc/bilder/ImplementedPolicies.dia | Bin 0 -> 3297 bytes doc/bilder/InputEventHandlerChain-Sequence.dia | Bin 0 -> 2702 bytes doc/bilder/InputEventHandlerClassDiagram.dia | Bin 0 -> 2770 bytes doc/bilder/Klassendiagramm.pdf | Bin 0 -> 17321 bytes doc/bilder/Klassendiagramm.svg | 581 ++++++++ doc/bilder/PVSPrivInputDArchitecture.dia | Bin 0 -> 3137 bytes doc/bilder/PhasesOfKeyboardHandling.dia | Bin 0 -> 1695 bytes doc/bilder/PolicyChainClassDiagram.dia | Bin 0 -> 1844 bytes doc/bilder/SayHelloHandler-PolicyHier.dia | Bin 0 -> 1749 bytes doc/bilder/UebertragungsEbenen.dia | Bin 0 -> 1994 bytes doc/bilder/clientChatDialog.png | Bin 0 -> 37299 bytes doc/bilder/clientConfigDialog.png | Bin 0 -> 38714 bytes doc/bilder/clientToolbar.png | Bin 0 -> 8131 bytes doc/bilder/connectionframe.png | Bin 0 -> 55648 bytes doc/bilder/dum.jpg | Bin 0 -> 410679 bytes doc/bilder/dum.png | Bin 0 -> 31700 bytes doc/bilder/mainwindow.png | Bin 0 -> 61181 bytes doc/bilder/menu-key.png | Bin 0 -> 2179 bytes doc/bilder/processlist.png | Bin 0 -> 82069 bytes doc/bilder/pvsmgr.jpg | Bin 0 -> 114924 bytes doc/bilder/pvsmgrAll.jpg | Bin 0 -> 331431 bytes doc/bilder/runprocess.png | Bin 0 -> 41192 bytes doc/bilder/siegel-neu.jpg | Bin 0 -> 768543 bytes doc/bilder/siegel-neu.png | Bin 0 -> 1217444 bytes doc/bilder/studentctlpanel.png | Bin 0 -> 41591 bytes doc/bilder/vnc-frame-buttons.png | Bin 0 -> 7050 bytes doc/bilder/vnc-frame-buttons.xcf | Bin 0 -> 19912 bytes doc/build_doc.sh | 2 - doc/devel/0000-chapter.tex | 0 doc/devel/0100-build.tex | 69 + doc/devel/0200-gui-lib.tex | 31 + doc/devel/0300-pvs.tex | 505 +++++++ doc/devel/0310-service-discovery.tex | 84 ++ doc/devel/0400-pvs-console.tex | 176 +++ doc/devel/0500-pvs-client.tex | 243 ++++ doc/doxconf | 1512 -------------------- doc/header.tex | 58 + doc/intro/0000-chapter.tex | 17 + doc/intro/0100-funktionen.tex | 21 + doc/intro/0900-textaufbau.tex | 13 + doc/mystyle-pdf.tex | 112 ++ doc/pvs-doc.tex | 37 + doc/user/0000-chapter.tex | 0 doc/user/0100-pvs-steuer.tex | 144 ++ doc/user/0300-pvs-client.tex | 80 ++ doc/zusfassung.tex | 10 + misc/pvs.conf | 2 - pvsgui.qrc | 1 - src/gui/clientConfigDialog.cpp | 16 - src/gui/ui/clientConfigDialog.ui | 30 +- src/pvs.cpp | 22 +- src/pvs.h | 10 +- src/pvsDaemon.cpp | 23 - src/pvsgui.cpp | 1 - src/util/clientGUIUtils.h | 2 - src/util/clientGUIUtils_Win32.cpp | 46 - src/util/util.cpp | 50 +- src/util/util.h | 9 +- 117 files changed, 2340 insertions(+), 4140 deletions(-) delete mode 100644 doc/LaTeX/Makefile delete mode 100644 doc/LaTeX/appendix/0000-chapter.tex delete mode 100755 doc/LaTeX/bilder/ConnectionList.png delete mode 100644 doc/LaTeX/bilder/DBus.pdf delete mode 100644 doc/LaTeX/bilder/FictionalPolicyChainClassDiagram.dia delete mode 100644 doc/LaTeX/bilder/ImplementedPolicies.dia delete mode 100644 doc/LaTeX/bilder/InputEventHandlerChain-Sequence.dia delete mode 100644 doc/LaTeX/bilder/InputEventHandlerClassDiagram.dia delete mode 100644 doc/LaTeX/bilder/Klassendiagramm.pdf delete mode 100644 doc/LaTeX/bilder/Klassendiagramm.svg delete mode 100644 doc/LaTeX/bilder/PVSPrivInputDArchitecture.dia delete mode 100644 doc/LaTeX/bilder/PhasesOfKeyboardHandling.dia delete mode 100644 doc/LaTeX/bilder/PolicyChainClassDiagram.dia delete mode 100644 doc/LaTeX/bilder/SayHelloHandler-PolicyHier.dia delete mode 100644 doc/LaTeX/bilder/UebertragungsEbenen.dia delete mode 100644 doc/LaTeX/bilder/clientChatDialog.png delete mode 100644 doc/LaTeX/bilder/clientConfigDialog.png delete mode 100644 doc/LaTeX/bilder/clientToolbar.png delete mode 100755 doc/LaTeX/bilder/connectionframe.png delete mode 100644 doc/LaTeX/bilder/dum.jpg delete mode 100644 doc/LaTeX/bilder/dum.png delete mode 100755 doc/LaTeX/bilder/mainwindow.png delete mode 100644 doc/LaTeX/bilder/menu-key.png delete mode 100644 doc/LaTeX/bilder/processlist.png delete mode 100755 doc/LaTeX/bilder/pvsmgr.jpg delete mode 100755 doc/LaTeX/bilder/pvsmgrAll.jpg delete mode 100644 doc/LaTeX/bilder/runprocess.png delete mode 100644 doc/LaTeX/bilder/siegel-neu.jpg delete mode 100644 doc/LaTeX/bilder/siegel-neu.png delete mode 100644 doc/LaTeX/bilder/studentctlpanel.png delete mode 100644 doc/LaTeX/bilder/vnc-frame-buttons.png delete mode 100644 doc/LaTeX/bilder/vnc-frame-buttons.xcf delete mode 100644 doc/LaTeX/devel/0000-chapter.tex delete mode 100644 doc/LaTeX/devel/0100-build.tex delete mode 100644 doc/LaTeX/devel/0200-gui-lib.tex delete mode 100644 doc/LaTeX/devel/0300-pvs.tex delete mode 100644 doc/LaTeX/devel/0310-service-discovery.tex delete mode 100644 doc/LaTeX/devel/0400-pvs-console.tex delete mode 100644 doc/LaTeX/devel/0500-pvs-client.tex delete mode 100644 doc/LaTeX/header.tex delete mode 100644 doc/LaTeX/intro/0000-chapter.tex delete mode 100644 doc/LaTeX/intro/0100-funktionen.tex delete mode 100644 doc/LaTeX/intro/0900-textaufbau.tex delete mode 100644 doc/LaTeX/mystyle-pdf.tex delete mode 100644 doc/LaTeX/pvs-doc.tex delete mode 100644 doc/LaTeX/user/0000-chapter.tex delete mode 100644 doc/LaTeX/user/0100-pvs-steuer.tex delete mode 100644 doc/LaTeX/user/0300-pvs-client.tex delete mode 100644 doc/LaTeX/zusfassung.tex create mode 100644 doc/Makefile create mode 100644 doc/appendix/0000-chapter.tex create mode 100755 doc/bilder/ConnectionList.png create mode 100644 doc/bilder/DBus.pdf create mode 100644 doc/bilder/FictionalPolicyChainClassDiagram.dia create mode 100644 doc/bilder/ImplementedPolicies.dia create mode 100644 doc/bilder/InputEventHandlerChain-Sequence.dia create mode 100644 doc/bilder/InputEventHandlerClassDiagram.dia create mode 100644 doc/bilder/Klassendiagramm.pdf create mode 100644 doc/bilder/Klassendiagramm.svg create mode 100644 doc/bilder/PVSPrivInputDArchitecture.dia create mode 100644 doc/bilder/PhasesOfKeyboardHandling.dia create mode 100644 doc/bilder/PolicyChainClassDiagram.dia create mode 100644 doc/bilder/SayHelloHandler-PolicyHier.dia create mode 100644 doc/bilder/UebertragungsEbenen.dia create mode 100644 doc/bilder/clientChatDialog.png create mode 100644 doc/bilder/clientConfigDialog.png create mode 100644 doc/bilder/clientToolbar.png create mode 100755 doc/bilder/connectionframe.png create mode 100644 doc/bilder/dum.jpg create mode 100644 doc/bilder/dum.png create mode 100755 doc/bilder/mainwindow.png create mode 100644 doc/bilder/menu-key.png create mode 100644 doc/bilder/processlist.png create mode 100755 doc/bilder/pvsmgr.jpg create mode 100755 doc/bilder/pvsmgrAll.jpg create mode 100644 doc/bilder/runprocess.png create mode 100644 doc/bilder/siegel-neu.jpg create mode 100644 doc/bilder/siegel-neu.png create mode 100644 doc/bilder/studentctlpanel.png create mode 100644 doc/bilder/vnc-frame-buttons.png create mode 100644 doc/bilder/vnc-frame-buttons.xcf delete mode 100755 doc/build_doc.sh create mode 100644 doc/devel/0000-chapter.tex create mode 100644 doc/devel/0100-build.tex create mode 100644 doc/devel/0200-gui-lib.tex create mode 100644 doc/devel/0300-pvs.tex create mode 100644 doc/devel/0310-service-discovery.tex create mode 100644 doc/devel/0400-pvs-console.tex create mode 100644 doc/devel/0500-pvs-client.tex delete mode 100644 doc/doxconf create mode 100644 doc/header.tex create mode 100644 doc/intro/0000-chapter.tex create mode 100644 doc/intro/0100-funktionen.tex create mode 100644 doc/intro/0900-textaufbau.tex create mode 100644 doc/mystyle-pdf.tex create mode 100644 doc/pvs-doc.tex create mode 100644 doc/user/0000-chapter.tex create mode 100644 doc/user/0100-pvs-steuer.tex create mode 100644 doc/user/0300-pvs-client.tex create mode 100644 doc/zusfassung.tex mode change 100755 => 100644 src/pvs.cpp mode change 100755 => 100644 src/pvs.h delete mode 100755 src/util/clientGUIUtils_Win32.cpp diff --git a/AUTHORS b/AUTHORS index a081ceb..b94eeae 100644 --- a/AUTHORS +++ b/AUTHORS @@ -2,11 +2,11 @@ Initial design and first versions: Simon Wittenberg Involved team members at the moment: -Fabian Schillinger Johann Latocha -Sébastien Braun Credits of left team members: +Fabian Schillinger +Sébastien Braun Johann Betz Javier Castillo Achille Nana diff --git a/CMakeLists.txt b/CMakeLists.txt index 76d0d11..fccfb8b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,26 +2,23 @@ # General ################################################################################ -# set project's name -PROJECT( pvs ) - -# cmake min version -CMAKE_MINIMUM_REQUIRED( VERSION 2.6.2 ) +PROJECT(pvs) +CMAKE_MINIMUM_REQUIRED(VERSION 2.8.0) # set compiler optimizations for debug and release SET(CMAKE_BUILD_TYPE Debug) SET(CMAKE_C_FLAGS_DEBUG "-O0 -g -Wall -Wunused -Wunreachable-code") -SET(CMAKE_C_FLAGS_RELEASE "-O3 -march=native") +SET(CMAKE_C_FLAGS_RELEASE "-O2") SET(CMAKE_CXX_FLAGS_DEBUG "-O0 -g -Wall") -SET(CMAKE_CXX_FLAGS_RELEASE "-O2 -DQT_NO_DEBUG_OUTPUT" ) +SET(CMAKE_CXX_FLAGS_RELEASE "-O2" ) # local cmake modules SET(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake) # this command finds libraries and sets all required variables -FIND_PACKAGE( Qt4 4.5.0 REQUIRED ) -FIND_PACKAGE( X11 REQUIRED ) -FIND_PACKAGE( VNC REQUIRED ) +FIND_PACKAGE(Qt4 4.5.0 REQUIRED) +FIND_PACKAGE(X11 REQUIRED) +FIND_PACKAGE(VNC REQUIRED) # some includes INCLUDE_DIRECTORIES( @@ -41,25 +38,13 @@ ENDIF() ADD_SUBDIRECTORY(src/input) -IF(WIN32) - SET(sysdep_suffix _Win32) - INCLUDE_DIRECTORIES( - /c/KDE4/tmp/LibVNCServer-0.9.7/ - ) -ELSEIF(UNIX) - SET(sysdep_suffix _X11) -ENDIF(WIN32) - -################################################################################ -# Build third-party libraries -################################################################################ -ADD_SUBDIRECTORY(3rdparty/qtsingleapplication) - +SET(SYSDEP_SUFFIX _X11) ################################################################################ # Build third-party libraries ################################################################################ +ADD_SUBDIRECTORY(3rdparty/qtsingleapplication) ADD_SUBDIRECTORY(3rdparty) ################################################################################ @@ -72,9 +57,8 @@ ADD_SUBDIRECTORY(src/net/mcast) # Variables ################################################################################ -# with SET() command you can change variables or define new ones. -# we define PVSMGR_SRCS variable that contains a list of all .cpp files -SET( PVSMGR_SRCS +# pvsmgr +SET(PVSMGR_SRCS src/pvsmgr.cpp src/core/pvsClient.cpp src/core/pvsConnectionManager.cpp @@ -109,7 +93,7 @@ SET( PVSMGR_SRCS ) # pvs -SET( PVS_SRCS +SET(PVS_SRCS src/pvsDaemon.cpp src/pvs.cpp src/net/pvsMsg.cpp @@ -118,7 +102,7 @@ SET( PVS_SRCS src/net/pvsLocalhostCommunicator.cpp src/util/util.cpp src/util/consoleLogger.cpp - src/util/clientGUIUtils${sysdep_suffix}.cpp + src/util/clientGUIUtils${SYSDEP_SUFFIX}.cpp src/core/pvsChatClient.cpp src/net/pvsServiceDiscovery.cpp src/net/pvsDiscoveredServer.cpp @@ -129,7 +113,7 @@ SET( PVS_SRCS ) # pvsgui -SET( PVSGUI_SRCS +SET(PVSGUI_SRCS ${QTSINGLEAPPLICATION_SRCS} src/pvsgui.cpp src/gui/clientConfigDialog.cpp @@ -149,8 +133,8 @@ SET( PVSGUI_SRCS # Qt ################################################################################ -# some .ui files (Qt) -SET( PVSMGR_UIS +# .ui files +SET(PVSMGR_UIS src/gui/ui/mainwindow.ui src/gui/ui/profileDialog.ui src/gui/ui/dialog.ui @@ -165,7 +149,7 @@ SET( PVSMGR_UIS src/gui/ui/multicastConfigDialog.ui ) -SET( PVSMGRTOUCH_UIS +SET(PVSMGRTOUCH_UIS src/gui/ui/mainwindowtouch.ui src/gui/ui/profileDialog.ui src/gui/ui/dialog.ui @@ -176,7 +160,7 @@ SET( PVSMGRTOUCH_UIS src/gui/ui/multicastConfigDialog.ui ) -SET( PVSGUI_UIS +SET(PVSGUI_UIS src/gui/ui/clientConfigDialog.ui src/gui/ui/clientFileSendDialog.ui src/gui/ui/clientFileReceiveDialog.ui @@ -187,21 +171,13 @@ SET( PVSGUI_UIS src/gui/ui/clientNicklistDialog.ui ) -# resource file (Qt) -SET( PVSMGR_RCS - pvsmgr.qrc -) - -SET( PVS_RCS - pvs.qrc -) +# .qrc files +SET(PVSMGR_RCS pvsmgr.qrc) +SET(PVS_RCS pvs.qrc) +SET(PVSGUI_RCS pvsgui.qrc) -SET( PVSGUI_RCS - pvsgui.qrc -) - -# includes all header files that should be treated with moc (Qt) -SET( PVSMGR_MOC_HDRS +# includes all header files that should be treated with moc +SET(PVSMGR_MOC_HDRS src/gui/mainWindow.h src/gui/connectionWindow.h src/gui/frame.h @@ -227,7 +203,7 @@ SET( PVSMGR_MOC_HDRS src/gui/multicastConfigDialog.h ) -SET( PVS_MOC_HDRS +SET(PVS_MOC_HDRS src/pvs.h src/net/pvsLocalhostCommunicator.h src/net/pvsServerConnection.h @@ -237,7 +213,7 @@ SET( PVS_MOC_HDRS src/net/pvsIncomingMulticastTransfer.h ) -SET( PVSGUI_MOC_HDRS +SET(PVSGUI_MOC_HDRS ${QTSINGLEAPPLICATION_MOC_HDRS} src/pvsgui.h src/gui/clientConfigDialog.h @@ -251,8 +227,8 @@ SET( PVSGUI_MOC_HDRS src/net/pvsNetworkInterfaceListModel.h ) -# i18n (Qt) -SET( PVSMGR_TSS +# i18n +SET(PVSMGR_TSS i18n/pvsmgr_de_DE.ts i18n/pvsmgr_fr_FR.ts i18n/pvsmgr_es_MX.ts @@ -260,7 +236,7 @@ SET( PVSMGR_TSS i18n/pvsmgr_pl_PL.ts ) -SET( PVS_TSS +SET(PVS_TSS i18n/pvs_de_DE.ts i18n/pvs_fr_FR.ts i18n/pvs_es_MX.ts @@ -268,7 +244,7 @@ SET( PVS_TSS i18n/pvs_pl_PL.ts ) -SET( PVSGUI_TSS +SET(PVSGUI_TSS i18n/pvsgui_de_DE.ts i18n/pvsgui_fr_FR.ts i18n/pvsgui_es_MX.ts @@ -277,52 +253,47 @@ SET( PVSGUI_TSS ) -# by default only QtCore and QtGui modules are enabled -# other modules must be enabled like this: -SET( QT_USE_QTDBUS TRUE ) -SET( QT_USE_QTNETWORK TRUE ) +# include Qt modules +SET(QT_USE_QTDBUS TRUE) +SET(QT_USE_QTNETWORK TRUE) # add some useful macros and variables # (QT_USE_FILE is a variable defined by FIND_PACKAGE( Qt4 ) that contains # a path to CMake script) -INCLUDE( ${QT_USE_FILE} ) +INCLUDE(${QT_USE_FILE}) -# this command will generate rules that will run rcc on all files from -# PVSCLIENTGUI_RCS. in result PVSCLIENTGUI_RC_SRCS variable will contain paths -# to files produced by rcc -QT4_ADD_RESOURCES( PVSMGR_RC_SRCS ${PVSMGR_RCS} ) -QT4_ADD_RESOURCES( PVS_RC_SRCS ${PVS_RCS} ) -QT4_ADD_RESOURCES( PVSGUI_RC_SRCS ${PVSGUI_RCS} ) +# this will run rcc on .qrc files +QT4_ADD_RESOURCES(PVSMGR_RC_SRCS ${PVSMGR_RCS}) +QT4_ADD_RESOURCES(PVS_RC_SRCS ${PVS_RCS}) +QT4_ADD_RESOURCES(PVSGUI_RC_SRCS ${PVSGUI_RCS}) -# this will run uic on .ui files: -QT4_WRAP_UI( PVSMGR_UI_HDRS ${PVSMGR_UIS} ) -QT4_WRAP_UI( PVSMGRTOUCH_UI_HDRS ${PVSMGRTOUCH_UIS} ) -QT4_WRAP_UI( PVSGUI_UI_HDRS ${PVSGUI_UIS} ) +# this will run uic on .ui files +QT4_WRAP_UI(PVSMGR_UI_HDRS ${PVSMGR_UIS}) +QT4_WRAP_UI(PVSMGRTOUCH_UI_HDRS ${PVSMGRTOUCH_UIS}) +QT4_WRAP_UI(PVSGUI_UI_HDRS ${PVSGUI_UIS}) -# this will run moc: -QT4_WRAP_CPP( PVSMGR_MOC_SRCS ${PVSMGR_MOC_HDRS} ) -QT4_WRAP_CPP( PVS_MOC_SRCS ${PVS_MOC_HDRS} ) -QT4_WRAP_CPP( PVSGUI_MOC_SRCS ${PVSGUI_MOC_HDRS} ) +# this will run moc +QT4_WRAP_CPP(PVSMGR_MOC_SRCS ${PVSMGR_MOC_HDRS}) +QT4_WRAP_CPP(PVS_MOC_SRCS ${PVS_MOC_HDRS}) +QT4_WRAP_CPP(PVSGUI_MOC_SRCS ${PVSGUI_MOC_HDRS}) # run qdbuscpp2xml -QT4_GENERATE_DBUS_INTERFACE( src/pvs.h org.openslx.pvs.xml ) +QT4_GENERATE_DBUS_INTERFACE(src/pvs.h org.openslx.pvs.xml) # run qdbusxml2cpp -QT4_ADD_DBUS_ADAPTOR( PVS_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml src/pvs.h PVS ) -QT4_ADD_DBUS_INTERFACE( PVSGUI_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml pvsinterface ) +QT4_ADD_DBUS_ADAPTOR(PVS_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml src/pvs.h PVS) +QT4_ADD_DBUS_INTERFACE(PVSGUI_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml pvsinterface) # i18n, run lupdate and lrelease) -#QT4_CREATE_TRANSLATION( PVSMGR_QMS ${PVSMGR_SRCS} ${PVSMGR_UI_HDRS} ${PVSMGR_TSS} ) -#QT4_CREATE_TRANSLATION( PVS_QMS ${PVS_SRCS} ${PVS_TSS} ) -#QT4_CREATE_TRANSLATION( PVSGUI_QMS ${PVSGUI_SRCS} ${PVSGUI_UI_HDRS} ${PVSGUI_TSS} ) +#QT4_CREATE_TRANSLATION(PVSMGR_QMS ${PVSMGR_SRCS} ${PVSMGR_UI_HDRS} ${PVSMGR_TSS}) +#QT4_CREATE_TRANSLATION(PVS_QMS ${PVS_SRCS} ${PVS_TSS}) +#QT4_CREATE_TRANSLATION(PVSGUI_QMS ${PVSGUI_SRCS} ${PVSGUI_UI_HDRS} ${PVSGUI_TSS}) ################################################################################ # Build ################################################################################ -## here we instruct CMake to build our executable from all of the source files -if(UNIX) -ADD_EXECUTABLE( pvsmgr +ADD_EXECUTABLE(pvsmgr ${PVSMGR_SRCS} ${PVSMGR_MOC_SRCS} ${PVSMGR_UI_HDRS} @@ -330,23 +301,22 @@ ADD_EXECUTABLE( pvsmgr ${PVSMGR_QMS} ) -ADD_EXECUTABLE( pvsmgrtouch +ADD_EXECUTABLE(pvsmgrtouch ${PVSMGR_SRCS} ${PVSMGR_MOC_SRCS} ${PVSMGRTOUCH_UI_HDRS} ${PVSMGR_RC_SRCS} ${PVSMGR_QMS} ) -ENDIF(UNIX) -ADD_EXECUTABLE( pvs +ADD_EXECUTABLE(pvs ${PVS_SRCS} ${PVS_MOC_SRCS} ${PVS_RC_SRCS} ${PVS_QMS} ) -ADD_EXECUTABLE( pvsgui +ADD_EXECUTABLE(pvsgui ${PVSGUI_SRCS} ${PVSGUI_MOC_SRCS} ${PVSGUI_UI_HDRS} @@ -354,99 +324,61 @@ ADD_EXECUTABLE( pvsgui ${PVSGUI_QMS} ) -# last thing we have to do is to tell CMake what libraries our executable needs, -# luckily FIND_PACKAGE prepared variables for us: - -IF(WIN32) - TARGET_LINK_LIBRARIES( pvsmgr - - ) -ELSEIF(UNIX) -TARGET_LINK_LIBRARIES( pvsmgr - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - ${X11_LIBRARIES} - pvsmcast - pvsinput - ) -ENDIF(WIN32) - -IF(WIN32) - TARGET_LINK_LIBRARIES( pvsmgrtouch - - ) -ELSEIF(UNIX) - TARGET_LINK_LIBRARIES( pvsmgrtouch - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - ${X11_LIBRARIES} - pvsmcast - pvsinput - ) -ENDIF(WIN32) - -IF(WIN32) - TARGET_LINK_LIBRARIES( pvs - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - advapi32 - ws2_32 - ) -ELSEIF(UNIX) - TARGET_LINK_LIBRARIES( pvs - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - ${X11_LIBRARIES} - ${X11_XTest_LIB} - ${X11_Xinput_LIB} - pvsmcast - pvsinput - ) -ENDIF(WIN32) - -IF(WIN32) - TARGET_LINK_LIBRARIES( pvsgui - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - #advapi32 - ws2_32 - ) -ELSEIF(UNIX) - TARGET_LINK_LIBRARIES( pvsgui - ${QT_LIBRARIES} - ${VNC_LIBRARIES} - ) -ENDIF(WIN32) - -IF(UNIX) +# link +TARGET_LINK_LIBRARIES(pvsmgr + ${QT_LIBRARIES} + ${VNC_LIBRARIES} + ${X11_LIBRARIES} + pvsmcast + pvsinput +) + +TARGET_LINK_LIBRARIES(pvsmgrtouch + ${QT_LIBRARIES} + ${VNC_LIBRARIES} + ${X11_LIBRARIES} + pvsmcast + pvsinput +) + +TARGET_LINK_LIBRARIES(pvs + ${QT_LIBRARIES} + ${VNC_LIBRARIES} + ${X11_LIBRARIES} + ${X11_XTest_LIB} + ${X11_Xinput_LIB} + pvsmcast + pvsinput +) + +TARGET_LINK_LIBRARIES(pvsgui + ${QT_LIBRARIES} + ${VNC_LIBRARIES} +) + SET_PROPERTY(TARGET pvsmgrtouch PROPERTY COMPILE_DEFINITIONS MAINWINDOW_USE_TOUCHGUI) SET_PROPERTY(TARGET pvsmgr PROPERTY COMPILE_DEFINITIONS MAINWINDOW_USE_NORMALGUI) -ENDIF(UNIX) - -# add install target to our makefile -IF(WIN32) - INSTALL( TARGETS pvs pvsgui RUNTIME DESTINATION bin ) -ELSEIF(UNIX) - CONFIGURE_FILE( org.openslx.pvs.service ${CMAKE_BINARY_DIR}/org.openslx.pvs.service ) - INSTALL( TARGETS pvsmgr pvs pvsgui pvsmgrtouch RUNTIME DESTINATION bin ) - INSTALL( PROGRAMS misc/pvs-vncsrv DESTINATION bin) - INSTALL( FILES ${CMAKE_BINARY_DIR}/org.openslx.pvs.service DESTINATION share/dbus-1/services ) - INSTALL( FILES misc/pvs.conf misc/pvsgui.conf misc/pvsmgr.conf DESTINATION /etc/openslx ) - INSTALL( FILES misc/pvsgui.desktop DESTINATION /etc/xdg/autostart ) -ENDIF(WIN32) - -# add uninstall target to our makefile + +# install +CONFIGURE_FILE(org.openslx.pvs.service ${CMAKE_BINARY_DIR}/org.openslx.pvs.service) +INSTALL(TARGETS pvsmgr pvs pvsgui pvsmgrtouch RUNTIME DESTINATION bin) +INSTALL(PROGRAMS misc/pvs-vncsrv DESTINATION bin) +INSTALL(FILES ${CMAKE_BINARY_DIR}/org.openslx.pvs.service DESTINATION share/dbus-1/services) +INSTALL(FILES misc/pvs.conf misc/pvsgui.conf misc/pvsmgr.conf DESTINATION /etc/openslx) +INSTALL(FILES misc/pvsgui.desktop DESTINATION /etc/xdg/autostart) + +# uninstall CONFIGURE_FILE( "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Uninstall.cmake" "${CMAKE_CURRENT_BINARY_DIR}/cmake/Uninstall.cmake" IMMEDIATE @ONLY ) -ADD_CUSTOM_TARGET( uninstall +ADD_CUSTOM_TARGET(uninstall "${CMAKE_COMMAND}" -P "${CMAKE_CURRENT_BINARY_DIR}/cmake/Uninstall.cmake" ) -# add package target to our makefile -SET( CPACK_GENERATOR "DEB;RPM" ) +# package +SET( CPACK_GENERATOR "DEB" ) SET( CPACK_SET_DESTDIR "ON" ) SET( CPACK_PACKAGE_NAME "pvs" ) SET( CPACK_PACKAGE_VERSION_MAJOR "3" ) @@ -454,10 +386,10 @@ SET( CPACK_PACKAGE_VERSION_MINOR "1" ) SET( CPACK_PACKAGE_VERSION_PATCH "1" ) SET( CPACK_PACKAGE_DESCRIPTION_SUMMARY "Pool Video Switch" ) SET( CPACK_PACKAGE_DESCRIPTION "") -SET( CPACK_PACKAGE_CONTACT "Simon Wittenberg " ) +SET( CPACK_PACKAGE_CONTACT "Johann Latocha " ) SET( CPACK_DEBIAN_PACKAGE_DEPENDS "libvncserver0 (>= 0.9.3.dfsg.1-2), libqtgui4 (>= 4:4.5.3-4), libqt4-dbus (>= 4:4.5.3-4), libqt4-network (>= 4:4.5.3-4)" ) SET( CPACK_DEBIAN_PACKAGE_ARCHITECTURE "i386" ) SET( CPACK_DEBIAN_PACKAGE_SECTION "Network" ) SET( CPACK_DEBIAN_PACKAGE_PRIORITY "optional" ) SET( CPACK_DEBIAN_PACKAGE_RECOMMENDS "x11vnc (>= 0.9.9-1)" ) -INCLUDE( CPack ) # must be last! +INCLUDE( CPack ) diff --git a/INSTALL b/INSTALL index 6a7d736..437f9bc 100644 --- a/INSTALL +++ b/INSTALL @@ -10,7 +10,7 @@ The following packages are required: libxtst-dev libqt4-dev >= 4.5.3 qt4-dev-tools >= 4.5.3 - cmake >= 2.4.0 + cmake >= 2.8.0 *** Installation *** @@ -31,11 +31,14 @@ So change the current directory with: As superuser (root) you can install the application on your system: make install +As superuser (root) you can uninstall too + make uninstall + It is also possible to build distribution specific packages (currently DEB only) make package The Serverapplication is started with - pvsmgr + pvsmgrtouch the Clientdaemon with pvs @@ -43,18 +46,4 @@ the Clientdaemon with and the Clientgui with pvsgui - -*** VNC-Server for the PVS-Client *** - -Additionally a script/program has to be supplied to start/stop the vnc-server on the pvs-client. -The program/script is expected to have the following signature: - - program/script(start/stop, port, password) - -All paramters are passed as strings. The first paramter is either "start" or "stop", the second one defines the port on which the -vnc-server should run, the third which password should be set. -Password and port are randomized by the PVS-Client. The port is chosen in the range of [59000, 59100]. - -*** Contact *** - -In case of problems, questions or any kind of feedback, mail me : wittenb@informatik.uni-freiburg.de +In case of problems, questions or any kind of feedback, mail me : johann@latocha.de diff --git a/KNOWNBUGS b/KNOWNBUGS index 7b051c4..e69de29 100644 --- a/KNOWNBUGS +++ b/KNOWNBUGS @@ -1,26 +0,0 @@ - -Pattern: - - #number Where? - Description - - - - - - -#1 Frametable - Frametable seems to spread out if you return from fullscreen/closeup. - doesnt seem to happen when you chose the upper, rightmost connection for fullscreen, - but every other... - -#2 Closeup - When returning from fullscreen to closeup, the picture isnt scaled down and looks silly - -#3 Closeup - Sometimes closeup seems to grow without stopping and so never showing a picture - -#4 Fullscreen - When the connection breaks down while in fullscreen, fullscreen is not canceled - - diff --git a/README b/README index c5cf781..4b5f2c3 100644 --- a/README +++ b/README @@ -1,15 +1,4 @@ For installation guidance, consult the INSTALL file. ATTENTION! - An external vnc service is necessary on the client side (e.g. x11vnc). - -Furthermore, the client (pvs) expects a .pvs directory in the home directory of the user (will be created on the first launch of -the client). In this directory, it expects a .pass file with the vnc-password and a file name .allow which contains a representation -of true/false ({1,0}, {true,false}) whether the vnc access should be allowed or disallowed. - -For Now, the Projection feature expects the VNC-Server on the PVS-Servers machine to accept no password or "viewonly" as password. -A listing of client commands is following. - -For further information regarding options of the PVS-Client: - - pvs -h or pvs --help \ No newline at end of file + An external vnc service is necessary on the client side (e.g. x11vnc). \ No newline at end of file diff --git a/doc/LaTeX/Makefile b/doc/LaTeX/Makefile deleted file mode 100644 index a3ecaf2..0000000 --- a/doc/LaTeX/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -GENERATED_EPS_IMAGES = $(addsuffix .eps,$(basename $(shell echo bilder/*.dia))) -GENERATED_PDF_IMAGES = $(addsuffix .pdf,$(basename $(GENERATED_EPS_IMAGES))) - -build: $(GENERATED_PDF_IMAGES) - pdflatex pvs-doc - pdflatex pvs-doc - makeindex pvs-doc - pdflatex pvs-doc -.PHONY: build - -clean: - rm -f $(GENERATED_PDF_IMAGES) $(GENERATED_EPS_IMAGES) - rm -f pvs-doc.aux pvs-doc.idx pvs-doc.ilg pvs-doc.ing pvs-doc.log pvs-doc.out pvs-doc.pdf pvs-doc.toc -.PHONY: clean - -%.eps : %.dia - dia -e $@ $< - -%.pdf : %.eps - epstopdf --outfile=$@ $< diff --git a/doc/LaTeX/appendix/0000-chapter.tex b/doc/LaTeX/appendix/0000-chapter.tex deleted file mode 100644 index 97e98c3..0000000 --- a/doc/LaTeX/appendix/0000-chapter.tex +++ /dev/null @@ -1,6 +0,0 @@ -\begin{figure}[h] - \begin{center} - \includegraphics[scale=0.7]{bilder/Klassendiagramm} - \label{png:kd} - \end{center} -\end{figure} \ No newline at end of file diff --git a/doc/LaTeX/bilder/ConnectionList.png b/doc/LaTeX/bilder/ConnectionList.png deleted file mode 100755 index 93140cb..0000000 Binary files a/doc/LaTeX/bilder/ConnectionList.png and /dev/null differ diff --git a/doc/LaTeX/bilder/DBus.pdf b/doc/LaTeX/bilder/DBus.pdf deleted file mode 100644 index 90331d6..0000000 Binary files a/doc/LaTeX/bilder/DBus.pdf and /dev/null differ diff --git a/doc/LaTeX/bilder/FictionalPolicyChainClassDiagram.dia b/doc/LaTeX/bilder/FictionalPolicyChainClassDiagram.dia deleted file mode 100644 index 620a9d1..0000000 Binary files a/doc/LaTeX/bilder/FictionalPolicyChainClassDiagram.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/ImplementedPolicies.dia b/doc/LaTeX/bilder/ImplementedPolicies.dia deleted file mode 100644 index 97ab5e8..0000000 Binary files a/doc/LaTeX/bilder/ImplementedPolicies.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/InputEventHandlerChain-Sequence.dia b/doc/LaTeX/bilder/InputEventHandlerChain-Sequence.dia deleted file mode 100644 index 73a789a..0000000 Binary files a/doc/LaTeX/bilder/InputEventHandlerChain-Sequence.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/InputEventHandlerClassDiagram.dia b/doc/LaTeX/bilder/InputEventHandlerClassDiagram.dia deleted file mode 100644 index dd8b3a0..0000000 Binary files a/doc/LaTeX/bilder/InputEventHandlerClassDiagram.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/Klassendiagramm.pdf b/doc/LaTeX/bilder/Klassendiagramm.pdf deleted file mode 100644 index ab5dc9c..0000000 Binary files a/doc/LaTeX/bilder/Klassendiagramm.pdf and /dev/null differ diff --git a/doc/LaTeX/bilder/Klassendiagramm.svg b/doc/LaTeX/bilder/Klassendiagramm.svg deleted file mode 100644 index 8b4ea29..0000000 --- a/doc/LaTeX/bilder/Klassendiagramm.svg +++ /dev/null @@ -1,581 +0,0 @@ - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - PVSGUI - - - - ClientConfigDialog - - - - ClientInfoDialog - - - - AboutDialog - - - - OrgOpenslxPvsInterface - - - - - - - - - - ClientChatDialog - - - - ClientVNCViewer - - - - - OrgOpenslxPvsInterface - - - - - VNCClientThread - - - - ClientFileSendDialog - - - - ClientFileReceiveDialog - - - - - - OrgOpenslxPvsInterface - - - - - OrgOpenslxPvsInterface - - - - - - - ClientFileSendDialog - - - - OrgOpenslxPvsInterface - - - - - - - - - PVS - - - - OrgOpenslxPvsInterface - - - - - Klassendiagramm - - diff --git a/doc/LaTeX/bilder/PVSPrivInputDArchitecture.dia b/doc/LaTeX/bilder/PVSPrivInputDArchitecture.dia deleted file mode 100644 index 4278ba7..0000000 Binary files a/doc/LaTeX/bilder/PVSPrivInputDArchitecture.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/PhasesOfKeyboardHandling.dia b/doc/LaTeX/bilder/PhasesOfKeyboardHandling.dia deleted file mode 100644 index 9250e0b..0000000 Binary files a/doc/LaTeX/bilder/PhasesOfKeyboardHandling.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/PolicyChainClassDiagram.dia b/doc/LaTeX/bilder/PolicyChainClassDiagram.dia deleted file mode 100644 index 3a311f5..0000000 Binary files a/doc/LaTeX/bilder/PolicyChainClassDiagram.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/SayHelloHandler-PolicyHier.dia b/doc/LaTeX/bilder/SayHelloHandler-PolicyHier.dia deleted file mode 100644 index 341ff41..0000000 Binary files a/doc/LaTeX/bilder/SayHelloHandler-PolicyHier.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/UebertragungsEbenen.dia b/doc/LaTeX/bilder/UebertragungsEbenen.dia deleted file mode 100644 index 5ae4edb..0000000 Binary files a/doc/LaTeX/bilder/UebertragungsEbenen.dia and /dev/null differ diff --git a/doc/LaTeX/bilder/clientChatDialog.png b/doc/LaTeX/bilder/clientChatDialog.png deleted file mode 100644 index cab6b26..0000000 Binary files a/doc/LaTeX/bilder/clientChatDialog.png and /dev/null differ diff --git a/doc/LaTeX/bilder/clientConfigDialog.png b/doc/LaTeX/bilder/clientConfigDialog.png deleted file mode 100644 index c7e7732..0000000 Binary files a/doc/LaTeX/bilder/clientConfigDialog.png and /dev/null differ diff --git a/doc/LaTeX/bilder/clientToolbar.png b/doc/LaTeX/bilder/clientToolbar.png deleted file mode 100644 index e892c0e..0000000 Binary files a/doc/LaTeX/bilder/clientToolbar.png and /dev/null differ diff --git a/doc/LaTeX/bilder/connectionframe.png b/doc/LaTeX/bilder/connectionframe.png deleted file mode 100755 index ba158b9..0000000 Binary files a/doc/LaTeX/bilder/connectionframe.png and /dev/null differ diff --git a/doc/LaTeX/bilder/dum.jpg b/doc/LaTeX/bilder/dum.jpg deleted file mode 100644 index 231ffb1..0000000 Binary files a/doc/LaTeX/bilder/dum.jpg and /dev/null differ diff --git a/doc/LaTeX/bilder/dum.png b/doc/LaTeX/bilder/dum.png deleted file mode 100644 index 9284736..0000000 Binary files a/doc/LaTeX/bilder/dum.png and /dev/null differ diff --git a/doc/LaTeX/bilder/mainwindow.png b/doc/LaTeX/bilder/mainwindow.png deleted file mode 100755 index b7ba8c4..0000000 Binary files a/doc/LaTeX/bilder/mainwindow.png and /dev/null differ diff --git a/doc/LaTeX/bilder/menu-key.png b/doc/LaTeX/bilder/menu-key.png deleted file mode 100644 index 8cec826..0000000 Binary files a/doc/LaTeX/bilder/menu-key.png and /dev/null differ diff --git a/doc/LaTeX/bilder/processlist.png b/doc/LaTeX/bilder/processlist.png deleted file mode 100644 index c2e09af..0000000 Binary files a/doc/LaTeX/bilder/processlist.png and /dev/null differ diff --git a/doc/LaTeX/bilder/pvsmgr.jpg b/doc/LaTeX/bilder/pvsmgr.jpg deleted file mode 100755 index ec5ae30..0000000 Binary files a/doc/LaTeX/bilder/pvsmgr.jpg and /dev/null differ diff --git a/doc/LaTeX/bilder/pvsmgrAll.jpg b/doc/LaTeX/bilder/pvsmgrAll.jpg deleted file mode 100755 index a522424..0000000 Binary files a/doc/LaTeX/bilder/pvsmgrAll.jpg and /dev/null differ diff --git a/doc/LaTeX/bilder/runprocess.png b/doc/LaTeX/bilder/runprocess.png deleted file mode 100644 index 7b2f6bd..0000000 Binary files a/doc/LaTeX/bilder/runprocess.png and /dev/null differ diff --git a/doc/LaTeX/bilder/siegel-neu.jpg b/doc/LaTeX/bilder/siegel-neu.jpg deleted file mode 100644 index 3bb83a9..0000000 Binary files a/doc/LaTeX/bilder/siegel-neu.jpg and /dev/null differ diff --git a/doc/LaTeX/bilder/siegel-neu.png b/doc/LaTeX/bilder/siegel-neu.png deleted file mode 100644 index 1cff269..0000000 Binary files a/doc/LaTeX/bilder/siegel-neu.png and /dev/null differ diff --git a/doc/LaTeX/bilder/studentctlpanel.png b/doc/LaTeX/bilder/studentctlpanel.png deleted file mode 100644 index 84930f5..0000000 Binary files a/doc/LaTeX/bilder/studentctlpanel.png and /dev/null differ diff --git a/doc/LaTeX/bilder/vnc-frame-buttons.png b/doc/LaTeX/bilder/vnc-frame-buttons.png deleted file mode 100644 index 0a0a69d..0000000 Binary files a/doc/LaTeX/bilder/vnc-frame-buttons.png and /dev/null differ diff --git a/doc/LaTeX/bilder/vnc-frame-buttons.xcf b/doc/LaTeX/bilder/vnc-frame-buttons.xcf deleted file mode 100644 index faf5261..0000000 Binary files a/doc/LaTeX/bilder/vnc-frame-buttons.xcf and /dev/null differ diff --git a/doc/LaTeX/devel/0000-chapter.tex b/doc/LaTeX/devel/0000-chapter.tex deleted file mode 100644 index e69de29..0000000 diff --git a/doc/LaTeX/devel/0100-build.tex b/doc/LaTeX/devel/0100-build.tex deleted file mode 100644 index f0e1723..0000000 --- a/doc/LaTeX/devel/0100-build.tex +++ /dev/null @@ -1,69 +0,0 @@ -\chapter{Erzeugen und Installieren der Applikation} -\index{Installieren} -Um den Pool Video Switch erfolgreich zu kompilieren, müssen zunächst die Quelldateien heruntergeladen werden. Hierzu sollte auf dem Arbeitsrechner ein Subversion-Client installiert sein. Ein Checkout kann in einem beliebigen Terminal erfolgen, wobei es zwei unterschiedliche Arten des Zugriffs gibt.\\ - -Anonym, nur Leserechte:\\ -\textbf{git clone git://git.openslx.org/pvs.git pvs}\\ - -Mit Account, auch Schreibrechte (hier wird vorausgesetzt, dass der Benutzer vorher seinen öffentlichen SSH-Schlüssel hinterlegt hat):\\ -\textbf{git clone git@openslx.org:pvs.git}\\ - - -\section{Voraussetzungen} -Der Pool Video Switch benötigt zum Kompilieren folgende Pakete (und ihre Abhängigkeiten): -\begin{itemize} - \item libvncserver-dev >= 0.9.3\\ - Eine angenehm kleine, wenn auch in C geschriebene, Bibliothek für die Erstellung von VNC Servern und Clients. - \item libx11-dev >= 1.3.3\\ - Diese Bibliothek wurde eingesetzt, um ausgewählten oder allen Zielrechnern den Zugriff auf Maus und Tastatur zu entziehen und den Bildschirm schwarz zu schalten. - \item libqt4-dev >= 4.5.3\\ - Sowohl die Server als auch die ClientGUI benutzen das Qt Framework in der Version 4. Ferner wird QtNetwork zur Kommunikation zwischen Server und Client benötigt und QtDbus zur Interprozesskommunikation zwischen Client-Daemon und GUI. - \item qt4-dev-tools >= 4.5.3\\ - Dies wird nur benötigt, falls Unterstützung weiterer Sprachen implementiert werden soll, da in diesem Paket das Hilfsprogramm \textbf{linguist} enthalten ist. - \item cmake >= 2.4.0\\ - Eingesetztes Buildsystem und der Makefile-Generator. Um distributionsspezifische Pakete zu erzeugen wird CPack benutzt. - \item libxtst-dev, libxi-dev\\ - Diese Bibliotheken dienen zur Implementierung der Fernsteuerungsfunktionen. -\end{itemize} - -\section{Kompilieren aus Quellen} -Sobald alle Voraussetzungen erfüllt und die Quellen installiert sind, kann das ausführbare Programm erzeugt werden. Falls gewünscht, kann zusätzlich in der Datei \textit{CMakeLists.txt} der Build-Type eingestellt werden. Gültige Werte sind \texttt{Debug} und \texttt{Release} und ihre Wirkung den zwei weiteren Zeilen zu entnehmen. -\begin{verbatim} -SET(CMAKE_BUILD_TYPE Debug) -SET(CMAKE_CXX_FLAGS_DEBUG "-O0 -g -Wall") -SET(CMAKE_CXX_FLAGS_RELEASE "-O3 -march=native") -\end{verbatim} -Damit das Wurzelverzeichnis des Projekts weiterhin sauber bleibt (Übersicht beibehalten, Arbeit mit SVN erleichtern), werden wir hier einen Out-Of-Source Build durchführen. Dies bedeutet, dass zum Kompilieren ein seperates Verzeichnis benutzt wird und sämtliche automatisch generierten Dateien sowie das Kompilat selbst hier abgelegt wird. In einem Terminal sollte nun in das Verzeichnis indem sich das Projekt befindet gewechselt werden, um folgende Befehle ausführen zu können:\\ - -\textbf{mkdir -p build}\\ -\textbf{cd build/}\\ -\textbf{cmake ..}\\ -\textbf{make}\\ - -Die verschiedenen Applikationen können nun folgendermaßen (in \textit{build/}) ausgeführt und getestet werden: -\begin{itemize} - \item Den Server starten: \textbf{./pvsmgr} - \item Den Server mit Touchscreenoberfläche starten: \textbf{./pvsmgrtouch} - \item Den ClientDaemon starten: \textbf{./pvs} - \item Die ClientGUI starten: \textbf{./pvsgui} -\end{itemize} - -\section{Installation} -\index{Paket!RPM} \index{Paket!DPKG} -Nachdem das Projekt kompiliert wurde, kann es (als Superuser z.B. root) auf dem lokalen System installiert werden:\\ -\textbf{make install}\\ - -Dabei werden folgende Dateien auf das aktuelle System übertragen:\\ -\textit{/usr/local/bin/pvsmgr}\\ -\textit{/usr/local/bin/pvs}\\ -\textit{/usr/local/bin/pvsgui}\\ -\textit{/usr/local/bin/pvsmgrtouch}\\ -\textit{/usr/local/share/dbus-1/services/org.openslx.pvs.service}\\ - -Ein Vorteil ist, dass nun ein seperates Ausführen des Client-Daemon nicht mehr notwendig ist. Dieser wird ab sofort automatisch gestartet und beendet, sobald die ClientGUI ausgeführt wurde.\\ - -Es ist ebenfalls möglich, distributionsspezifische Pakete zu erstellen (zur Zeit nur .deb):\\ -\textbf{make package}\\ - -Falls erfolgreich, befindet sich nun eine Installationsdatei (pvs--Linux.deb) in \textit{build/} die z.B. auf Debian-Derivaten mit \textbf{dpkg -i} installiert werden kann.\\ -Anmerkung: Falls Pakete für Rechner gebaut werden sollen, die vom Erstellungssystem her verschieden sind, muß der Schalter \texttt{-march=native} in der Datei \textit{CMakeLists.txt} angepasst werden! diff --git a/doc/LaTeX/devel/0200-gui-lib.tex b/doc/LaTeX/devel/0200-gui-lib.tex deleted file mode 100644 index 05730da..0000000 --- a/doc/LaTeX/devel/0200-gui-lib.tex +++ /dev/null @@ -1,31 +0,0 @@ -\chapter{Eingesetzte GUI-Bibliothek} -\index{QT} \index{GUI} -Die komplette Benutzerschnittstelle des Clients wurde mit Hilfe des von Nokia (früher Trolltech) entwickelten Frameworks Qt in der Version 4 implementiert. Der Grund hierfür sind folgende Vorteile: -\begin{itemize} - \item Qt wird bereits in einer Vielzahl von großen Projekten eingesetzt (KDE, Opera, Skype, Google Earth,...) und ist somit solide und erprobt. - \item Das komplette Framework besteht nicht nur aus einer GUI-Bibliothek sondern beinhaltet noch viele weitere nützliche Module, die bei der Entwicklung ebenfalls zum Einsatz kamen (QtNetwork, QtDBus, Internationalisierung). - \item Qt ist plattformunabhängig: Projekte können für Linux, OSX und Windows erstellt werden - \item Moderne Konzepte und Werkzeuge werden bereitgestellt. So wird das Signal-Slot-Konzept durchgängig eingehalten und mit dem GUI-Builder (\textbf{designer}) können einfach und professionell grafische Interfaces erstellt werden. - \item Duales Lizenzmodell: Qt gibt es sowohl unter einer proprietären Lizenz als auch unter der (L)GPL. -\end{itemize} -Leider unterstützte das bisher eingesetzte Build System (Autotools) Qt nicht vollständig. Dies liegt daran dass Qt zum Erzeugen von Makefiles ein eigenes Werkzeug mitbringt (QMake). Aus diesem Grund wurde eine Umstellung auf das neue CMake durchgeführt. Dies ist nicht nur flexibler als Autotools (plattformunabhängig) sondern auch einfacher in der Einrichtung und Wartung (und wird übrigens vom KDE-Projekt seit der Version 4 eingesetzt). Des Weiteren ist es mit CMake nicht nur möglich Qt-Anwendungen zu erstellen sondern auch die komplette Qt-Toolchain (\textbf{moc}, \textbf{uic}, \textbf{rcc}, \textbf{qdbuscpp2xml}, \textbf{qdbusxml2cpp}, \textbf{lupdate}, \mbox{\textbf{lrelease}},...) komfortabel zu nutzen. So kann z.B. die Interface Erstellung für D-Bus oder das Internationalisieren der Software automatisiert werden. - -\section{Internationalisierung} -\index{Internationalisierung} -Wie oben bereits erwähnt wurde zur Internationalisierung das von Qt4 bereitgestellte System benutzt und mit CMake automatisiert. Der interne Ablauf sieht folgendermaßen aus (\textit{CMakeLists.txt}): -\begin{enumerate} - \item Mit \texttt{SET} werden Variablen mit Quelldateien definiert, die die zu übersetzenden Zeichenketten beinhalten. Diese dienen gleichzeitig zum Kompilieren. - \item Danach werden ebenfalls mit \texttt{SET} Variablen definiert, die später die vom Benutzer zu übersetzenden .ts Dateien enthalten (z.B. \textit{i18n/pvsgui\_de\_DE.ts}). - \item \texttt{QT4\_CREATE\_TRANSLATION} erzeugt im Build-Verzeichnis binäre Internationalisierungs Dateien, die beim Kompilieren eingebunden werden müssen. -\end{enumerate} - -\textbf{Beispiel:} -\begin{verbatim} -SET( PVSGUI_SRCS src/pvsgui.cpp src/gui/clientConfigDialog.cpp ) -SET( PVSGUI_TSS i18n/pvsgui_de_DE.ts i18n/pvsgui_fr_FR.ts ) -QT4_CREATE_TRANSLATION( PVSGUI_QMS ${PVSGUI_SRCS} ${PVSGUI_TSS} ) -ADD_EXECUTABLE( pvsgui ${PVSGUI_SRCS} ${PVSGUI_QMS} ) -\end{verbatim} - -Jede so erzeugte .ts Datei kann nun mit dem Programm \textbf{linguist} von einem Übersetzer bearbeitet werden. Damit die Zeichenketten später während der Ausführung übersetzt werden, müssen diese allerdings mit der Funktion \texttt{QObject::tr()} im Quellcode erzeugt worden sein. - diff --git a/doc/LaTeX/devel/0300-pvs.tex b/doc/LaTeX/devel/0300-pvs.tex deleted file mode 100644 index 54fedd4..0000000 --- a/doc/LaTeX/devel/0300-pvs.tex +++ /dev/null @@ -1,505 +0,0 @@ -\chapter{Aufbau und Funktionsweise des PVS} -\index{Aufbau} \index{Funktionsweise} \index{Konzept} - -Der Pool Video Switch ist als verteilte Netzwerkapplikation angelegt, die sich aus einer speziellen Steuerkonsole und damit gesteuerten Clients zusammensetzt. Diese kommunizieren untereinander einerseits über ein spezielles Message-Protokoll, verwenden andererseits für bestimmte Aufgaben, wie die Übertragung von Bildinhalten oder Dateien weitere Protokolle wie VNC oder Multicast-IP. - -\section{Einzelne Komponenten} -\index{Komponenten} -Die Steuerkonsole wird durch das Programm pvsmgr, das Client-Backend durch pvs und das Client-Frontend durch pvsgui repräsentiert. - -\subsection{Zuordnung von Konsole und Clients} -\input{devel/0310-service-discovery} - -\section{Überblick über Aktivitäten auf Clients} - -\subsection{Projektion an Alle} -\index{Projektion} -Eine wichtige Eigenschaft des PVS ist die Verwaltung von Projektionen zwischen mehreren Clients. Eine Projektion ist hierbei das Anzeigen des Bildschirminhalts eines Clients - der sogenannten Source oder Quelle - auf einem oder mehreren anderen Clients - den Targets oder Zielen der Projektion. -Die für die Projektion benötigten Verbindungsdaten wie Passwort und IP werden von jedem Client bei der Anmeldung an der Steuerkonsole übermittelt und in einer Liste von PVSConnection Objekten in der Klasse \textit{PVSConnectionManager} gespeichert. Diese zentrale Verwaltung hat mehrere Vorteile: -\begin{itemize} - \item Die Quelle einer Projektion muss keine Aktion ausführen und kann passiv bleiben. - \item Redundanz der Daten wird verhindert, da diese auch in der Steuerkonsole zur Darstellung der Thumbnails benötigt werden. - \item Das Nachrichtenaufkommen wird reduziert, da lediglich eine Nachricht bei der Anmeldung an der Steuerkonsole übermittelt wird. -\end{itemize} - -Bei der Auswahl der Quelle und Ziele ist zu beachten, dass man für jede Projektion jeweils nur eine Quelle jedoch mehrere Ziele auswählen kann. -Quelle und Ziel müssen außerdem verschiedenen Kriterien genügen. -\begin{itemize} - \item Eine Quelle darf nicht gleichzeitig Ziel einer Projektion sein. - \item Ein Ziel einer Projektion darf nicht Ziel einer anderen Projektion sein. - \item Eine Quelle darf mehrfach als Quelle ausgewählt werden. -\end{itemize} -Diese Einschränkungen werden in der Steuerkonsole durchgesetzt, indem im Zielauswahldialog die Zielmenge eingeschränkt wird. -Siehe hierzu auch \ref{pvs-console-projection} Projektion. - -Der Projektionsvorgang an sich besteht aus mehreren Teilen. Wird eine Projektion angefordert, wird überprüft, ob auf der Quelle ein VNC Server gestartet ist. Falls nicht, wird versucht, einen VNC Server zu starten. Ist dies erfolgreich, so sendet die Steuerkonsole das entsprechende Tripel (IP, Passwort und Port der Quelle) an alle ausgewählten Ziele. Clients, welche eine Projektionsaufforderung erhalten, verbinden sich dann mit den Verbindungsdaten zum VNC Server der Quelle. Um die Einstellbarkeit der Qualität einer Projektion zu ermöglichen, kann die Steuerkonsole einen von drei Qualitätswerten an die Zielclients übermitteln. Siehe hierzu auch \ref{pvs-console-quality} Qualitätsoptionen. - - -\subsection{Projektion eines Clients auf dem Beamer} -\index{Beamer} - -Die Projektion eines Clients an den Beamer unterscheidet sich im Wesentlichen nicht von anderen Projektionen. Lediglich ist das Ziel der Projektion hierbei der Dozentenpc bzw. der PC, welcher an den Beamer angeschlossen ist. Eine spezielle Auszeichnung des Beamers erfolgt nicht. Die Anzahl der Ziele wird hierbei nicht beschränkt, da es wünschenswert sein kann, den auf dem Beamer dargestellten Bildschirminhalt auch gleichzeitig auf anderen Clients darzustellen. - -\subsection{Chat- und Informationskanal} -\index{Chat} - -Es gibt 2 Möglichkeiten um Kontakt mit den Clients aufzunehmen. Die erste ist über den Chat, wo Nachrichten sowohl über den offentlichen Kanal als -auch über einen privaten Kanäle verteilt werden können, und die zweite vom PVSManager aus über den Informationskanal. -Der Informationskanal ermöglich das Versenden von Nachrichten, die dringend zu lesen sind, an die Clients. -Im Gegenteil zum Chat erscheinen solche Nachrichten nicht im Chatfenster sondern in einem Pop-Up-Fenster und werden vom Bildschirm entfernt erst wenn man sie -als gelesen markiert durch das Drucken auf dem Knopf \textit{'OK'}. -\\ -\\ -\textbf{Behandlung der Nachrichten im Server} -\\ -\\ -Chat-Nachtichten werden von Server in der Klasse \texttt{PVSConnectionManager} mittels der Methode \texttt{onChat} behandelt. Dort wird aus der Nachrit den Empfänger -und den Absender ausglesen und die Nachricht an beide versendet. So gilt das Empfangen eine eigene Nachricht als Bestätigung, dass die Nachricht ordentlich vom Server -behandelt und versendet wurde. Das Gestalt von solchen Nachrichten sieht folgendermaßen aus - -\begin{center} - PVSMSG -\end{center} -\begin{center} -\begin{tabular}{|l | p{3cm} | p{3cm} | p{3cm}|} -\hline -Type & Ident & Msg & sndID\\ -\hline -\texttt{PVSMESSAGE} & \texttt{} & \texttt{<:} & \texttt{<}\\ -\end{tabular} -\end{center} - -Informationsnachrichten werden ausschließlich vom PVSManager versendet.Dies geschiet in der Klasse \texttt{ConnectionList} mittels der Methode \texttt{on\_Message}. - -\begin{center} - PVSMSG -\end{center} -\begin{center} -\begin{tabular}{|l | l | p{6cm} | p{6cm}} -\hline -Type & Ident & Msg\\ -\hline -\texttt{PVSMESSAGE} & \texttt{BROADCAST} & \texttt{} \\ -\end{tabular} -\end{center} - -Informationnachrichten können außerdem einen oder mehrere Clients sperren, wenn sie den Ident \texttt{LOCKSTATION} enthalten. Sobald ein Client die Nachricht empfängt, -wird diese auf dem Bilschirm angezeigt und 10 Sekunden später wird der Client gesperrt. - -Abgesehen von der Behandlung der Nachrichten muss sich der Server darum kümmern, dass jeder verbunde Client über alle nötige Informationionen verfügt damit er -Nachrichten mit andren Clients austauschen kann. Dies wird folgendermaßen erledigt: -\begin{itemize} - \item \textbf{Einfügen eines Clients:} um die Verwaltung von Clients kümmert sich die Klasse \texttt{PVSConnectionManager}, in der die Methode \texttt{onClientNew} für das Einfügen -von neuen Clients zuständigt ist. Sowald ein neuer Client in der Client-Liste des Servers eingefügt wird, wird an ihn die Liste aller im Server bereits angemeldete -Clients geschickt. Dazu dient die Methode \texttt{sendEventToClients}. - -Bis hier ist der neue Client noch unbekannt für den Rest der Nutzer. Der neuer Client wird erst bekannt gegeben sobald er vom Server einen Benutzername -zugewissen bekommen hat. Da es sein kann, dass den Name, mit dem der neue Client sich beim Server anmelden wollte, -bereits vergeben ist und muss unter Umständen verändert werden. Diese Zuweisung findet in der Methode \texttt{onLoginUsername} statt, -wo nicht nur alle andere Clients sondern auch der neue Client darüber informiert werden. Auch hier kümmert sich die Methoder \texttt{sendEventToClients} -ums Vesenden der entsprechenden Informationen. - - \item \textbf{Entfernen eines Clients:} das Entfernen von Clients wird von der Methode -\\ -\texttt{onClientRemove} erledigt, wo analog wie -Oben alle Clients darüber informiert werden. -\end{itemize} - -Für dei Übermittlung solche Informationen werden Nachrichten mit folgenden Gestal benutzt - -\begin{center} - PVSMSG -\end{center} -\begin{center} -\begin{tabular}{|l | l | p{6cm} |} -\hline -Type & Ident & Msg\\ -\hline -\texttt{PVSMESSAGE} & \texttt{} & \texttt{:} \\ -\end{tabular} -\end{center} - -Es gibt drei unterschiedliche Befehle, die welche Änderung in der localen Client-Liste der Clients vorgenommen werden soll angeben. -\begin{enumerate} - \item \texttt{clientToAdd} -\item \texttt{clientToRemove} -\item \texttt{assignedName} -\end{enumerate} - -Wie es bei Servern gewöhnt ist, werden alle relevante Ereignisse in Log-Dateien protokolliert. Ereignisse werden im Chat-Log mit folgendem -Befehl eingetragen - -\begin{center} -\texttt{ConsoleLog writeChat()} -\end{center} - -\textbf{Chat-Interface der Steuerkonsole} -\\ -\\ -So wie alle Clients ist der PVSManager auch ein Teilnehmer im Chat. Der PVSManager steht wie alle andere Teilnehmer auch in der Nutzer-Liste -jedes Chat-Fenster und kann ebenfalls über private Nachrichten direkt angesprochen werden. Die Arbeitsweise dieser Chat-Interface ist sehr simple. -Da sie sich im Server befindet, müssen einfach alle Ereignise (Nachrichten senden ist die einzige Ausnahme) von der Klasse \texttt{PVSConnectionManager} -an die Klasse \texttt{MainWindow} weitergegeben werden. Dies kümmert sich darum, alle Informationen zu verarbeiten und diesein der Chat-Fenster der -Steuerkonsole anzuzeigen. - -Folgende Methoden der Klasse \texttt{MainWindow} ermöglichen das Anzeigen einer empfangenen Nachricht im Chat-Fenster der Steuerkonsole und Änderungen (Clients einfügen -und entfernen) in der sowohl im Chat-Fenster als auch in der Steuerkonsole angezeigten Client-Liste. -\\ -\\ -\texttt{receiveChatMsg(, , )} -\\ -\texttt{removeConnection(*pvsClient)} -\\ -\texttt{addConnection(*pvsClient)} -\\ -\\ -Alle diese Methoden werden im Gegensatz von der Methode \texttt{sendChatMsg(PVSMsg myMsg)} von der Klasse \texttt{PVSConnectionManager} aus ausgeführt. Da alle durchs -Netz empfangene Nachrichten müssen an die GUI-Weitergegeben werden. Beim Versenden von Nachrichten funktioniert es genau umgekehrt. Die Nachricht wird -vom Nutzer in der GUI eingegeben und muss an die Klasse \texttt{PVSConnectionManager} weitergeleitet werden, damit diese ins Netz gesendet wird. Darum kümmert -sich die Methode in der Klasse \texttt{MainWindow}. -\\ -\\ -\texttt{MainWindow::sendChatMsg(PVSMsg myMsg)} -\\ -\\ -\textbf{Chat-Clients} -\\ -\\ -So weit haben wir die Funtionsweisen des Servers im Bezug auf dem Chat kennengelernt. -Nun wird erläutert wie die einzelnen Clients die Nachrichten bearbeiten. -\\ -\\ -Auf der Client-Seite in der Klasse \texttt{PVSConnectionServer} werden alle Nachrichten des PVS-Protokolls empfangen und gefiltert (Siehe Methode \texttt{handleClientMsg}). -Nachrichten mit dem Ident \texttt{PVSMESSAGE} werden durch den Dispatcher direkt an die Klasse \texttt{PVSChatClient} weitergeleitet, wo die Methode \texttt{receive} feststellen wird, -ob es sich dabei um eine Gespräch-Nachricht oder eine Befehl-Nachricht handelt. Um es feststellen zu können, wird aus der empfangenen Nachricht ein PVSChatMsg-Objekt -erzeugt (siehe Konstruktor) und mittels der Methode \texttt{isCommand} erfährt man ob es sich um einen Befehl handelt oder nicht. -Falls ja leitet der Dispatche die Nachricht an die Stelle \texttt{PVS::UpdateChatClients} sonst an die Stelle \texttt{PVS::chat\_receive}, wo die Änderungen in der Client-Liste -vorgenommen werden oder die Gespräch-Nachricht der GUI abgegeben wird. - -\subsection{Multicast-Dateiversand} -\index{Dateiversand}\index{Multicast} - -Der Multicast-Dateiversand geschieht über die Bibliothek \texttt{OpenPGM}\index{OpenPGM} -(\url{http://code.google.com/p/openpgm/}), die das ,,\textit{Pragmatic General Multicast}''-Protokoll\index{Pragmatic General Multicast} -(PGM)\index{PGM} implementiert. -Darin enthalten ist eine Implementierung der \textit{PGMCC}-Methode zur -Regulierung der Sendebandbreite. -Vorteil der Verwendung einer externen Bibliothek ist, -dass die ,,schwierigen'' Probleme bei der Implementierung einer verlässlichen Datenstrom-orientierten -Multicast-Übertragung bereits von Netzwerkexperten gelöst wurden. - -Die Bibliothek ist in das PVS-System über die interne Bibliothek \texttt{libpvsmcast}\index{libpvsmcast} -eingebunden (der Quellcode findet sich im Verzeichnis \texttt{src/net/mcast}). -Diese stellt mit der Klasse \texttt{McastPGMSocket}\index{Klasse!\texttt{McastPGMSocket}} einen -objektorientierten, ereignisgetriebenen Wrapper zu OpenPGM bereit. -Die Konfigurationsdaten, die zur Einrichtung einer PGM-Verbindung notwendig sind, -sind in der Klasse \texttt{McastConfiguration}\index{Klasse!\texttt{McastConfiguration}} verpackt. - -Auf der nächsten Ebene wird der Versand einer Datei von den Klassen \texttt{McastSender}\index{Klasse!\texttt{McastSender}} -und \texttt{McastReceiver}\index{Klasse!\texttt{McastReceiver}} übernommen. -Diese brechen den Bytestrom der Datei in Pakete auf und formatieren diese wie in Tabelle \ref{tab:mcastpacket} -gezeigt. -\begin{table} -\begin{center} -\begin{tabular}{|l|l|l|} -\hline -\textbf{Format} & \textbf{Feld} & \textbf{Erläuterung} \\ -\hline -\texttt{quint64} & \texttt{magic\_number} & = 0x0x6d60ad83825fb7f9 \\ -\hline -\texttt{quint64} & \texttt{offset} & Position des Datenpaketes in der Datei \\ -\hline -\texttt{QByteArray} & \texttt{data} & Daten \\ -\hline -\texttt{quint64} & \texttt{checksum} & CRC16-CCITT der vorhergehenden Felder \\ -\hline -\end{tabular} -\caption{Paketformat für Multicast-Dateiversand}\label{tab:mcastpacket}\index{Multicast!Paketformat} -\end{center} -\end{table} -Das Paketformat ist mit Hilfe der Qt-eigenen Klasse \texttt{QDataStream} implementiert. -Numerische Felder werden in Netzwerk-Bytereihenfolge übertragen. -Das Ende einer Übertragung wird markiert durch ein Paket, in dessen \texttt{offset} -alle bits gesetzt sind und dessen \texttt{data} die MD5-Prüfsumme der übertragenen Datei -enthält. - -Zur Integration dieser -- prinzipiell von PVS unabhängigen -- Funktionalität -dienen die Klassen \texttt{PVSIncomingMulticastTransfer}\index{Klasse!\texttt{PVSIncomingMulticastTransfer}} -und \texttt{PVSOutgoingMulticastTransfer}\index{Klasse!{PVSOutgoingMulticastTransfer}}. -Diese sorgen hauptsächlich für die Konfiguration der Multicast-Funktionalität mit Hilfe der -PVS-Konfiguration und das Generieren der richtigen Signale einerseits in Bezug auf die Benutzerschnittstelle, -sowie andererseits in Bezug zur Netzwerkkomponente des PVS-Systems. - -Ein Client, der eine Datei per Multicast zu versenden wünscht, wählt zufällig einen Port und -kündigt diesen mit der Nachricht MCASTFTANNOUNCE an. -Falls innerhalb einer festgesetzten Zeit (30 Sekunden) keine MCASTFTRETRY-Nachricht eintrifft, -beginnt die Übertragung. -Die Nachricht MCASTFTCONFIG dient zum Setzen netzwerkweiter Parameter von der Steuerkonsole aus. - -\section{Fernsteuerung} - -Die Fernsteuerung eines Clients erfolgt durch den clientseitigen Empfang von \texttt{PVSCOMMAND}-Nachrichten -mit dem Ident \texttt{INPUTEVENT}. -Dieser ist die Base64-kodierte Binärdarstellung eines Eingabeereignisses angehängt, das -clientseitig nachvollzogen werden soll. -\begin{table} - \begin{tabular}{|l|l|p{4cm}|p{4cm}|} - \hline - \textbf{\texttt{type}} & \textbf{\texttt{code}} & \textbf{\texttt{value}} & \textbf{Beschreibung} \\ - \hline - \multirow{2}{*}{\texttt{ET\_KEY}} & - \texttt{EC\_PRESS} & - \multirow{2}{4cm}{Auslösende Taste und gehaltene Modifikatortasten} & - Taste gedrückt \\ - \cline{2-2}\cline{4-4} - & - \texttt{EC\_RELEASE} & - & - Taste losgelassen\newline \\ - \hline - \multirow{2}{*}{\texttt{ET\_BUTTON}} & - \texttt{EC\_PRESS} & - \multirow{2}{4cm}{Auslösende und - gedrückte Maustasten} & - Maustaste gedrückt \\ - \cline{2-2}\cline{4-4} - & - \texttt{EC\_RELEASE} & - & - Maustaste losgelassen \\ - \hline - \texttt{ET\_POINTER} & - --- & - Absolute Koordinaten & - Mauszeiger bewegt \\ - \hline - \multirow{4}{*}{\texttt{ET\_SPECIAL}} & - \texttt{EC\_REBOOT} & - --- & - Systemneustart \\ - \cline{2-4} - & - \texttt{EC\_KILL\_X} & - --- & - X-Server töten \\ - \cline{2-4} - & - \texttt{EC\_SYSRQ} & - Kommando & - Magic-SysRq-Taste \\ - \cline{2-4} - & - \texttt{EC\_SAY\_HELLO} & - --- & - Harmloses Kommando für Funktionstest \\ - \hline - \end{tabular} - \caption{Mögliche Eingabeereignisse\label{tab:input-events}\index{Eingabeereignis!\texttt{InputEvent}}} -\end{table} -Tabelle \ref{tab:input-events} zeigt die möglichen Eingabeereignisse. -Eingabeereignisse werden durch die PVS Input Library (libpvsinput) behandelt, -deren Funktion an dieser Stelle dargestellt werden soll. - -\subsection{Behandlung eines Eingabeereignisses} -\index{Eingabeereignis!Behandlung} - -Ein Eingabeereignis durchläuft die folgenden Stationen: -\begin{enumerate} - \item Die Steuerkonsole generiert ein Eingabeereignis und übergibt dieses an die Netzwerktransportschicht. - \item Der PVS-Client empfängt das Eingabeereignis und übergibt die Behandlung einer Instanz der - Klasse \texttt{InputEventHandlerChain}\index{Klasse!\texttt{InputEventHandlerChain}}. - \item Die Klasse \texttt{InputEventHandlerChain} arbeitet eine Liste von Instanzen der Klasse - \texttt{InputEventHandler}\index{Klasse!\texttt{InputEventHandler}} der Reihe nach ab, um zu sehen, ob eine dieser Instanzen - das Ereignis bearbeiten kann. - \item Falls die betrachtete Instanz das Ereignis bearbeiten kann, wird geprüft, ob der dafür - nötige Sicherheitskontext vorhanden ist. - \item Falls dies ebenfalls der Fall ist, wird die entsprechende Aktion in einer implementierung - der abstrakten Methode \texttt{InputEventHandler::handle} ausgeführt und die weitere Bearbeitung - beendet. - \item Falls keiner der vorherigen Handler das Ereignis behandelt hat, wird es durch - die Klasse \texttt{PrivilegedHandlerForwarder}\index{Klasse!\texttt{PrivilegedHandlerForwarder}} an den zusätzlichen Daemon \texttt{pvsprivinputd} - weitergegeben. - \item Der \texttt{pvsprivinputd}\index{pvsprivinputd} besitzt ebenfalls eine \texttt{InputEventHandlerChain}, die - nach dem gleichen Muster bearbeitet wird. - Falls hierbei kein passender Handler gefunden wird, wird das Ereignis in eine Logdatei geschrieben - und die Bearbeitung aufgegeben. -\end{enumerate} -Ereignishandler sind implementiert für Maus- und Tastatureingaben unter Linux/X11 (mit Hilfe der XTest-Erweiterung), -sowie zur Simulation von Strg+Alt+Entf, Strg+Alt+Rück und Magic SysRq. - -\subsection{Erweiterungen} - -Weitere Eingabehandler lassen sich der libpvsinput hinzufügen. -Dazu muss eine Klasse bereitgestellt werden, die von der Template-Klasse -\texttt{InputEventHandler} erbt. -Diese akzeptiert eine variable Anzahl\footnote{% - Bis zu 16, diese Zahl lässt sich jedoch durch Neugenerierung - der Datei \texttt{src/input/detail/ typelist\_autogen.h} erhöhen. - Ein entsprechendes Programm ist im Quellcode zu finden.} -von Templateparametern, die verschiedene Aspekte der Eingabeereignisbehandlung konfigurieren. - -Durch die Angabe eines Templateparameters \texttt{input\_policy::Match<\textit{typ}, \textit{code}, \textit{wert}>}\index{Klasse!\texttt{input\_policy::Match}}, -wobei \textit{code} und \textit{wert} weggelassen werden können, wird spezifiziert, -dass der betreffende Handler nur für Eingabeereignisse mit den entsprechenden Feldwerten aufgerufen wird. -Wird kein solcher Parameter angegeben, wird der betreffende Handler niemals aufgerufen. -Mehrere \texttt{Match}-Parameter werden mittels logischem ODER verknüpft. - -Ein Templateparameter der Form \texttt{input\_policy::Require<\textit{Merkmal\dots}>}\index{Klasse!\texttt{input\_policy::Require}} -gibt an, dass dieser Handler nur auf einem System lauffähig ist, das die entsprechenden \textit{Merkmale} -aufweist. -Eine Liste von Systemmerkmalen wird in der Datei \texttt{src/input/detail/systemTraits.h} -zentral verwaltet. -Hier lassen sich neue Merkmale mit Hilfe des Makros \texttt{DEFINE\_SYSTEM\_TRAIT} definieren -und mit Hilfe des Präprozessors zwischen den Zeilen \texttt{BEGIN\_SYSTEM\_TRAITS} und -\texttt{END\_SYSTEM\_TRAITS} einfügen. -Diese Vorgehensweise beschränkt die Nutzung des Präprozessors auf eine Datei. -Wird kein \texttt{Require}-Parameter angegeben, so wird der entsprechende Handler als -immer lauffähig eingestuft. -Mehrere \texttt{Require}-Parameter werden mittels logischem ODER verknüpft. - -Weiterhin kann ein Templateparameter der Form \texttt{input\_policy::Security<\textit{Richtlinie}>}\index{Klasse!\texttt{input\_policy::Security}} -angegeben werden. Hierbei stehen für \textit{Richtlinie} die Klassen \texttt{input\_policy::AllowLocal\-OrPrivileged} -oder \texttt{input\_policy::AllowEverybody} zur Verfügung. -Hierdurch wird bestimmt, welche Sicherheitsanforderungen zur Ausführung des Handlers erfüllt sein -müssen. -Die Richtlinie \texttt{input\_policy::AllowLocalOrPrivileged} bestimmt, dass nur Benutzer, -deren Sitzung lokal ist, oder solche, die nach der Konfiguration des pvsprivinputd als privilegiert -gelten, die entsprechende Aktion aufrufen dürfen (hierbei geht es um den Benutzer, der den PVS-Client -ausführt, und nicht den Benutzer, der die Steuerkonsole bedient). -Die Richtlinie \texttt{input\_policy::AllowEverybody} erlaubt die Ausführung der Aktion ohne -besonderen Sicherheitskontext. -Neue Sicherheitsrichtlinien der Form \texttt{input\_policy::Security<\textit{T}>} lassen sich -nutzen, indem eine Klasse \textit{T} eingeführt wird, die eine Methode\\ -\makebox[1cm]{}\texttt{static bool allow(InputEventContext const*)}\\ -besitzt, an die die Entscheidung, ob eine Aktion zuzulassen ist, delegiert wird. - -Der zu implementierende Eingabehandler braucht weiterhin eine Implementierung der abstrakten -Methode\\ -\makebox[1cm]{}\texttt{virtual void handle(InputEvent const\&, InputEventContext const*)},\\ -in der die entsprechende Aktion ausgeführt wird. - -Die Aufnahme des neuen Handlers in die Liste der abzuarbeitenden Handle erfolgt, -je nachdem ob erweiterte Berechtigungen zur Bearbeitung notwendig sind, -in einer der Dateien \texttt{privilegedHandlerChain.cpp} oder \texttt{unprivilegedHandler\-Chain.cpp} -in \texttt{src/input}, wo dem Kettenaufruf eine Zeile der Form\\ -\makebox[1cm]{}\texttt{.add<\textit{Handler}>()}\\ -hinzugefügt wird. -Die Verwendung des Präprozessors zum Ausschluss von Handlern, die auf dem -Zielsystem nicht lauffähig sind, ist an dieser Stelle nicht notwendig und wird durch die -\texttt{Require}-Richtlinie umgesetzt. -Notwendig ist lediglich, die Übersetzung des Handlers auf inkompatiblen Systemen zu verhindern. -Dies kann mit Hilfe des Build-Systems oder durch die Klammerung der gesamten Übersetzungseinheit -in Präprozessorbedingungen geschehen. - -Eine API-Referenz zur libpvsinput (Stand: 4.~November~2010) findet sich im Projektwiki -unter \url{http://lab.openslx.org/projects/pvs/wiki/RemoteKeyMouse}. - -\section{Prozesse fernsteuern} -\index{Prozesse fernsteuern} - -\subsection{Prozesse starten} -\index{Prozesse!starten} \index{starten} -Das ferngesteuerte Starten von Prozessen funktioniert durch den einfachen Versand eines PVSCOMMAND mit dem dem Ident STARTPROCESS an den Client, der Inhalt des PVSCOMMAND ist in diesem Fall ein durch den Dozenten angegebener Prozess. Der Client versucht diesen Prozess lokal zu starten.\\ -Sollte hierbei ein Fehler auftreten schickt der Client dem Manager ein PVSCOMMAND mit Ident PROCESSES, der Inhalt besteht dann aus der Nachricht START ERROR und einer Zahl, die die Art des Fehlers angibt.\\ -Die Fehlermeldung wird zusammen mit der Information über die Art des Fehlers (Fehlender Prozess/nicht genug Rechte, Crash, Timeout, Read Error, Write Error, Unbekannter Fehler) im Log angezeigt.\\ -Es ist möglich, dass der Dozent sich eine Liste von Prozessen, die er nutzen möchte erstellt und im PVSManager abspeichert, dies geht über den Prozesse starten-Dialog, er zeigt eine Liste an, die die beliebig erweiterbar ist. Einmal getätigte Änderungen werden in der Datei \textit{pvsmgr.conf} abgespeichert. Die Konfigurationsdatei ist nach folgendem Beispiel aufgebaut: -\begin{verbatim} -[RemoteProcessesList] -size=2 -1\command=oowriter -1\description=OpenOffice Writer -2\command=oocalc -2\description=OpenOffice Calc -\end{verbatim} -Hier ist zu beachten, dass size mit 1 beginnt.\\ - -\subsection{Prozesse beenden} -\index{Prozesse!beenden} \index{beenden} -Das ferngesteuerte Beenden von Prozessen funktioniert analog zum Starten durch den Versand eines PVSCOMMAND mit dem dem Ident KILLPROCESS an den Client, hier gibt der Inhalt die lokale PID, des zu beendenden Prozesses an.\\ -Auch hier schickt der Client dem Manager bei einem Fehler ein PVSCOMMAND mit Ident PROCESSES, der Inhalt besteht dann aus der Nachricht STOP ERROR und einer Zahl, die die Art des Fehlers angibt.\\ -Auch hier wird die Fehlermeldung zusammen mit der Information über die Art des Fehlers (Fehlender Prozess/nicht genug Rechte, Crash, Timeout, Read Error, Write Error, Unbekannter Fehler) im Log angezeigt. - -\subsection{Prozesseliste anzeigen} -\index{Prozesse!anzeigen} \index{anzeigen} -Hier sendet der Manager dem Client ein PVSCOMMAND mit Ident SHOWPROCESSES, der Inhalt der Nachricht gibt Prozesse an die herausgefiltert werden sollen. Das PVSCOMMAND mit Ident SHOW und Inhalt clear lässt den Client seine Prozessliste leeren.\\ -Anschließend wird der Inhalt von \textit{/proc/} auf dem Client ausgelesen, ist kein Inhalt vorhanden wird ein PVSCOMMAND mit Ident PROCESSES und Nachricht SHOW ERROR gesendet. Sonst werden sämtliche Ordner in \textit{/proc/} die nur aus Zahlen bestehen durchlaufen. Es wird die Datei \textit{status} ausgelesen um den Namen des Prozesses und die UID des Besitzers zu erhalten. Ist die UID nicht identisch mit der UID des Client wird dieser Prozess verworfen, somit ist sichergestellt, dass nur Prozesse angezeigt werden, bei denen auch tatsächlich die Berechtigung vorhanden ist sie zu beenden. Ist dies der Fall wird außerdem noch ein Teil der Datei \textit{cmdline} ausgelesen. Der Client sendet daraufhin ein PVSCOMMAND mit Ident SHOW und Inhalt PID<\#>Name<\#>cmdline und füllt somit seinen Prozessvektor auf. Ist \textit{/proc} komplett abgearbeitet wird ein PVSCOMMAND mit Ident SHOW und Inhalt finished abgesendet, dies löst ein erneuetes lesen der Prozessliste Managerseitig aus:\\ -Hier wird zu beginn die Prozessliste des Client gelöscht und der Prozessvektor des Clients gelesen. Für jeden Eintrag der Art PID<\#>Name<\#>cmdline wird eine neue Zeile in der Prozessliste geschrieben und PID, Name und cmdline in die jeweiligen Zellen geschrieben.\\ -Prozesse die aus der Liste herausgefiltert werden werden auch in der Datei \textit{pvsmgr.conf} abgespeichert. Eine mögliche Konfigurationsdatei sieht etwa so aus: -\begin{verbatim} -[RemoteProcessesList] -filter=pvs pvsgui pvsmgr -\end{verbatim} - -\section{Netzwerkkommunikation} -\index{Netzwerkkommunikation} - -\subsection{PVS-Protokoll} -\index{Protokoll!PVS} \index{Protokoll} -Im Zuge der Entwicklung des PVS wurde ein sehr einfaches Messagingprotokoll entwickelt. -Die Nachrichten bzw. Messages bestehen dabei aus Header, Nachrichtentyp, Ident und dem eigentlichen Nachrichtentext. Die einzelnen Nachrichtenteile, welche bis auf den Header selbst definiert werden können, werden verknüpft und versendet. Es sind schon Nachrichtentypen vordefiniert, welche sich nur durch unterschiedliche Dispatcher unterscheiden. -Bereits vorhandene Typen sind COMMAND, LOGIN, MESSAGE und UNKNOWN. Die Dispatcher (\_commandDispatcher, \_loginDispatcher und \_chatDispatcher) befinden sich im Client in der Klasse \texttt{ServerConnection}, in der Steuerkonsole in der Klasse \texttt{ClientConnection} bzw. \texttt{ListenServer}. Ein Ident wie z.B. Username, Befehl oder Beschreibung des Nachrichteninhalts dient zur Unterscheidung verschiedener Nachrichten mit demselben Nachrichtentyp, wobei die Nachricht dann den dem Ident entsprechenden Nachrichtentext enthält. -Um eine Funktion zur Behandlung einer bestimmten Nachricht zu definieren, wird diese Funktion als Handler mit dem entsprechenden Dispatcher verknüpft. Im PVS-Client beispielsweise befindet sich der Dispatcher für Nachrichten vom Typ Command in der Klasse \texttt{pvsServerConnection}, daher wird in der Klasse \texttt{pvs} die Funktion \texttt{void PVS::onCommand(PVSMsg cmdMessage)} wie folgt als Handler registriert: -\texttt{\_pvsServerConnection->addCommandHandler("*", this, \&PVS::onCommand)}. Erhält nun der Client eine Nachricht vom Typ COMMAND, so wird die Funktion onCommand mit dem entsprechenden Nachrichtenobjekt aufgerufen. Auf die eigentliche Nachricht kann dann über die Methoden \texttt{getIdent()} und \texttt{getMessage()} des Objektes zugegriffen werden. - -\subsection{PVS-Messages} -\index{Message!PVS} \index{Message} -In Tabelle \ref{tab:messagelist} sind die Messages, die zwischen den einzelnen PVS Komponenenten ausgetauscht werden, aufgelistet. -Der Nachrichtentyp gibt dabei an, welcher Dispatcher die Nachricht behandelt. -Der Ident einer Nachricht wird zur Verarbeitung einer empfangenen Nachricht in der aufzurufenden Funktion benötigt (Unterscheidung von anderen Nachrichten gleichen Typs). - -\begin{table} -\begin{center} -\begin{tabular}{l | l | p{2cm} | p{4cm}} -\label{pvs-msg-liste} -Nachrichtentyp & Nachrichten Ident & Inhalt & Beschreibung \\ -\hline -PVSCOMMAND & PROJECT & hostname port password quality & Hostname, Port, Passwort und Qualität des VNC Servers zu dem verbunden werden soll (durch Space getrennt) \\ -PVSCOMMAND & UNPROJECT & & \\ -PVSCOMMAND & LOCKSTATION & & \\ -PVSCOMMAND & LOCKSTATION & Message & Client mit Nachricht sperren \\ -PVSCOMMAND & UNLOCKSTATION & & \\ -PVSCOMMAND & STARTPROCESS & process & gibt Prozessnamen an der auf Client gestartet werden soll\\ -PVSCOMMAND & KILLPROCESS & PID & gibt ProzessID an von Prozess der auf Client beendet werden soll\\ -PVSCOMMAND & SHOWPROCESSES & filter & weist den Client an seine Prozesse auszulesen und den Prozessvektor zu füllen, filter ist eine Nachricht der Art 'Prozess1 Prozess2 Prozess3', wobei die Prozesse Prozess1, Prozess2 und Prozess3 aus der Liste der laufenden Prozesse ausgeblendet werden\\ -PVSLOGIN & USERNAME & username & Client Benutzername \\ -PVSLOGIN & PASSWORD & password & Serverpasswort \\ -PVSLOGIN & ID & id & \\ -PVSLOGIN & FAILED & "`Wrong Password"' & Wird bei falschem Passwort gesendet \\ -PVSCOMMAND & PORT & port & \\ -PVSCOMMAND & PASSWORD & password & VNC Passwort\\ -PVSCOMMAND & RWPASSWORD & rwpassword & Passwort für den Zugriff auf die Tastatur und Maus \\ -PVSCOMMAND & VNC & YES & Erlaube Zugriff \\ -PVSCOMMAND & VNC & NO & Verbiete Zugriff \\ -PVSCOMMAND & PING & & \\ -PVSCOMMAND & VNCREQUEST & & \\ -PVSCOMMAND & VNCSRVRESULT & result code & Der Rückgabewert des pvs-vncsrv Skripts \\ -\end{tabular} -\end{center} -\caption{Liste der PVS Messages} -\label{tab:messagelist} -\end{table} - -\begin{table} -\begin{center} -\begin{tabular}{l | l | p{2cm} | p{4cm}} -\label{pvs-msg-liste} -Nachrichtentyp & Nachrichten Ident & Inhalt & Beschreibung \\ -\hline -PVSCOMMAND & MCASTFTANNOUNCE & sender transferID basename size port & Ankündigung eines Multicast-Transfer \\ -PVSCOMMAND & MCASTFTRETRY & sender transferID & Rückmeldung: Konfiguration des Multicast-Empfängers fehlgeschlagen, bitte auf anderem Port noch einmal versuchen \\ -PVSCOMMAND & MCASTFTCONFIG & blob & Multicast-Konfiguration aus dem angehängten Binärblob neu laden \\ -PVSCOMMAND & INPUTEVENT & Base64-kodierte InputEvent-Struktur & Fernsteuerung \\ -PVSCOMMAND & PROCESSES & START ERROR errorlevel & errorlevel gibt an, welcher Fehler beim Starten eines Prozesses aufgetreten ist \\ -PVSCOMMAND & PROCESSES & STOP ERROR errorlevel & errorlevel gibt an, welcher Fehler beim Beenden eines Prozesses aufgetreten ist \\ -PVSCOMMAND & PROCESSES & SHOW ERROR & gibt an, dass beim Anzeigen der Prozessliste ein Fehler aufgetreten ist \\ -PVSCOMMAND & PROCESSES & SHOW clear & weist Client an den Prozessvektor zu leeren \\ -PVSCOMMAND & PROCESSES & SHOW finished & weist Manager an, Prozessliste neu zu füllen \\ -PVSMESSAGE & BROADCAST & MESSAGE &\\ -PVSMESSAGE & clientToAdd & & Client hinzufügen (Chat)\\ -PVSMESSAGE & clientToRemove & & Client entfernen (Chat)\\ -PVSMESSAGE & assignedName & & Festgelegter Name (Chat)\\ -\end{tabular} -\end{center} -\caption{Liste der PVS Messages (Fortsetzung} -\label{tab:messagelist} -\end{table} diff --git a/doc/LaTeX/devel/0310-service-discovery.tex b/doc/LaTeX/devel/0310-service-discovery.tex deleted file mode 100644 index 307234f..0000000 --- a/doc/LaTeX/devel/0310-service-discovery.tex +++ /dev/null @@ -1,84 +0,0 @@ -Die Zuordnung von Clients zur Konsole erfolgt halb automatisch über ein -Service-Discovery-Modul. Jede Konsole sendet im Intervall von 7 Sekunden -einen Broadcast ins lokale Subnetz, um ihre Verfügbarkeit bekannt zu geben. -Die Clients können dadurch eine Liste von verfügbaren Servern anzeigen, -aus der der Benutzer nur noch den gewünschten auswählen muss. -Das Intervall sowie die verwendeten UDP-Ports für das Service-Discovery -können vor dem Kompilieren in der \textit{setup.h} festgelegt werden -\begin{verbatim} -#define SB_INTERVAL 7 // Broadcast interval in seconds -#define SD_PORT_CONSOLE 3491 // Not really used, Qt just wants a bind -#define SD_PORT_CLIENT 3492 // This is where we expect announcements -\end{verbatim} -Die zuständigen Klassen sind \textit{PVSServiceBroadcast} (Serverseitig) und -\textit{PVSServiceDiscovery} (Clientseitig).\\ -Auf Seite des Clients erfolgt außerdem eine Kommunikation mit der GUI -über DBus, um verfügbare Sitzungen anzeigen zu lassen, und damit -die GUI den Daemon veranlassen kann, zu einer bestimmten Sitzung -zu verbinden. -Die Methode \textit{connectToSession} in \textit{PVSServiceDiscovery} -ist dafür zuständig, zu einem gegebenem Sitzungsnamen die nötigen -Daten zu ermitteln und eine Verbindung zu initialisieren. - -\subsubsection{Absicherung und Verifikation der Identität} - -Um das Fälschen bzw. Manipulieren von diesen Broadcasts zu verhindern, -sodass es nicht möglich ist, Man-in-the-Middle Angriffe oder ähnliches -durchzuführen, soll gewährleistet werden, dass eine angezeigte Sitzung -auch die ist, für die man sie hält. - -Dafür wird auf das SSL-Protokoll zurückgegriffen. Zum einen bietet SSL -Verschlüsselung für Verbindungen an, und das Qt-Framework hat hierfür -auch schon einige Klassen parat. Zum anderen ist mit SSL durch seine -Zertifikate auch Identitätsverifikation möglich. Dazu kann das Zertifikat -des Servers anhand des Fingerprints auf Echtheit überprüft werden. -Beim Start der Konsole wird also, falls noch nicht vorhanden, ein neues -Serverzertifikat inklusive Schlüsselpaar erstellt, mit welchem Verbindungen -mit Clients fortan verschlüsselt werden. Außerdem wird der Fingerprint des -Zertifikats in den Service-Broadcasts übertragen, sodass die Clients -bereits vor der Verbindung den zu erwartenden Fingerprint kennen. -Somit kann beim Aufbau der Verbindung zur Konsole der Fingerprint -verglichen und eine eventuelle Manipulation erkannt werden. - -Für die Eindeutigkeit ist nur noch eine feste Zuordnung von Sitzungsnamen, -welcher dem Benutzer angezeigt wird, zum Fingerprint der zugehörigen -Konsole notwendig. Dies wird mit Hilfe eines einfachen Algorithmus erreicht, -der aus dem Fingerprint einen lesbaren String erzeugt. Wichtig ist, dass -Konsole und Client hier denselben Algorithmus verwenden, damit der -Dozent an der Konsole den Studenten den korrekten Sitzungsnamen mitteilen -kann. Wird der Algorithmus auf Seite der Konsole verändert, müssen auch -alle Clients aktualisiert werden. Er befindet sich in der \textit{serviceDiscoveryUtil.h} -und heißt \textit{sha1ToReadable}. - -Empfängt der Client einen Broadcast über einen neuen Server, baut dieser -zunächst zur Überprüfung eine Verbindung zu diesem Server auf und sofort wieder -ab, um den Fingerprint überprüfen zu können. Nur wenn dieser mit dem -angekündigten Fingerprint aus dem Broadcast übereinstimmt, wird die Sitzung -dem Benutzer zur Auswahl angezeigt. - -Die Überprüfung geschieht nicht sofort beim Empfang eines Service-Announcements -sondern verzögert in einem Timer, und dabei auch jeweils nur ein Server -in jedem Timer-Aufruf. Dies soll Missbrauch durch gefälschte Broadcastpakete -verhindern oder zumindest stark verlangsamen. Entsprechende Mechanismen gegen -Missbrauch finden sich in \textit{PVSServiceDiscovery::handleDiscovery} sowie -\textit{PVSServiceDiscovery::timerEvent}. - -\subsubsection{Generierung von Sitzungsnamen} - -Hier ist prinzipiell viel Spielraum für Kreativität vorhanden, beachtet werden -sollte lediglich, dass die Zahl der möglichen Namen, die durch den Algorithmus -erzeugt werden können, hoch genug ist, um nicht in kurzer Zeit durch einen -Brute-Force-Angriff einen Fingerprint mit dem selben Sitzungsnamen erzeugen zu -können. Außerdem sollte die Verteilung der zufälligen Namen über den Raum der -möglichen Namen etwa gleichmäßig sein. - -Der momentan verwendete Algorithmus generiert fünfsilbige Wörter, wobei jede -Silbe aus einem Konsonanten und einem Vokal besteht. Die Konsonanten werden -aus einer Liste von 13 Stück ausgewählt, wobei identisch oder zu ähnlich klingende -Konsonanten herausgefiltert wurden, um bei der mündlichen Übertragung keine -Ambiguitäten zu erzeugen. mit einer Wahrscheinlichkeit von 25\% wird einer Silbe -ein \textbf{n} angehängt. Damit sind $130^5 = 37.129.300.000$ (37 Mrd.) -unterschiedliche Sitzungsnamen möglich, was zwar deutlich weniger sind, als bei -einem 160Bit langen SHA1-Hash, allerdings ist dies bezogen auf das Einsatzgebiet -mehr als ausreichend. Alternativ bleibt natürlich nach wie vor das verwenden -alternativer Algorithmen die einen größeren Raum an möglichen Namen haben. \ No newline at end of file diff --git a/doc/LaTeX/devel/0400-pvs-console.tex b/doc/LaTeX/devel/0400-pvs-console.tex deleted file mode 100644 index 78574b2..0000000 --- a/doc/LaTeX/devel/0400-pvs-console.tex +++ /dev/null @@ -1,176 +0,0 @@ -\chapter{PVS-Steuerkonsole} - -Die Steuerkonsole ist das Hauptquartier des \textbf{Pool Video Switch}. Sie wird auf der Dozentmaschine oder -einer geeigneten weiteren Maschine ausgeführt und sie ist für die Steuerung der Clients-Maschine zuständig. -Alleine diese Rolle der Steuerkonsole setzt schon voraus, dass das GUI so benutzerfreundlich aufgebaut werden soll, -dass diese Aufgabe vereinfacht wird.~\\ - -Wir werden uns in den nächsten Punkten auf den technischen Aufbau der Steuerkonsole fokussieren. -Wir werden als erstes die Auswahl von Qt zum Aufbau des Server-GUI, dann werden wir die GUI Server-Konsole vorstellen und zum -Schluss werden wir die Beziehung Server-Client unter die Lupe nehmen. - -\section{pvsmgr in Qt} -Das Server-GUI wurde in der ersten Version in GTK/Gnome implementiert. Dank der Flexibilität, die von Qt ermöglicht wird, wurde die komplette -Anwendung in Qt umgeschrieben. Qt ist ein User Interface Framework und ermöglicht die Implementierung von Anwendungen, die unter Linux (Unix), Windows, mobile und eingebettete Systemen ausführbar sind. - -\section{GUI Server-Konsole} -Hier sollte die Hauptsteuerung des PVS abgewickelt werden. - -\subsection{Architektur} -Es wird u.a. möglich sein, Funktionen auszuführen wie: die Frame der einzelnen Clients ansehen, ein Profil anlegen, -Screenshot aufnehmen, ein (Un)Projektion ausführen, eine Nachricht an Clients verschicken, usw... Die Grundstruktur -des pvsmgr wird in der Abbildung \ref{fig:pvsmgr} illustriert. Das Bild zeigt uns das Hauptfenster (\textit{MainWindow}) -der Anwendung und seine unterschiedlichen Komponenten:~\\ ~\\ ~\\ ~\\ ~\\ -\begin{figure}[h] - \centering - \includegraphics[width=0.80\textwidth]{bilder/pvsmgr.jpg} - \caption{pvsmgr-Architektur} - \label{fig:pvsmgr} -\end{figure} -\textbf{MainWindow}~\\ -Die Klasse MainWindow wird vom QMainWindow abgeleitet; das ist der Parent an der Spitze der Hierachie; -Sie zu zerstören, bedeutet ein automatisches -Schließen der einzelnen Komponente, also der gesammten Anwendung. Alle anderen Komponenten bauen auf ihr auf. -Die Abbildung \ref{fig:mainwindow} zeigt ihr Abhängigkeitsdiagramm. -~\\ -Alle andere Komponenten (Klasse) der Anwendung haben die Klasse MainWindow als Parent. Qt verwaltet eine Struktur der -Art \textit{parent-child} Beziehung, so dass wenn ein Parent zerstört wird, werden alle seine Kinder (\textit{child}) -automatisch mit zersört; Das ist der sogenannte \textit{Domino-Effekt}. -~\\ -\begin{figure}[h] - \centering - \includegraphics[width=0.80\textwidth]{bilder/mainwindow.png} - \caption{Abhängigkeitsdiagram: MainWindow} - \label{fig:mainwindow} -\end{figure} - - -\textbf{Menubar}~\\ -Diese Klasse enthält eine Liste von \textit{pull-down}-Menu und QMainWindow speichert diese im QMenuBar. Die Klasse -wird also vom QMenuBar abgeleitet. Die gespeicherten Menüs enthalten jeweils die Menu-Items, die nichts anderes als \textit{QAction} sind. -Beim Betätigen einer Aktion (Menü-Item) wird ein korrespondiertes \textit{SIGNAL} gesendet, wir verbinden dann dieses zu einem \textit{SLOTS}, -wie hier gezeigt wird \textit{connect(actionCreate-profile, SIGNAL(triggered()), MainWindow, SLOT(createProfile()))}; Also beim Clicken auf das Menü-Item -"File->Profile manager" wird das Signal \textit{triggered()} gesendet, das automatisch das Slot \textit{createProfile()} aufruft. Genau dieses Prinzip -wird auch auf die Aktionen im Toolbar angewandt. - -\textbf{Toolbar}~\\ -Die Klasse wird vom QToolBatr abgeleitet und enthält eine Liste von Aktionen, die man unmittelbar auf die gesamten -oder die ausgewählten Clients in der ConnectionList anwenden kann. ~\\ ~\\ - -\textbf{ConnectionList}~\\ -Sie enthält die Liste der verbundenen Clients. Sie ist vom QTableView abgeleitet. Die vorhandenen Clients in der Liste können -in unterschiedlichen Bezeichnungen angezeigt werden. Es ist also möglich die Clients unter verschiedenen Sichten anzuzeigen. -Die Clients können mit Name, IP-Adresse oder Username angezeigt werden. Wir entnehmen also, dass das QTableView genauer gesehen -3 Spalten enthält, von denen nur eins davon immer sichtbar wird. Dieses Geschehen lässt sich ganz trivial ausführen. - Man soll lediglich dafür sorgen, dass wenn eine Spalte angezeigt wird, sollen die 2 anderen ausgeblendet werden. -Das QTableView steht zu diesem Zweck die Methode \textit{setColumnHidden(int column, bool hidden)} zur Verfügung, wobei \textit{column} - die betroffene Spaltenummer (die erste Spalte hat den Index 0) ist und \textit{hidden} legt dann fest, ob die Spalte -ein-(\textit{true}) oder ausgeblendet(\textit{false}) bleiben soll. Angesichts des angewandten Selection-Model - (\textit{QItemSelectionModel}) ist es möglich mehrere Clients (\textit{QAbstractItemView::ExtendedSelection}) aufzufassen und -die entsprechenden verfügbaren Aktionen aus dem Tollbar oder der ContexMenu auszuführen.~\\ - -\textbf{ConnectionWindow}~\\ -Die Klasse ist wie der zentrale Widget der Anwendung. Sie ist vom QWidget abgeleitet und enthält die Frame der -jeweiligen verbundenen Clients. Klarerweise hat diese Komponente die MainWindow-Klasse als Parent.~\\ - -\textbf{ConsoleLog}~\\ -Abgeleitet von QTextEdit, hier werden alle Logs angezeigt. Der Log-Bereich ist per Default ausgeblendet. -Man kann ihn aber anzeigen lassen. Man unterscheidet mehrere Arte von Logs: Chat, Error, Normal, Network und Terminal. -~\\ - -Die richtig konfigurierten Clients werden mit dem pvs-Server verbunden und werden auf der GUI Server-Konsole angezeigt. - Der Server bietet 2 unterschiedliche Sichten zur Anzeige der verbundenen Clients an. - -\subsubsection{Clientliste-Ansicht} -Diese Sicht ist eine Liste, die aus einem \textit{QTableview}-Object abgeleitet wird. Die Client-Liste ist definiert -durch die ConnectionList-Klasse die Abbildung \ref{fig:connectionlist} zeigt uns die Abhängigkeitsdiagramm dieser Klasse. -\begin{figure}[h] - \centering - \includegraphics[width=0.80\textwidth]{bilder/ConnectionList.png} - \caption{Abhängigkeitsdiagramm der ConnectionList-Klasse} - \label{fig:ConnectionList} -\end{figure} - -Die Tabelle enthält 3 Spalten, von denen nur eine angezeigt werden kann. Mit Hilfe passender Tastenkombinationen -können die anderen Spalten angezeigt werden. Die Spalten enthalten jeweils den Name der Clients, seine IP-Adresse und seinen Username. Außerdem -haben wir hier ein Kontextmenü per Überschreibung der Methode \textit{mouseReleaseEvent(QMouseEvent * e)} aus der Mutter-Klasse (QTableView) -zur Verfügung gestellt. Das Kontextmenü ist hier im Grunde ein Popup-Menü, das Menü-Item enthält. Diese Menü-Items sind nichts anderes als Actionen -und sie werden behandelt wie wir es schon oben beschrieben haben. Das Popup-Menü wird angezeigt, wenn die rechte Mause-Taste auf einem Item in -\textit{QTableView} losgelassen wird.\\ -Von der jeweiligen Clients in der ConnectionList wollen wir jetzt die entsprechenden VNC-Ansichten vorstellen. - -\subsubsection{VNC-Ansicht} - -Die zweite Anzeigemöglichkeit, die vom Server angeboten wird ist die Anzeige der VNC-Verbindung zwischen -Client und Server. Genauer gesagt, auf dem pvsmgr kann der Dozent jeder Zeit nachvollziehen, was auf der Client-Maschine -passiert, dies wird vom rfb (Remote Frame Buffer) ermöglicht. Zu dem jeweiligen Client wird vom Manager ein \textit{VNCClientThread()} initialisiert -und in dieser Klasse wird der rfb-Client instanziiert. Die Klasse\textit{VNCClientThread()} wird vom QThread abgeleitet, somit wird eine kontinuierliche -Abfrage des Client rfb gesichert. Als QThread kann man mit der Methode \textit{msleep(int updatefreq)} den Thread für eine bestimmte Zeit -(in Millisekunde) schlafen lassen; dies ermöglicht also den pvsmgr die Abfragefrequenz des Client-rfb zu steuern. Darüberhinaus wird -dem Dozent die Möglichkeit gegeben die Qualität der VNC-Qualität jeder Zeit festzulegen. Da es quasi nicht möglich ist, eine VNC-Qualität bei laufender -Verbindung zu ändern, ist es dann notwendig dem Thread der entsprechenden Client zu terminieren und einen neuen mit dem gewünschten -Quality zu starten und danach dem Client diesen neuen Thread wieder zuzuordnen.~\\ -\begin{figure}[h] - \centering - \includegraphics[width=0.80\textwidth]{bilder/connectionframe.png} - \caption{Abhängigkeitsdiagramm der ConnectionFrame-Klasse} - \label{fig:Connectionframe} -\end{figure} -Die VNC-Ströme werden in der ConnectionFrame-Klasse verwaltet. Die ConnectionFrame ist vom QGroupBox abgeleitet. Die Abbildung \ref{connectionframe} -das Abhängigkeitsdiagramm der Klasse. Die Klasse wird vom QGroupBox abgeleitet und enthält das Object QLabel, das die eigentlichen VNC-Ströme -anzeigt, denn QLabel ist im Qt eine optimale Unterstützung zum Anzeigen und zum skalieren von Bildern. Jede ConnectionFrame hat ein Kontextmenü und diese -werden genau so wie wir es in der ConnectionList beschrieben haben, verwaltet. \\ - -Wir fahren mit der Vorstellung der pvsmgr-Struktur fort. Wir wollen uns in den nächsten Punkten der Verbindung zwischen Client und Server -annähen, in dem wir dieser Aushandlung diese Verbindung betrachten. Allerdings werden wir nähere Details darüber in anderen Abschnitten erläutern. - -\subsection{Client-Seite} - -Wir wollen davon ausgehen, dass im Subnetz, indem sich die Client-Maschine befindet, bereits ein pvsmgr gestartet wurde. - Die Abwicklung auf dem server werden wir im nächsten Punkt erläutern. Nach dem Start eines Server sendet dieser eine -Broadcast-Nachricht, die von allen verfügbaren Client erhalten wird. Erhält ein Client diese Nachricht, dann weiß er, -dass ein Server gerade am laufen ist. Anschließend fügt der Client diesen Server in seiner Server-Liste hinzu. -Wird es eine von einen anderen Server gesendetete Broadcast-Nachricht empfangen, wird ebenfalls den entsprechenden -Server in die Server-Liste des Client hinzugenommen. -Der Client verfügt also über eine Liste von potentiellen Server, mit denen er eine PVS-Verbindung aufbauen kann, die dann schließlich -eine VNC-Verbindung wird und erst dann kann die Remote Frame Buffer initialisiert werden. Verläuft diese Initiliasierung erfolgreich, wird bei dem Server -der VNC-Frame angezeigt. -Aus seiner Server-Liste kann der Client freiwillig den Server auswählen, mit dem er sich verbinden möchte. Allerdings -erfolgt die eigentliche Verbindung zwischen Server und Client erst, nachdem der Client das vom Dozent gesetzte Passwort -richtig eingegeben hat. Beim Start des Server wird vom System ein zufälliges Passwort generiert und der Dozent soll dieses den Client -im Raum bekanntgegeben, so dass ein anderer Client, der im Nebenraum steht und auch die Server-Broadcast-Nachricht erhalten hat, -keine M{\"0}glichkeit hat, mit diesem Server eine Verbindung aufbauen zu können. -%Die genaue Spezifikation der Abwicklung der Verbindung zwischen und Client und Server kann in ServAppTech und in Service-Discovery entnommen werden. -Also nun hat ein Client das richtige Passwort eingeben und die Verbindung mit dem Server konnte erfolgreich aufgebaut werden. An dieser Stelle wollen -wir noch betonen, dass der Dozent selbst entscheiden kann, ob ein Passwort zum Verbindungsaufbau mit dem PVS-Server vom Client aus eingegeben werden -soll oder nicht. Dafür wird eine Checkbox auf dem pvsmgr-GUI eingebaut, die beim Ankreuzen per SIGNAL-SLOT die Funktion -\textit{PVSConnectionManager::getManager()->setNeedPassword(bool needed)} aufruft, wobei mit \textit{needed=TRUE} wird ein Passwort benötigt. \\ -Nun wollen wir erläutern wie der Server mit einer bestehenden Verbindung umgeht.~\\ - -\subsection{Server-Seite} - -Wir hatten schon erwähnt, dass der Server 2 Ansichtsmöglichkeiten zur Annzeige eines verbundenen Client verfügt. -Nachdem ein Client mit dem Server eine Verbindung erfolgreich aufgebaut hat, wird fast zeitgleich erstmal der Client -links in der Connection-Liste angezeigt und dann wird eine VNC-Verbindung zwischen Client und Server so aufgebaut, dass auf der rechten -Seite (\textit{Connectionwindow}) das Client-Frame angezeigt werden kann. Jeder Frame wird so beschriftet, -dass es jeder Zeit möglich wird, aus einem Client in der Liste (links) den entsprechenden Frame (recht) anzuordnen.\\ - -Somit hat der Server einen besseren {\"U}berblick über die gesamten vorhandenen Verbindungen. Der Server kann also jegliche verfügbare - Aktion ausführen. Der Betreiber (der Dozent) des pvsmgr verfügt über eine zweite Maschine, die an einen Beamer angeschlossen -wird und auf dieser Maschine läuft ein PVS-Client. Dieser Client wird als \textit{Superclient} bezeichnet und verfügt dementsprechend gegenüber anderen Clients über einen Sonderstatus. Z.B: bei einer LockAll-Aktion wird er nicht gesperrt und dabei muss geachtet werden, dass ein auf dem Superclient projektierter Client auch nicht gesperrt wird. - -\section{Verbindungsverwaltung und Projektion} - -Meldet sich ein Client an der PVS-Steuerkonsole an, wird der Bildschirminhalt des Clients zur Thumbnail Darstellung angefordert. Hierzu sendet der Client seine Verbindungsdaten, d.h. Passwort, RW Passwort und Port, an die Steuerkonsole (s.h. Liste der PVS Messages \ref{pvs-msg-liste}). Die Verbindungsdaten werden in der Klasse \texttt{pvsConnectionManager} in einer Liste \texttt{std::list \_listClients} von PVSClient Objekten verwaltet. Ein solches Clientobjekt enthält unter anderem Port, Passwort, RW Passwort sowie Flags, ob eine VNC Verbindung erlaubt ist, ob ein VNC Passwort vorhanden ist, und ob der Client gerade projeziert wird (siehe hierzu auch \texttt{/core/pvsClient.h}). Der pvsConnectionManager wird in allen Klassen verwendet, welche auf die Verbindungsdaten der Clients zugreifen müssen, daher ist er als Singleton implementiert und auf die entsprechende Instanz kann über \texttt{PVSConnectionManager::getManager()} zugegriffen werden. - -\subsection{Projektion} -\label{pvs-console-projection} -Um zu gewährleisten, dass bei einer Projektion ein als Quelle ausgewählter Client nicht als Ziel einer Projektion gewählt werden kann, werden in der Klasse \texttt{ConnectionList} -eine Liste \texttt{QList targetList} mit den Projektionszielen und eine Map \texttt{QMap > sourceMap} mit der Quelle und der zugehörigen Liste von Zielen geführt. Wird ein Client als Projektionsquelle ausgewählt, wird zunächst überprüft, ob dieser Client schon in der Liste der Projektionsziele vorhanden ist. Ist er nicht vorhanden, wird ein Auswahldialog \texttt{projectionDialog} mit allen verfügbaren Projektionszielen angezeigt (ProjectionDialog erhält die entsprechende Liste durch\\ \texttt{MainWindow::getWindow()->getConnectionList()->getTargetToDisplay(source)}). Projektionsziele können hierbei alle angemeldeten Clients sein, die nicht Ziel oder Quelle einer anderen Projektion sind. Die Auswahl der Ziele im \texttt{projectionDialog} erfolgt durch Checkboxen. Die hierdurch gewählten Clients werden zurück an die den \texttt{projectionDialog} aufrufende Klasse übergeben. Nachdem Quelle und Ziel ausgewählt wurden, wird die Funktion \texttt{projectStations}, welche zunächst prüft, ob auf dem Quell-Client überhaupt ein VNC Server läuft, in der Klasse \texttt{ConnectionWindow} mit dem Quell-Client als Parameter aufgerufen. Ist ein VNC Server gestartet, so werden die Verbindungsdaten des Quell-Clients, die über die get-Methoden des entsprechenden PVSClient Objekts ausgelesen werden, an alle Ziel-Clients als durch Leerzeichen separierte Liste gesendet. Auf Clientseite werden diese Verbindungsdaten dann in ein Array transformiert und an den \texttt{clientVNCViewer} übergeben (via DBus). -Soll ein Client als Ziel zu einer existierenden Projektion hinzugefügt werden, wird der entsprechende Quellclient und alle neuen bzw. zusätzlichen Projektionsziele gewählt. Die Zielclients werden dann einfach der in der \texttt{sourceMap} gespeicherten Liste der Quelle sowie der \texttt{targetList} hinzugefügt. -\subsubsection{Qualitätsoptionen} -\label{pvs-console-quality} -Zusätzlich zu den Verbindungsdaten werden Qualitätsoptionen zu der gesendeten Nachricht hinzugefügt. Die Qualitätsoption ist ein Integerwert 0,1 oder 2 wobei 0 der besten Qualität, 2 der schlechtesten Qualität entspricht. Dieser Wert wird an den Zielclient einer Projektion gesendet, welcher die Qualitätseinstellungen des VNC-Viewers entsprechend anpasst. Aktuell wird die Qualität immer auf 0 gesetzt, da noch die Einstellungsmöglichkeiten in der GUI fehlen. -\subsection{Remote Help} - -Remote Help funktioniert analog zur Projektion, jedoch ist hier zu gewährleisten, dass jeweils nur ein Quellclient und ein Zielclient ausgewählt werden, da es nicht sinnvoll ist, Tastatur und Maus eines Clients von mehreren anderen Clients aus zu steuern. Anstelle des Passworts wird das RW-Passwort des Clients verwendet. Die Möglichkeit, die Maus und die Tastatur eines Clients zu steuern, ist mit dem verwendeten VNC-Server schon gegeben, für die Steuerkonsole ändert sich hier nichts, lediglich der VNC Viewer muss die Tastatureingaben und die Mausbewegung an den VNC Server weitergeben (siehe hierzu auch \ref{pvsclient-remotehelp} Tastatur und Maussteuerung). \ No newline at end of file diff --git a/doc/LaTeX/devel/0500-pvs-client.tex b/doc/LaTeX/devel/0500-pvs-client.tex deleted file mode 100644 index bbca766..0000000 --- a/doc/LaTeX/devel/0500-pvs-client.tex +++ /dev/null @@ -1,243 +0,0 @@ -\chapter{PVS-Client} -Der PVS-Client ist in ein Backend (\textbf{pvs}) und ein Frontend (\textbf{pvsgui}) aufgeteilt. Erster läuft als Daemon im Hintergrund und kommuniziert über ein gegebenes Netzwerk mit der Steuerkonsole (\textbf{pvsmgr}). Die Interprozesskommunikation (inter-process communication, IPC) zwischen Back- und Frontend erfolgt über D-Bus und wurde mit Hilfe der von Qt4 bereitgestellten Bibliothek QtDBus realisiert. Um das Backend von einer GUI komplett unabhängig zu halten, wurde darauf geachtet, dass alle Nachrichten, die an die GUI gerichtet sind, vom Backend als Signale über D-Bus verteilt werden. Umgekehrt, wenn das Frontend eine Nachricht an das Backend schicken will, muss es sich der im Backend implementierten Slots bedienen (s. Abbildung \ref{pdf:dbus}). Somit ist es sogar möglich, dass mehrere GUIs gleichzeitig ein und das selbe Backend benutzen. Ein weiteres Feature ist, dass das Frontend beim Start das Backend durch einen D-Bus Aufruf automatisch startet. Hierzu muss allerdings die Applikation zuvor mit \textbf{make install} auf dem System installiert worden sein.\\ - -\begin{figure} - \begin{center} - \includegraphics[scale=0.7]{bilder/DBus} - \caption{Back- und Frontend des PVS-Clients kommunizieren über D-Bus} - \label{pdf:dbus} - \end{center} -\end{figure} -Zunächst muss in der Hauptklasse des Backends (\textit{pvs.cpp}) das Qt-Makro -\begin{verbatim} -Q_CLASSINFO("D-Bus Interface","org.openslx.pvs") -\end{verbatim} -eingefügt werden, um dem späteren D-Bus-Interface einen Namen zu geben. Als nächstes werden alle zu exportierenden Slots wie gewohnt mit \texttt{Q\_SLOTS} bzw. Signale mit \texttt{Q\_SIGNALS} in der \textit{pvs.h} gekennzeichnet. Schließlich folgen ein paar Definitionen in der \textit{\mbox{CMakeLists.txt}}, deren Bedeutung aus den Kommentaren entnommen werden kann: -\begin{verbatim} -# QtDBus Modul aktivieren -SET( QT_USE_QTDBUS TRUE ) -# Signale und Slots aus pvs.h ins XML-Format exportieren -QT4_GENERATE_DBUS_INTERFACE( src/pvs.h org.openslx.pvs.xml ) -# D-Bus Adapter für Backend erzeugen -QT4_ADD_DBUS_ADAPTOR( PVS_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml - src/pvs.h PVS ) -# Aus der zuvor erstellten XML-Datei ein Interface in C++ Syntax -# generieren -QT4_ADD_DBUS_INTERFACE( PVSGUI_SRCS - ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml pvsinterface ) -\end{verbatim} -Sind die Vorbedingungen erfüllt, wird beim ersten Kompilieren eine Datei namens \textit{pvsinterface.h} erstellt, in der die Definition der Klasse \texttt{\mbox{OrgOpenslxPvsInterface}} gespeichert wurde. Diese Klasse kann nun in anderen Programmen (wie z.B. in der \textbf{pvsgui}) dazu benutzt werden, um Zugriff auf die freigegebenen Ressourcen des Backends zu erhalten. - -\section{Grafische Benutzeroberfläche} -Die Hauptklasse der Benutzeroberfläche des Clients heißt \texttt{PVSGUI} und befindet sich in der Datei \textit{pvsgui.cpp}. In dieser werden Referenzen auf alle benutzten Dialoge, das System Tray Icon sowie das D-Bus Interface zur Kommunikation mit dem Backend erzeugt. Weiter beinhaltet diese Klasse die \texttt{main()}-Funktion und bildet somit den Einstiegt für das Betriebssystem. Damit der Zugriff auf die Toolbar immer gewährleistet bleibt (auch wenn Videos oder eine virtuelle Maschine im Vollbild laufen), muss beim Zeichnen dieser der laufende Windowmanager umgangen werden. Hierbei hilft uns Qt mit der Anweisung: -\begin{verbatim} -setWindowFlags(Qt::WindowStaysOnTopHint|Qt::X11BypassWindowManagerHint); -\end{verbatim} -Wie bereits in der Einleitung erwähnt, wird das komplette Projekt mit Hilfe von CMake erstellt. Aus diesem Grund soll an dieser Stelle ebenfalls eine kleine Beschreibung folgen, wie man mit CMake Qt-Klassen einbindet, die mit dem Qt-Werkzeug \textbf{designer} erstellt worden sind. Als Beispiel dient die Klasse \texttt{PVSGUI}, wobei wir hier nicht auf die Qt eigenen Details eingehen werden. -\begin{verbatim} -# CMake anweisen, Qt4 auf lokalem System zu suchen -FIND_PACKAGE( Qt4 4.5.0 REQUIRED ) -INCLUDE( ${QT_USE_FILE} ) -# Sowohl Quell- als auch Zielverzeichnis auf Quelldateien durchsuchen -INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR} ) - -# Alle von der Software benötigten Quelldateien -SET( PVSGUI_SRCS src/pvsgui.cpp ) -# Vom Meta Object Compiler benötigte Header-Dateien -SET( PVSGUI_MOC_HDRS src/pvsgui.h ) -# Auflistung aller benötigten .ui Dateien -SET( PVSGUI_UIS src/gui/ui/clientToolbar.ui ) -# Ressourcendateien -SET( PVSGUI_RCS pvsgui.qrc ) - -# Qt Meta Object Compiler ausführen (moc) -QT4_WRAP_CPP( PVSGUI_MOC_SRCS ${PVSGUI_MOC_HDRS} ) -# Qt User Interface Compiler ausführen (uic) -QT4_WRAP_UI( PVSGUI_UI_HDRS ${PVSGUI_UIS} ) -# Qt Resource Compiler ausführen (rrc) -QT4_ADD_RESOURCES( PVSGUI_RC_SRCS ${PVSGUI_RCS} ) - -# Applikation mit allen benötigten Variablen bauen -ADD_EXECUTABLE( pvs ${PVS_SRCS} ${PVS_MOC_SRCS} ${PVS_RC_SRCS} ) -# Mit der Qt-Bibliothek linken -TARGET_LINK_LIBRARIES( pvsgui ${QT_LIBRARIES} ) -\end{verbatim} - -\section{User-Interface für Benutzerkonfiguration} -Der eingebaute Konfigurationsdialog besteht hauptsächlich aus der Klasse \texttt{ClientConfig\-Dialog} und ist in der Datei \textit{clientConfigDialog.cpp} definiert. Es handelt sich hierbei um einen gewöhnlichen \texttt{QDialog}, dessen graphische Implementierung in der Datei \textit{clientConfigDialog.ui} gespeichert ist.\\ -Den Kern dieser Klasse bildet ein \texttt{QSettings} Objekt, das sowohl zum Speichern als auch zum Laden der Benutzerkonfiguration benutzt wird. Ablage aller Einstellungen ist die Datei \textit{\textasciitilde/.config/openslx/pvsgui.conf}. Diese kann jedoch zentral für die gesamte Applikation in der Funktion \texttt{PVSGUI::main(int argc, char *argv[])} geändert werden.\\ -Um weitere Komponenten der GUI über Änderungen der aktuellen Konfiguration zu informieren, wird das Signal \texttt{configChanged()} emittiert. - -\section{Darstellung von VNC-Datenströmen} -\label{pvsclient-datenstrom} -Die übertragenen Bildinformationen können in einem separaten Fenster oder im Vollbildmodus dargestellt werden. Hierzu wählt der Dozent über die Steuerkonsole (\textbf{pvsmgr}) eine Quelle und ein oder mehrere Ziele zur Projektion aus, was zur Folge hat, dass an alle gewählten Clients (\textbf{pvs}) eine Nachricht mit den benötigten Informationen geschickt wird. Als nächstes sendet das Backend ein Signal über D-Bus an sein Frontend, das die benötigten Informationen (Host, Port, Passwort, Qualität) enthält. Somit kann nun die GUI eine Verbindung zum gegebenen VNC-Server aufbauen und den Datenstrom darstellen.\\ - -Der Aufbau des VNC-Viewers besteht aus zwei Klassen: -\begin{itemize} - \item Die Klasse \texttt{VNCClientThread} stellt mit Hilfe eines \texttt{rfbclient} (aus libvncserver0) eine Verbindung zum VNC-Server her. Zunächst werden sämtliche Verbindungsparameter über den Konstruktor definiert und nach einem Aufruf von \texttt{VNCClientThread::start()} eine Verbindung aufgebaut. Da diese Klasse selbst von \texttt{QThread} abgeleitet ist, läuft sie in einem eigenständigem Thread, um die GUI nicht zu blockieren. Der Informationsaustausch erfolgt über das Signal \texttt{VNCClientThread::imageUpdated(int x, int y, int w, int h)}, welches die Koordinaten einer Änderung des Framebuffers enthält. - \item Die Darstellung des Datenstroms wird von der Klasse \texttt{ClientVNCViewer} übernommen. Da beide Klassen auf ein und den selben Ressourcen arbeiten, müssen die Signale des \texttt{VNCClientThread} mit dem Parameter \texttt{Qt::BlockingQueuedConnection} verbunden werden. Dies stellt sicher, dass der Thread solange pausiert, bis der Slot des \texttt{ClientVNCViewer} abgearbeitet wurde (\texttt{ClientVNCViewer::updateImage(int x, int y, int w, int h)}). -\end{itemize} -Bei der Entwicklung des VNC-Viewers musste stark auf die Performanz geachtet werden. Das Ziel ist es, sowohl Bandbreite als auch CPU-Last einzusparen. Um die Netzwerkauslastung konfigurierbar zu machen, stehen drei Qualitätsstufen zur Wahl, von denen eine gewählt werden muss. Durch diese serverseitige Konfiguration wird beispielsweise auf der niedrigsten Qualitätsstufe die Farbtiefe verringert und die Kompressionsstufe erhöht (verlustbehaftet), was die zu übertragenen Bildinformationen minimiert. Um den Prozessor des Zielrechners nicht unnötig zu belasten, werden wie im VNC-Protokoll vorgesehen, nur die Bereiche des Framebuffers neu gezeichnet und skaliert, die sich auch geändert haben. - -\section{Chat-Interface} -Die vom Chat-Interface verwendeten Klassen und Dialoge befinden sich in den Dateien \textit{clientChatDialog.cpp} und \textit{clientChatDialog.ui}. Der Informationsaustausch erfolgt hier wieder über D-Bus direkt mit dem Backend.\\ -Zum Versenden einer Nachricht wird der Slot \texttt{PVS::chat\_send()} und zum Empfang das Signal \texttt{PVS::chat\_receive()} des Backends benutzt. Um die Liste aller Chatteilnehmer aktuell zu halten, wird analog vorgegangen. Hierzu existieren die Slots \texttt{PVS::chat\_client\_add()} und \texttt{PVS::chat\_client\_remove()}.\\ -Um neben dem öffentlichen Chat auch private Unterhaltungen zwischen zwei Teilnehmern zu ermöglichen, wurde ein \texttt{QTabWidget} benutzt. Auf diesem wird bei jeder neu begonnenen Unterhaltung ein \texttt{QTextEdit} platziert, dass dem Gesprächspartner durch ein \texttt{QHash} direkt zugeordnet wird. - -\section{Dateiübertragung und Interface} -Die graphische Benutzerschnittstelle des Clients ermöglicht allen Chatteilnehmern binäre Dateien untereinander zu tauschen. Dazu wurden zwei Dialoge entwickelt -- einer zum Senden und einer zum Empfang. Diese Dialoge stellen nicht nur das Benutzerinterface dar sondern bilden ebenfalls die komplette Grundlage (Client-Server) zur Übertragung binärer Daten. Die hierfür entworfenen Klassen sind \texttt{ClientFileSendDialog} und \texttt{ClientFileReceiveDialog}, zu denen die gleichnamigen .ui Dateien gehören.\\ - -Daten senden:\\ -Um eine Datei zu senden, sind der Name des Chatteilnehmers (Nickname) sowie der Pfad der zu sendenden Datei erforderlich. Falls diese Informationen nicht vorhanden sind, wird der Benutzer durch Pop-Ups danach gefragt. Der nächste Schritt besteht darin, die IP bzw. den Hostnamen des Chatteilnehmers zu erfragen. Dies geschieht automatisch, indem das Backend (\textbf{pvs}) diesbezüglich über D-Bus befragt wird. Stehen alle Angaben zur Verfügung, wird an den Zielrechner ein kleiner Header mit folgenden Informationen geschickt: -\begin{verbatim} -Nickname_des_Senders;Dateiname;Dateigröße\n -\end{verbatim} -Sollte sich der Kommunikationspartner für den Empfang der angebotenen Datei entscheiden, wird von diesem eine Bestätigung verschickt (ack), die den eigentlichen Übertragungsvorgang startet. Das Ende der Übertragung wird dem Empfänger durch das Schließen des benutzen Sockets signalisiert.\\ -Während der Übertragung wird ein Dialog angezeigt der den Sender über den Fortschritt mit Hilfe einer \texttt{QProgressBar} informiert. Der Vorgang kann jederzeit abgebrochen werden und über aufgetretene Fehler wird durch Pop-Ups informiert.\\ - -Daten empfangen:\\ -Sobald die graphische Benutzeroberfläche des Clients startet, wird durch eine Instanz des \texttt{QTcpServer} der Port 29481 geöffnet und auf eingehende Verbindungen gewartet. Wird nun von einem anderen Teilnehmer eine Datei angeboten, so wird eine Instanz des \texttt{ClientFile\-ReceiveDialog} angelegt, die sich um den weiteren Verlauf kümmert. Der Empfänger kann nun, die Übertragung akzeptieren und einen Speicherort wählen. Danach wird eine Bestätigung an den Sender verschickt und die eigentliche Datenübertragung gestartet.\\ -Auch der Empfänger wird durch einen Dialog über den Fortschritt informiert und kann die Übertragung jederzeit abbrechen.\\ - -Wichtig an dieser Stelle ist die Speicherfreigabe beendeter Übertragungsdialoge. Da wir gleichzeitig beliebig viele Übertragungen erlauben wollen, muss natürlich für jede ein eigenständiger Dialog erzeugt werden. Um keine Liste mit laufenden Dialogen führen zu müssen (und einzelne zu löschen) wird hier auf einen komfortablen Qt-Mechanismus zurückgegriffen. Sobald ein Dialog mit \texttt{accept()} oder \texttt{reject()} beendet wird, sendet dieser das Signal \mbox{\texttt{finished(int)}}. Auf der anderen Seite besitzt jede Klasse, die von \texttt{QObject} abgeleitet wurde, den Slot \texttt{deleteLater()}. Die Qt-API garantiert, dass Qt nach dem Aufruf dieser Methode dieses Objekt selbstständig aus dem Speicher entfernt. Also müssen wir dieses Signal dem Slot zuordnen (in \texttt{ClientFileSendDialog} und \texttt{ClientFileReceiveDialog}): -\begin{verbatim} -connect(this, SIGNAL(finished(int)), this, SLOT(deleteLater())); -\end{verbatim} - -\section{VNC Server} -Um den Bildschirminhalt von Clients zum einen in der Übersicht (Thumbnails) der Steuerkonsole und zum anderen auf anderen Clients und dem Beamer darstellen zu können, wird das sogenannte Remote Framebuffer Protokoll (RFB), welches auch der Virtual Network Computing (VNC) Software zugrundeliegt, benutzt. Um VNC bzw RFB nutzen zu können, wird ein VNC Server und ein VNC Viewer benötigt. Aktuell wird als VNC Server \texttt{x11vnc} verwendet sowie der, wie in \ref{pvsclient-datenstrom} beschrieben, in den den PVS-Client integrierte rfbclient bzw. ClientVNCViewer. Bei der VNC Verbindung wird zwischen einer Verbindung ohne Maus und Tastatursteuerung, dem sogenannten Viewonly oder Readonly Modus, und einer Verbindung mit Maus und Tastatursteuerung, im folgendenden Read-Write (RW) Modus genannt, unterschieden. - -\subsection{Vergleich von VNC Servern} -Es gibt zwei Arten von VNC Servern. Server, die eine laufende Sitzung bzw. ein vorhandenes Display darstellen bzw. übermitteln können, und Server, die eine eigene Sitzung bzw. ein eigenes Display bereitstellen (virtuell). Für PVS ist die zweite Art, welche auf dem ursprünglichen VNC basiert, nicht verwendbar, da man hierbei nicht den aktuellen Bildschirminhalt der Clients in der Steuerkonsole anzeigen bzw. projezieren kann. Daher wurden folgende VNC Server im Weiteren nicht betrachtet: Xvnc (RealVNC), vnc4server, TightVNC. - -Motivation für den eigentlichen Vergleich ist die Integration mancher VNC Server in die Desktopumgebung. Hier müsste der x11vnc nicht extra installiert werden. Wichtig für den Einsatz im PVS ist vor allem die Unterstützung von Shared Modus, d.h. mehrere VNC Viewer können sich gleichzeitig mit dem VNC Server verbinden, und Forever Modus, d.h. der VNC Server wird nicht nach Trennung des letzten Clients beendet. Sicherheitsoptionen wie die Vergabe von Passwörtern und die Unterscheidung von RW und Viewonly Modus sind ebenso nicht zu vernachlässigen. - -\paragraph{Vino} -\begin{sloppypar} -~\\ -Vino ist der VNC Server der Gnome Desktopumgebung. -Er wird standardmäßig über die graphische Oberfläche \textbf{vino-preferences} konfiguriert. Über die Kommandozeile ist Vino entweder über \textbf{gconftool-2} oder über direktes editieren der Datei \\ -\textit{\~{}/.gconf/desktop/gnome/remote\_access/\%gconf.xml} konfigurierbar. -Parameter können nicht übergeben werden, was die Verwendbarkeit im PVS einschränkt. -Vino benutzt standardmäßig den Port 5900, um auf eingehende Verbindungen zu warten. Dieser Port kann nur durch -\texttt{gconftool-2 -s -t int \/desktop/gnome/remote\_access/alternative\_port } bzw. das Einfügen von z.B. -\texttt{''/>} -in die entsprechende \%gconf.xml Datei geändert werden. Hierbei ist zu beachten, dass nicht überprüft wird, ob der entsprechende Port schon belegt ist. Dementsprechend wird auch kein anderer freier Port gewählt. -Außerdem wird eine Änderung des Ports erst nach dem Neustart der grafischen Oberfläche aktiv. -Vino unterstützt die Vergabe eines Passworts, welches base64 kodiert in der gconf Datei abgelegt wird. Ebenso kann man den Zugriff auf den Viewonly Modus beschränken. Unterschiedliche Passwörter für den RW Modus und den Viewonly Modus können jedoch nicht vergeben werden. Der Shared und Forever Modus sind standardmäßig aktiv. -\end{sloppypar} - -\paragraph{Krfb} -~\\ -Krfb ist das Pendant zu Vino der KDE Desktopumgebung und kann entweder über eine Konfigurationsdatei oder über die grafische Oberfläche konfiguriert werden. Es kann entweder das Einladungssystem verwendet werden, bei dem eine Einladung mit einem Einmalpasswort generiert wird, oder man erlaubt uneingeladene Verbindungen und vergibt ein eigenes Passwort. Um Krfb über eine Konfigurationsdatei mit einem selbstgewählten Passwort für uneingeladene Verbindungen zu konfigurieren, erstellt man die Datei wie im folgenden angegeben und übergibt sie an krfb mit \texttt{krfb --config } bzw überschreibt oder bearbeitet die eigentliche Konfigurationsdatei in \textit{~/.kde/share/config/krfbrc}. -%\label{pvs-client-krfbconfig} -\begin{verbatim} -[Security] -allowDesktopControl=false -allowUninvitedConnections=true -uninvitedConnectionPassword= - -[TCP] -port= -useDefaultPort=false -\end{verbatim} - -Mit allowDesktopControl kann zwischen RW und Viewonly Modus gewechselt werden, unterschiedliche Passwörter können hierfür nicht vergeben werden. Zu beachten ist, dass die Passwörter für uneingeladene Verbindungen unverschlüsselt gespeichert werden. Wie auch Vino läuft Krfb standardmäßig im Shared und Forever Modus. - -\paragraph{x11vnc} -~\\ -x11vnc ist ein auf libvncserver basierender VNC-Server, der von Karl Runge entwickelt wurde, um unter Linux/Unix Systemen existierende Displays über VNC anzeigen zu lassen. -x11vnc wird über Parameter von der Kommandozeile aus konfiguriert. -Eine ausführliche Liste aller verfügbaren Parameter findet sich unter -\url{http://www.karlrunge.com/x11vnc/x11vnc_opts.html}. Zu beachten ist hierbei, dass alle Parameter, die an x11vnc übergeben werden (also beispielsweise auch Passwörter), in der z.B. durch \textbf{ps aux} abrufbaren Prozessliste anzeigbar sind. -Daher sollte eine Passwortdatei, welche auch nach dem Auslesen automatisch von x11vnc gelöscht werden kann (s.h. \ref{pvs-vnc-script}), benutzt werden. Die Struktur einer solchen Passwortdatei ist wie folgt: -\begin{verbatim} - rwpassword1 - . - . - [rwpasswordX] - [\_\_BEGIN_VIEWONLY\_\_] - [password1] - . - . - [passwordX] -\end{verbatim} -Es muss mindestens ein Passwort vorhanden sein. Alle Passwörter bis zu der Zeile, welche \_\_BEGIN\_VIEWONLY\_\_ enthält, werden als rw-Passwörter angesehen (außer in dem Spezialfall, dass nur zwei Passwörter und keine Zeile mit BEGIN\_VIEWONLY vorhanden sind, dann wird das zweite Passwort automatisch als Viewonly Passwort behandelt). Alle Passwörter nach der entsprechenden Viewonly-Zeile werden als Viewonly Passwörter gesehen. So ist es möglich beliebig viele Viewonly und bzw. oder RW-Passwörter zu generieren. - - -\subsection{VNC Script} -\label{pvs-vnc-script} -Der VNC Server wird durch ein Bash-Skript (\textit{/misc/pvs-vncsrv}) von der Klasse \textit{pvs} gestartet. Es wird zufällig jeweils ein Passwort für Standardzugriff und ein Passwort für den Zugriff mit Maus und Tastaturunterstützung generiert. Die generierten Passwörter werden dem Skript als Parameter übergeben. \textbf{pvs-vncsrv} wird zum Starten wie folgt aufgerufen: -\texttt{pvs-vncsrv start port passwort [rwpasswort]}. -Der Parameter \texttt{rwpasswort} ist optional und kann beim Starten des x11vnc zur Verwendung im Viewonly Modus weggelassen werden. -Um den VNC Server zu stoppen, kann das VNC Script mit dem Parameter \texttt{stop} aufgerufen werden. -Die übergebenen Passwörter werden zunächst auf folgende Weise in die Datei \textit{~/.pvs/vncpassword} geschrieben: \verb|rwpasswort __BEGIN_VIEWONLY__ passwort|. -Als nächstes wird x11vnc mit folgenden Parametern ausgeführt: -\begin{itemize} - \item -auth ... - die Xauthority Datei - \item -bg - im Hintergrund starten - \item -forever - den X Server nicht beenden, wenn sich ein Client trennt - \item -display :0 - das anzuzeigende Display - \item -passwdfile rm:... - Pfad der Passwortdatei - \item -o ... - Pfad der Logdatei (~/.pvs/log.vncsrv) - \item -shared - erlaube mehreren Clients, sich zu verbinden -\end{itemize} - -Zu beachten ist vor allem das \texttt{rm:} vor der Pfadangabe bei \texttt{-passwdfile}. Dies bewirkt das Löschen der Passwortdatei, nachdem x11vnc sie eingelesen hat. -Die Passwortdatei wird verwendet, da man ansonsten Passwörter, die nur als Parameter im Klartext an x11vnc übergeben werden, mittels \textbf{ps aux} lesen könnte. - -Um einen Mehrfachstart des VNC Servers zu verhindern, wird zunächst immer ein \texttt{pvs-vncsrv stop} ausgeführt, welches nach der Prozessid des x11vnc sucht und diesen mit kill -9 beendet. - -\section{VNC Viewer} -Der VNC Viewer ist, wie in der \ref{pvsclient-datenstrom} Darstellung von VNC-Datenströmen beschrieben, implementiert. -Die direkte Integration des Viewers im Gegensatz zum Einsatz eines externen VNC Servers bietet sich hier wegen der Integrationsmöglichkeiten in die GUI an (der VNC-Server ist GUI unabhängig). Jedoch muss der VNC-Viewer zur Unterstützung des RW-Modus des VNC-Servers noch verändert werden. -\subsection{Tastatur und Maussteuerung} -\label{pvsclient-remotehelp} -\begin{sloppypar} -Um die Maus- und Tastatureingaben an den VNC-Server weiterzuleiten, müssen zunächst die Eingaben in der Klasse \texttt{ClientVNCViewer} abgefangen und verarbeitet werden. Dies kann durch Überschreiben der geerbten Methode \texttt{event} erreicht werden \texttt{bool ClientVNCViewer::event(QEvent *event)}. Hier kann durch \texttt{event->type()} der Typ des Events herausgefunden werden. -Zu behandelnde Eventtypen sind: -\end{sloppypar} - -\begin{itemize} -\item QEvent:KeyPress - Eine Taste wurde gedrückt -\item QEvent:KeyRelease - Eine Taste wurde losgelassen -\item QEvent:MouseButtonDblClick - Mausdoppelklick -\item QEvent:MouseButtonPress - Maustaste gedrückt -\item QEvent:MouseButtonRelease - Maustaste losgelassen -\item QEvent:MouseMove - Maus wurde bewegt -\item QEvent:Wheel - Mausrad wurde bewegt -\end{itemize} - -Hier können nun die jeweils zuständigen Funktionen aufgerufen werden. Dabei ist zu beachten, dass die Methode \texttt{event()} bei allen Eingaben, die von einer eigenen Funktion behandelt werden, true zurückgibt (d.h. das Event wurde akzeptiert und behandelt). In den aufgerufenen Methoden kann dann zwischen den verschiedenen Maustasten (Qt:LeftButton, Qt:MidButton, Qt:RightButton) und den verschiedenen Tasten der Tastatur (z.B. Qt:Key\_A, Qt:Key\_B, Qt:Key\_Alt siehe hierzu auch \url{http://doc.trolltech.com/4.6/qt.html#Key-enum}) unterschieden werden. -Die Tastatur- und Mauseingaben müssen dann entsprechend an \texttt{vncClientThread} weitergeleitet werden. -In der Klasse vncClientThread werden die Eingaben dann in Objekte gekapselt in einer Queue, welche regelmäßig geleert wird, gespeichert. Die Objekte sind dabei zum einen ein \texttt{PointerEvent} und ein \texttt{KeyEvent}. \texttt{PointerEvents} enthalten die Koordinaten des Mauszeigers (x,y) und einen hexadezimalen Wert, der die Maustasten und deren Zustand repräsentiert. -Werte sind dabei: -\begin{itemize} - \item 0x01 = linke Maustaste gedrückt - \item 0x02 = mittlere Maustaste gedrückt - \item 0x03 = rechte Maustaste gedrückt - \item 0xfe = linke Maustaste losgelassen - \item 0xfd = mittlere Maustaste losgelassen - \item 0xfb = rechte Maustaste losgelassen -\end{itemize} -\begin{sloppypar} -\texttt{KeyEvents} bestehen aus einem hexadezimalen Wert, der die Taste repräsentiert, und True oder False je nachdem, ob die Taste gedrückt wurde oder nicht. Die hexadezimalen Werte entsprechen den Werten in einem X Window System und können in der Headerdatei \texttt{} nachgeschlagen werden (siehe hierzu auch \url{http://www.realvnc.com/docs/rfbproto.pdf} - RFB Protokollspezifikation, Abschnitt KeyEvent). Beim Leeren der Queue werden die Methoden der rfbclient Klasse der libvnc Bibliothek \texttt{SendPointerEvent(cl, \_x, \_y, \_buttonMask)} und \texttt{SendKeyEvent(cl, \_key, \_pressed)} mit den entsprechenden Werten aufgerufen (cl entspricht dabei einem Pointer auf die eigentliche rfbClient Instanz). -\end{sloppypar} - -\section{Signalbehandlung} - -\begin{sloppypar} -Um zu gewährleisten, dass bei einer Terminierung des PVS-Clients auch der gegebenenfalls gestartete VNC-Server gestoppt wird, werden Sigterm, Sighup, Sigquit und Sigint Signale abgefangen und weiterbehandelt. -Um die Signale behandeln zu können, muss die C Bibliothek \texttt{signals.h} eingebunden werden und ein sigaction Objekt erstellt werden. Das Feld sa\_handler des sigaction Objektes gibt dabei die aufzurufende Funktion an (Pointer auf die Funktion). Diese Funktion (in der Klasse \texttt{pvs} die Funktion \texttt{signalHandler}) muss dabei vom Typ void sein und die Signalnummer als Parameter erwarten (\texttt{void PVS::signalHandler(int signal)}). -\end{sloppypar} - -\begin{verbatim} - struct sigaction act; - act.sa_handler = &PVS::signalHandler; -\end{verbatim} - -\begin{sloppypar} -Um Signale abfangen zu können, muss nun noch das sigaction Objekt durch \texttt{sigaction(SIGTERM, \&act, 0)} mit den entsprechenden Signalen (hier SIGTERM) verknüpft werden (muss für alle zu behandelnde Signale durchgeführt werden). -Danach wird, sobald ein entsprechendes Signal erhalten wird, die Funktion aufgerufen und die Signalnummer übergeben. -Für alle Signale kann die gleiche Funktion aufgerufen werden, hier kann die Unterscheidung dann mittels der in \texttt{signal.h} vorhandenen Konstanten SIGHUP, SIGTERM, SIGQUIT usw. erfolgen. Zu beachten ist hierbei, dass ein SIGKILL nicht abgefangen werden kann. -\end{sloppypar} \ No newline at end of file diff --git a/doc/LaTeX/header.tex b/doc/LaTeX/header.tex deleted file mode 100644 index 06488b5..0000000 --- a/doc/LaTeX/header.tex +++ /dev/null @@ -1,58 +0,0 @@ - -\thispagestyle{empty} -\vspace*{\stretch{0.5}} -{\center -\hspace*{5mm}{\huge \bf Pool Video Switch}\\ -\hspace*{5mm}{\huge Benutzer- und Entwicklerdokumentation \\ -\vspace*{\stretch{1}}} -\begin{figure}[h] -\center -\includegraphics[width=9cm]{bilder/siegel-neu.jpg} -\end{figure} -\vspace*{\stretch{0.5}} -\Large Entwickler-Team\\ \vspace*{\stretch{0.5}} -\large {\it Projekt des Lehrstuhls für Kommunikationssysteme} \\ -\vspace*{\stretch{0.3}} -Rechenzentrum / Institut für Informatik \\ -\vspace*{\stretch{0.3}} -\vspace*{\stretch{0.5}} -April 2010 \\} -\normalsize -\newpage -\thispagestyle{empty} -{\small back of titlepage} -\newpage - -\thispagestyle{empty} -\newcommand{\HRule}{\rule{\linewidth}{1mm}} -\setlength{\parindent}{0mm} -\setlength{\parskip}{0mm} -\vspace*{\stretch{1}} -\HRule -\begin{center} -\Huge Pool Video Switch\\[5mm] -\Large Benutzer- und Entwicklerdokumentation -\end{center} -\HRule -\vspace*{\stretch{2}} -\begin{center} -\large\textsc{OpenSLX Project\\Freiburg\\2010} -\end{center} - -\newpage -\thispagestyle{empty} - -. \\ -OpenSLX Project \\ -Lehrstuhl für Kommunikationssysteme \\ -Rechenzentrum \& Institut für Informatik an der Technischen Fakultät \\ -Herrmann-Herder-Str. 10 \\ -79104 FREIBURG i.Br. \\ -pvs@uni-freiburg.de \\ - - -\vspace*{\stretch{2}} - - -\newpage - diff --git a/doc/LaTeX/intro/0000-chapter.tex b/doc/LaTeX/intro/0000-chapter.tex deleted file mode 100644 index 6b3319b..0000000 --- a/doc/LaTeX/intro/0000-chapter.tex +++ /dev/null @@ -1,17 +0,0 @@ -\chapter{Idee} -\label{einleitung} -\index{Einleitung} \index{Video Switch} \index{Laptop} \index{VGA} \index{DVI} \index{Klassenraum} \index{Student Control Panel} \index{Idee} - -Video-Switches für Klassenräume sind schon seit langem auf dem Markt: Sie setzen typischerweise auf eine Hardware-Lösung, die das Verlegen von vielen Metern Kabel bei dadurch erzwungener statischer Anordnung der Rechner verlangt. Sie sind nicht nur aufgrund des Einsatzes spezieller Hardware relativ teuer, sondern unflexibel bei technischen Weiterentwicklungen: Höhere Bildschirmauflösungen oder der Wechsel vom VGA auf den DVI oder PS2 auf den USB-Stecker sind nur durch einen Komplettaustausch oder unangenehme Kompromisse zu haben. Ziemlich ungeeignet erweisen sich hardware-basierte Lösungen beim Einsatz mobiler Geräte wie Laptops. Zudem erschweren sie die Veränderung der ursprünglichen Aufstellung der Maschinen und schaffen damit ungünstige Bedingungen für neue didaktische Konzepte. -\begin{figure}[h] -\center -\includegraphics[width=11.5cm]{bilder/studentctlpanel.png} -\caption{Student Control Panel des Edubuntu-Pakets, welches im Umfeld von Linux-Terminalservern eingesetzt werden kann.\label{uscp}} -\end{figure} -Neben den Hardware-basierten Varianten existieren inzwischen eine Reihe von Software-Produkten. Leider bieten sie keine optimalen Lösungen: Neben oft exorbitanten Lizenzkosten, die oft mit einem didaktisch und konzeptionell fragwürdigen Feature-Set begründet werden, orientieren sie sich an einem einzigen auf den Schulungs-PCs festinstalliertem Betriebssystem. Oft stehen sie nur für ausgewählte Microsoft-Betriebssysteme zur Verfügung und können damit nicht dem Anspruch einer breiten und allgemeinen universitären Umgebung entsprechen. Zudem kommen regelmäßige, typischerweise kostenpflichtige Produkt-Updates hinzu, denen sich nur begrenzt ausweichen läßt. - -Dem soll ein eigener Ansatz entgegengesetzt werden, der die eingangs genannten Beschränkungen aufhebt und dem Anspruch einer modernen universitären computer-gestützten Lehre entgegenkommt. Das Projekt soll stufenweise von einer einfachen Basislösung in Rückmeldung mit den Lehrenden weiterentwickelt werden. Ein Open-Source-Ansatz gewährleistet zudem eine größere Nachhaltigkeit. Selbst bei einer Projekteinstellung können andere auf den Code weiterhin zurückgreifen und damit einerseits bestehende Installationen aktualisieren und andererseits eigene Entwicklungen schneller vorantreiben. - -Bei der Entwicklung steht nicht die Neuerfindung bereits vorhandener Technologien, sondern deren intelligente Verknüpfung im Vordergrund. So bieten bereits Techniken wie VNC oder Xorg/X11 viele notwendige Grundlagen, die um pfiffige Werkzeuge mit intuitiven Oberflächen erweitert werden sollen. Eine gute Anschauung bietet beispielsweise die Open Source Software ''Student Control Panel'' des Edubuntu-Linux (\ref{uscp}). - -Eine sehr vergleichbare Applikation ist iTalc. diff --git a/doc/LaTeX/intro/0100-funktionen.tex b/doc/LaTeX/intro/0100-funktionen.tex deleted file mode 100644 index 966a065..0000000 --- a/doc/LaTeX/intro/0100-funktionen.tex +++ /dev/null @@ -1,21 +0,0 @@ -\chapter{Funktionen eines Software-Video-Switchs} -\label{funktionen} -\index{Funktion} - -Damit ein Software-Video-Switch Hardwarelösungen ersetzen kann, muss zumindest eine gewisse Grundmenge an Funktionalität bereitgestellt werden. Diese Funktionen lassen sich in weiteren Schritten erweitern und können dabei über die der Hardwareimplementierungen hinausgehen. Gegebenenfalls muss eine Softwarelösung sich um Aspekte kümmern, die bei einer Hardwarelösung kaum ein Problem darstellen. Hierzu zählt das Thema der Abhörsicherheit. - -\section{Basisfunktionen} - -In der verfügbaren Version wurden eine Reihe von Features realisiert. Hierzu zählt die Anzeige aller Display-Inhalte der Teilnehmerarbeitsplätze in verkleinerter Form auf einem separaten Steuer-PC, die Möglichkeit einzelne Teilnehmerarbeitsplätze auf den Dozenten-PC und damit auf den Beamer zu schalten, per Chat-Interface von der Dozentin Nachrichten auf die Bildschirme einzelner oder aller Teilnehmer zu schicken, die Inhalte des Dozenten-PC auf alle Teilnehmer-Displays zu schalten und das Sperrenvon Maus- und Tastatur der Teilnehmer. -\begin{figure}[h] -\center -\includegraphics[width=11.5cm]{bilder/studentctlpanel.png} -\caption{Student Control Panel des Edubuntu-Pakets, welches im Umfeld von Linux-Terminalservern eingesetzt werden kann.\label{uscp}} -\end{figure} -Bei der Realisierung wurde einerseits auf die Absicherung der Steuerverbindungen und andererseits auf die Aspekte des Datenschutzes geachtet. Anders als bei vergleichbaren Produkten liegt in der Standardinstallation die Kontrolle bei den Teilnehmern. - - -\section{Funktionserweiterungen} - -In weiteren Schritten wurden Funktionen wie das Übertragen von Dateien zwischen einzelnen Maschinen oder das Senden von Dateien an mehrere Teilnehmer gleichzeitig implementiert (\ref{}). Ebenso besteht die Möglichkeit einzelne und mehrere -Maschinen gemeinsam mit Tastatur und Maus zu steuern. diff --git a/doc/LaTeX/intro/0900-textaufbau.tex b/doc/LaTeX/intro/0900-textaufbau.tex deleted file mode 100644 index 70d2a66..0000000 --- a/doc/LaTeX/intro/0900-textaufbau.tex +++ /dev/null @@ -1,13 +0,0 @@ -\chapter{Aufbau dieses Handbuchs} -\label{aufbau} -\index{Aufbau} \index{Bedienungsanleitung} \index{Entwicklerdokumentation} - -Das Handbuch ist in drei Teile gegliedert, wobei der erste Teil mit diesen Erläuterungen bereits abgeschlossen wird. Der zweite Teil wendet sich an die Endanwender dieses Projekts und versteht sich als Bedienungsanleitung mit dem Fokus auf den Überblick zum Funktionsumfang und zur Konfiguration. Der dritte Teil umfasst die Entwicklerdokumentation. Dabei werden die einzelnen Komponenten und das Kommunikationsprotokoll detaillierter aus technischer Sicht dargestellt. - -\section{Heraushebungen und Formatierungen} -\index{Schreibweise} \index{Kommando} \index{Quelltext} \index{Konfiguration} -\index{Formatierung} \index{Verzeichnis} \index{Dateiname} - -Zur besseren Lesbarkeit gibt es einige Konventionen zur Formatierung von einfachen Kommandos, Kommandozeilen oder Verzeichnis- und Dateinamen. Ebenso sind Skripte oder Auszüge aus C++-Quelltexten zur Heraushebung anders gesetzt. - -Hierbei gelten folgende Regelungen: Ein einfaches Kommando wird \textbf{fett} gesetzt, wie beispielsweise \textbf{pvsmgr}. Dieses lässt sich in einem Terminalfenster absetzen oder über die Ausführenoption der grafischen Desktops. Kommandos mit Optionen und bei Bedarf Parametern werden so wie Skripten und Quelltexte in \texttt{Schreibmaschinenschrift} gesetzt aber nicht aus dem allgemeinen Textsatz herausgehoben. Solche Heraushebungen werden jedoch ab zwei Druckzeilen aufwärts sinnvoll. Verzeichnis- und Dateinamen, wobei es bei letzteren dann nicht um den Programmnamen, sondern Quelltexte, Konfigurationen etc. geht, werden \textit{kursiv} gedruckt, wie beispielsweise \textit{/etc/pvs}. diff --git a/doc/LaTeX/mystyle-pdf.tex b/doc/LaTeX/mystyle-pdf.tex deleted file mode 100644 index 034ae31..0000000 --- a/doc/LaTeX/mystyle-pdf.tex +++ /dev/null @@ -1,112 +0,0 @@ -\documentclass[12pt,a4paper,ngerman]{book} - -\usepackage[ngerman]{babel} -\usepackage{ucs} -\usepackage[T1]{fontenc} -\usepackage[utf8x]{inputenc} -%\usepackage[latin1]{inputenc} -\usepackage{multicol} -\usepackage{graphicx} -\usepackage{makeidx} -\usepackage{ulem} -\usepackage{xcolor} -\usepackage{moreverb} - -%using serif-less Font -\renewcommand{\familydefault}{\sfdefault} - -% european A4 paper format---------> -\setlength{\textwidth}{15.8cm} % width of main text -\setlength{\textheight}{23.5cm} % height of main text -\setlength{\topmargin}{-1in} % Subtract default offset -\addtolength{\topmargin}{2.2cm} % Topmargin -\setlength{\topskip}{30pt} % between header and text -%%\setlength{\headheight}{0.0in} % no header -%%\setlength{\headsep}{0.0in} % -\setlength{\hoffset}{-1in} % Subtract default offset -\addtolength{\hoffset}{2.2cm} -\setlength{\evensidemargin}{\paperwidth} -\addtolength{\evensidemargin}{-\textwidth} -\addtolength{\evensidemargin}{-\oddsidemargin} -\addtolength{\evensidemargin}{-2in} -\addtolength{\evensidemargin}{-\hoffset} -\addtolength{\evensidemargin}{-\hoffset} -\addtolength{\oddsidemargin}{-1.5mm} -% - -\usepackage{fancyhdr} -\fancyhf{} -\renewcommand{\headrulewidth}{0pt} -\setlength{\fboxsep}{3mm} -\addtolength{\headwidth}{\marginparsep} -\addtolength{\headwidth}{\marginparwidth} -%\renewcommand{\chaptermark}[1]% -% {\markboth{#1}{}} -%\renewcommand{\sectionmark}[1]% -% {\markright{\thesection\ #1}} - -%define pagenumberbox -\newcommand{\mylthepage}{\colorbox{gray}{\makebox[1.8cm][r]{\color{white}{\bf{\thepage}}}}} -\newcommand{\myrthepage}{\colorbox{gray}{\makebox[1.8cm][l]{\color{white}{\bf{\thepage}}}}} - -%set pagenumber and chapter information -\lhead[\mylthepage]{\bf{\color{gray}{\rightmark}}} -\rhead[\bf{\color{gray}{\leftmark}}]{\myrthepage} -\cfoot{} -\pagestyle{fancy} -\fancypagestyle{plain}{ -\renewcommand{\headrulewidth}{0pt} -\setlength{\fboxsep}{3mm} -%\addtolength{\headwidth}{\marginparsep} -%\addtolength{\headwidth}{\marginparwidth} -%\lhead[\mylthepage]{ } -%\rhead[ ]{\myrthepage} -\cfoot{} -} -% -\makeatletter -\renewcommand\thechapter{\arabic{chapter}} -\def\@makechapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \if@mainmatter - \par\nobreak - \vskip 20\p@ - \fi - \fi - \interlinepenalty\@M - \Huge \bfseries \thechapter\ #1\par\nobreak - \vskip 40\p@ - }} -\makeatother -% + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + PVSGUI + + + + ClientConfigDialog + + + + ClientInfoDialog + + + + AboutDialog + + + + OrgOpenslxPvsInterface + + + + + + + + + + ClientChatDialog + + + + ClientVNCViewer + + + + + OrgOpenslxPvsInterface + + + + + VNCClientThread + + + + ClientFileSendDialog + + + + ClientFileReceiveDialog + + + + + + OrgOpenslxPvsInterface + + + + + OrgOpenslxPvsInterface + + + + + + + ClientFileSendDialog + + + + OrgOpenslxPvsInterface + + + + + + + + + PVS + + + + OrgOpenslxPvsInterface + + + + + Klassendiagramm + + diff --git a/doc/bilder/PVSPrivInputDArchitecture.dia b/doc/bilder/PVSPrivInputDArchitecture.dia new file mode 100644 index 0000000..4278ba7 Binary files /dev/null and b/doc/bilder/PVSPrivInputDArchitecture.dia differ diff --git a/doc/bilder/PhasesOfKeyboardHandling.dia b/doc/bilder/PhasesOfKeyboardHandling.dia new file mode 100644 index 0000000..9250e0b Binary files /dev/null and b/doc/bilder/PhasesOfKeyboardHandling.dia differ diff --git a/doc/bilder/PolicyChainClassDiagram.dia b/doc/bilder/PolicyChainClassDiagram.dia new file mode 100644 index 0000000..3a311f5 Binary files /dev/null and b/doc/bilder/PolicyChainClassDiagram.dia differ diff --git a/doc/bilder/SayHelloHandler-PolicyHier.dia b/doc/bilder/SayHelloHandler-PolicyHier.dia new file mode 100644 index 0000000..341ff41 Binary files /dev/null and b/doc/bilder/SayHelloHandler-PolicyHier.dia differ diff --git a/doc/bilder/UebertragungsEbenen.dia b/doc/bilder/UebertragungsEbenen.dia new file mode 100644 index 0000000..5ae4edb Binary files /dev/null and b/doc/bilder/UebertragungsEbenen.dia differ diff --git a/doc/bilder/clientChatDialog.png b/doc/bilder/clientChatDialog.png new file mode 100644 index 0000000..cab6b26 Binary files /dev/null and b/doc/bilder/clientChatDialog.png differ diff --git a/doc/bilder/clientConfigDialog.png b/doc/bilder/clientConfigDialog.png new file mode 100644 index 0000000..c7e7732 Binary files /dev/null and b/doc/bilder/clientConfigDialog.png differ diff --git a/doc/bilder/clientToolbar.png b/doc/bilder/clientToolbar.png new file mode 100644 index 0000000..e892c0e Binary files /dev/null and b/doc/bilder/clientToolbar.png differ diff --git a/doc/bilder/connectionframe.png b/doc/bilder/connectionframe.png new file mode 100755 index 0000000..ba158b9 Binary files /dev/null and b/doc/bilder/connectionframe.png differ diff --git a/doc/bilder/dum.jpg b/doc/bilder/dum.jpg new file mode 100644 index 0000000..231ffb1 Binary files /dev/null and b/doc/bilder/dum.jpg differ diff --git a/doc/bilder/dum.png b/doc/bilder/dum.png new file mode 100644 index 0000000..9284736 Binary files /dev/null and b/doc/bilder/dum.png differ diff --git a/doc/bilder/mainwindow.png b/doc/bilder/mainwindow.png new file mode 100755 index 0000000..b7ba8c4 Binary files /dev/null and b/doc/bilder/mainwindow.png differ diff --git a/doc/bilder/menu-key.png b/doc/bilder/menu-key.png new file mode 100644 index 0000000..8cec826 Binary files /dev/null and b/doc/bilder/menu-key.png differ diff --git a/doc/bilder/processlist.png b/doc/bilder/processlist.png new file mode 100644 index 0000000..c2e09af Binary files /dev/null and b/doc/bilder/processlist.png differ diff --git a/doc/bilder/pvsmgr.jpg b/doc/bilder/pvsmgr.jpg new file mode 100755 index 0000000..ec5ae30 Binary files /dev/null and b/doc/bilder/pvsmgr.jpg differ diff --git a/doc/bilder/pvsmgrAll.jpg b/doc/bilder/pvsmgrAll.jpg new file mode 100755 index 0000000..a522424 Binary files /dev/null and b/doc/bilder/pvsmgrAll.jpg differ diff --git a/doc/bilder/runprocess.png b/doc/bilder/runprocess.png new file mode 100644 index 0000000..7b2f6bd Binary files /dev/null and b/doc/bilder/runprocess.png differ diff --git a/doc/bilder/siegel-neu.jpg b/doc/bilder/siegel-neu.jpg new file mode 100644 index 0000000..3bb83a9 Binary files /dev/null and b/doc/bilder/siegel-neu.jpg differ diff --git a/doc/bilder/siegel-neu.png b/doc/bilder/siegel-neu.png new file mode 100644 index 0000000..1cff269 Binary files /dev/null and b/doc/bilder/siegel-neu.png differ diff --git a/doc/bilder/studentctlpanel.png b/doc/bilder/studentctlpanel.png new file mode 100644 index 0000000..84930f5 Binary files /dev/null and b/doc/bilder/studentctlpanel.png differ diff --git a/doc/bilder/vnc-frame-buttons.png b/doc/bilder/vnc-frame-buttons.png new file mode 100644 index 0000000..0a0a69d Binary files /dev/null and b/doc/bilder/vnc-frame-buttons.png differ diff --git a/doc/bilder/vnc-frame-buttons.xcf b/doc/bilder/vnc-frame-buttons.xcf new file mode 100644 index 0000000..faf5261 Binary files /dev/null and b/doc/bilder/vnc-frame-buttons.xcf differ diff --git a/doc/build_doc.sh b/doc/build_doc.sh deleted file mode 100755 index c25df82..0000000 --- a/doc/build_doc.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -doxygen doxconf diff --git a/doc/devel/0000-chapter.tex b/doc/devel/0000-chapter.tex new file mode 100644 index 0000000..e69de29 diff --git a/doc/devel/0100-build.tex b/doc/devel/0100-build.tex new file mode 100644 index 0000000..f0e1723 --- /dev/null +++ b/doc/devel/0100-build.tex @@ -0,0 +1,69 @@ +\chapter{Erzeugen und Installieren der Applikation} +\index{Installieren} +Um den Pool Video Switch erfolgreich zu kompilieren, müssen zunächst die Quelldateien heruntergeladen werden. Hierzu sollte auf dem Arbeitsrechner ein Subversion-Client installiert sein. Ein Checkout kann in einem beliebigen Terminal erfolgen, wobei es zwei unterschiedliche Arten des Zugriffs gibt.\\ + +Anonym, nur Leserechte:\\ +\textbf{git clone git://git.openslx.org/pvs.git pvs}\\ + +Mit Account, auch Schreibrechte (hier wird vorausgesetzt, dass der Benutzer vorher seinen öffentlichen SSH-Schlüssel hinterlegt hat):\\ +\textbf{git clone git@openslx.org:pvs.git}\\ + + +\section{Voraussetzungen} +Der Pool Video Switch benötigt zum Kompilieren folgende Pakete (und ihre Abhängigkeiten): +\begin{itemize} + \item libvncserver-dev >= 0.9.3\\ + Eine angenehm kleine, wenn auch in C geschriebene, Bibliothek für die Erstellung von VNC Servern und Clients. + \item libx11-dev >= 1.3.3\\ + Diese Bibliothek wurde eingesetzt, um ausgewählten oder allen Zielrechnern den Zugriff auf Maus und Tastatur zu entziehen und den Bildschirm schwarz zu schalten. + \item libqt4-dev >= 4.5.3\\ + Sowohl die Server als auch die ClientGUI benutzen das Qt Framework in der Version 4. Ferner wird QtNetwork zur Kommunikation zwischen Server und Client benötigt und QtDbus zur Interprozesskommunikation zwischen Client-Daemon und GUI. + \item qt4-dev-tools >= 4.5.3\\ + Dies wird nur benötigt, falls Unterstützung weiterer Sprachen implementiert werden soll, da in diesem Paket das Hilfsprogramm \textbf{linguist} enthalten ist. + \item cmake >= 2.4.0\\ + Eingesetztes Buildsystem und der Makefile-Generator. Um distributionsspezifische Pakete zu erzeugen wird CPack benutzt. + \item libxtst-dev, libxi-dev\\ + Diese Bibliotheken dienen zur Implementierung der Fernsteuerungsfunktionen. +\end{itemize} + +\section{Kompilieren aus Quellen} +Sobald alle Voraussetzungen erfüllt und die Quellen installiert sind, kann das ausführbare Programm erzeugt werden. Falls gewünscht, kann zusätzlich in der Datei \textit{CMakeLists.txt} der Build-Type eingestellt werden. Gültige Werte sind \texttt{Debug} und \texttt{Release} und ihre Wirkung den zwei weiteren Zeilen zu entnehmen. +\begin{verbatim} +SET(CMAKE_BUILD_TYPE Debug) +SET(CMAKE_CXX_FLAGS_DEBUG "-O0 -g -Wall") +SET(CMAKE_CXX_FLAGS_RELEASE "-O3 -march=native") +\end{verbatim} +Damit das Wurzelverzeichnis des Projekts weiterhin sauber bleibt (Übersicht beibehalten, Arbeit mit SVN erleichtern), werden wir hier einen Out-Of-Source Build durchführen. Dies bedeutet, dass zum Kompilieren ein seperates Verzeichnis benutzt wird und sämtliche automatisch generierten Dateien sowie das Kompilat selbst hier abgelegt wird. In einem Terminal sollte nun in das Verzeichnis indem sich das Projekt befindet gewechselt werden, um folgende Befehle ausführen zu können:\\ + +\textbf{mkdir -p build}\\ +\textbf{cd build/}\\ +\textbf{cmake ..}\\ +\textbf{make}\\ + +Die verschiedenen Applikationen können nun folgendermaßen (in \textit{build/}) ausgeführt und getestet werden: +\begin{itemize} + \item Den Server starten: \textbf{./pvsmgr} + \item Den Server mit Touchscreenoberfläche starten: \textbf{./pvsmgrtouch} + \item Den ClientDaemon starten: \textbf{./pvs} + \item Die ClientGUI starten: \textbf{./pvsgui} +\end{itemize} + +\section{Installation} +\index{Paket!RPM} \index{Paket!DPKG} +Nachdem das Projekt kompiliert wurde, kann es (als Superuser z.B. root) auf dem lokalen System installiert werden:\\ +\textbf{make install}\\ + +Dabei werden folgende Dateien auf das aktuelle System übertragen:\\ +\textit{/usr/local/bin/pvsmgr}\\ +\textit{/usr/local/bin/pvs}\\ +\textit{/usr/local/bin/pvsgui}\\ +\textit{/usr/local/bin/pvsmgrtouch}\\ +\textit{/usr/local/share/dbus-1/services/org.openslx.pvs.service}\\ + +Ein Vorteil ist, dass nun ein seperates Ausführen des Client-Daemon nicht mehr notwendig ist. Dieser wird ab sofort automatisch gestartet und beendet, sobald die ClientGUI ausgeführt wurde.\\ + +Es ist ebenfalls möglich, distributionsspezifische Pakete zu erstellen (zur Zeit nur .deb):\\ +\textbf{make package}\\ + +Falls erfolgreich, befindet sich nun eine Installationsdatei (pvs--Linux.deb) in \textit{build/} die z.B. auf Debian-Derivaten mit \textbf{dpkg -i} installiert werden kann.\\ +Anmerkung: Falls Pakete für Rechner gebaut werden sollen, die vom Erstellungssystem her verschieden sind, muß der Schalter \texttt{-march=native} in der Datei \textit{CMakeLists.txt} angepasst werden! diff --git a/doc/devel/0200-gui-lib.tex b/doc/devel/0200-gui-lib.tex new file mode 100644 index 0000000..05730da --- /dev/null +++ b/doc/devel/0200-gui-lib.tex @@ -0,0 +1,31 @@ +\chapter{Eingesetzte GUI-Bibliothek} +\index{QT} \index{GUI} +Die komplette Benutzerschnittstelle des Clients wurde mit Hilfe des von Nokia (früher Trolltech) entwickelten Frameworks Qt in der Version 4 implementiert. Der Grund hierfür sind folgende Vorteile: +\begin{itemize} + \item Qt wird bereits in einer Vielzahl von großen Projekten eingesetzt (KDE, Opera, Skype, Google Earth,...) und ist somit solide und erprobt. + \item Das komplette Framework besteht nicht nur aus einer GUI-Bibliothek sondern beinhaltet noch viele weitere nützliche Module, die bei der Entwicklung ebenfalls zum Einsatz kamen (QtNetwork, QtDBus, Internationalisierung). + \item Qt ist plattformunabhängig: Projekte können für Linux, OSX und Windows erstellt werden + \item Moderne Konzepte und Werkzeuge werden bereitgestellt. So wird das Signal-Slot-Konzept durchgängig eingehalten und mit dem GUI-Builder (\textbf{designer}) können einfach und professionell grafische Interfaces erstellt werden. + \item Duales Lizenzmodell: Qt gibt es sowohl unter einer proprietären Lizenz als auch unter der (L)GPL. +\end{itemize} +Leider unterstützte das bisher eingesetzte Build System (Autotools) Qt nicht vollständig. Dies liegt daran dass Qt zum Erzeugen von Makefiles ein eigenes Werkzeug mitbringt (QMake). Aus diesem Grund wurde eine Umstellung auf das neue CMake durchgeführt. Dies ist nicht nur flexibler als Autotools (plattformunabhängig) sondern auch einfacher in der Einrichtung und Wartung (und wird übrigens vom KDE-Projekt seit der Version 4 eingesetzt). Des Weiteren ist es mit CMake nicht nur möglich Qt-Anwendungen zu erstellen sondern auch die komplette Qt-Toolchain (\textbf{moc}, \textbf{uic}, \textbf{rcc}, \textbf{qdbuscpp2xml}, \textbf{qdbusxml2cpp}, \textbf{lupdate}, \mbox{\textbf{lrelease}},...) komfortabel zu nutzen. So kann z.B. die Interface Erstellung für D-Bus oder das Internationalisieren der Software automatisiert werden. + +\section{Internationalisierung} +\index{Internationalisierung} +Wie oben bereits erwähnt wurde zur Internationalisierung das von Qt4 bereitgestellte System benutzt und mit CMake automatisiert. Der interne Ablauf sieht folgendermaßen aus (\textit{CMakeLists.txt}): +\begin{enumerate} + \item Mit \texttt{SET} werden Variablen mit Quelldateien definiert, die die zu übersetzenden Zeichenketten beinhalten. Diese dienen gleichzeitig zum Kompilieren. + \item Danach werden ebenfalls mit \texttt{SET} Variablen definiert, die später die vom Benutzer zu übersetzenden .ts Dateien enthalten (z.B. \textit{i18n/pvsgui\_de\_DE.ts}). + \item \texttt{QT4\_CREATE\_TRANSLATION} erzeugt im Build-Verzeichnis binäre Internationalisierungs Dateien, die beim Kompilieren eingebunden werden müssen. +\end{enumerate} + +\textbf{Beispiel:} +\begin{verbatim} +SET( PVSGUI_SRCS src/pvsgui.cpp src/gui/clientConfigDialog.cpp ) +SET( PVSGUI_TSS i18n/pvsgui_de_DE.ts i18n/pvsgui_fr_FR.ts ) +QT4_CREATE_TRANSLATION( PVSGUI_QMS ${PVSGUI_SRCS} ${PVSGUI_TSS} ) +ADD_EXECUTABLE( pvsgui ${PVSGUI_SRCS} ${PVSGUI_QMS} ) +\end{verbatim} + +Jede so erzeugte .ts Datei kann nun mit dem Programm \textbf{linguist} von einem Übersetzer bearbeitet werden. Damit die Zeichenketten später während der Ausführung übersetzt werden, müssen diese allerdings mit der Funktion \texttt{QObject::tr()} im Quellcode erzeugt worden sein. + diff --git a/doc/devel/0300-pvs.tex b/doc/devel/0300-pvs.tex new file mode 100644 index 0000000..54fedd4 --- /dev/null +++ b/doc/devel/0300-pvs.tex @@ -0,0 +1,505 @@ +\chapter{Aufbau und Funktionsweise des PVS} +\index{Aufbau} \index{Funktionsweise} \index{Konzept} + +Der Pool Video Switch ist als verteilte Netzwerkapplikation angelegt, die sich aus einer speziellen Steuerkonsole und damit gesteuerten Clients zusammensetzt. Diese kommunizieren untereinander einerseits über ein spezielles Message-Protokoll, verwenden andererseits für bestimmte Aufgaben, wie die Übertragung von Bildinhalten oder Dateien weitere Protokolle wie VNC oder Multicast-IP. + +\section{Einzelne Komponenten} +\index{Komponenten} +Die Steuerkonsole wird durch das Programm pvsmgr, das Client-Backend durch pvs und das Client-Frontend durch pvsgui repräsentiert. + +\subsection{Zuordnung von Konsole und Clients} +\input{devel/0310-service-discovery} + +\section{Überblick über Aktivitäten auf Clients} + +\subsection{Projektion an Alle} +\index{Projektion} +Eine wichtige Eigenschaft des PVS ist die Verwaltung von Projektionen zwischen mehreren Clients. Eine Projektion ist hierbei das Anzeigen des Bildschirminhalts eines Clients - der sogenannten Source oder Quelle - auf einem oder mehreren anderen Clients - den Targets oder Zielen der Projektion. +Die für die Projektion benötigten Verbindungsdaten wie Passwort und IP werden von jedem Client bei der Anmeldung an der Steuerkonsole übermittelt und in einer Liste von PVSConnection Objekten in der Klasse \textit{PVSConnectionManager} gespeichert. Diese zentrale Verwaltung hat mehrere Vorteile: +\begin{itemize} + \item Die Quelle einer Projektion muss keine Aktion ausführen und kann passiv bleiben. + \item Redundanz der Daten wird verhindert, da diese auch in der Steuerkonsole zur Darstellung der Thumbnails benötigt werden. + \item Das Nachrichtenaufkommen wird reduziert, da lediglich eine Nachricht bei der Anmeldung an der Steuerkonsole übermittelt wird. +\end{itemize} + +Bei der Auswahl der Quelle und Ziele ist zu beachten, dass man für jede Projektion jeweils nur eine Quelle jedoch mehrere Ziele auswählen kann. +Quelle und Ziel müssen außerdem verschiedenen Kriterien genügen. +\begin{itemize} + \item Eine Quelle darf nicht gleichzeitig Ziel einer Projektion sein. + \item Ein Ziel einer Projektion darf nicht Ziel einer anderen Projektion sein. + \item Eine Quelle darf mehrfach als Quelle ausgewählt werden. +\end{itemize} +Diese Einschränkungen werden in der Steuerkonsole durchgesetzt, indem im Zielauswahldialog die Zielmenge eingeschränkt wird. +Siehe hierzu auch \ref{pvs-console-projection} Projektion. + +Der Projektionsvorgang an sich besteht aus mehreren Teilen. Wird eine Projektion angefordert, wird überprüft, ob auf der Quelle ein VNC Server gestartet ist. Falls nicht, wird versucht, einen VNC Server zu starten. Ist dies erfolgreich, so sendet die Steuerkonsole das entsprechende Tripel (IP, Passwort und Port der Quelle) an alle ausgewählten Ziele. Clients, welche eine Projektionsaufforderung erhalten, verbinden sich dann mit den Verbindungsdaten zum VNC Server der Quelle. Um die Einstellbarkeit der Qualität einer Projektion zu ermöglichen, kann die Steuerkonsole einen von drei Qualitätswerten an die Zielclients übermitteln. Siehe hierzu auch \ref{pvs-console-quality} Qualitätsoptionen. + + +\subsection{Projektion eines Clients auf dem Beamer} +\index{Beamer} + +Die Projektion eines Clients an den Beamer unterscheidet sich im Wesentlichen nicht von anderen Projektionen. Lediglich ist das Ziel der Projektion hierbei der Dozentenpc bzw. der PC, welcher an den Beamer angeschlossen ist. Eine spezielle Auszeichnung des Beamers erfolgt nicht. Die Anzahl der Ziele wird hierbei nicht beschränkt, da es wünschenswert sein kann, den auf dem Beamer dargestellten Bildschirminhalt auch gleichzeitig auf anderen Clients darzustellen. + +\subsection{Chat- und Informationskanal} +\index{Chat} + +Es gibt 2 Möglichkeiten um Kontakt mit den Clients aufzunehmen. Die erste ist über den Chat, wo Nachrichten sowohl über den offentlichen Kanal als +auch über einen privaten Kanäle verteilt werden können, und die zweite vom PVSManager aus über den Informationskanal. +Der Informationskanal ermöglich das Versenden von Nachrichten, die dringend zu lesen sind, an die Clients. +Im Gegenteil zum Chat erscheinen solche Nachrichten nicht im Chatfenster sondern in einem Pop-Up-Fenster und werden vom Bildschirm entfernt erst wenn man sie +als gelesen markiert durch das Drucken auf dem Knopf \textit{'OK'}. +\\ +\\ +\textbf{Behandlung der Nachrichten im Server} +\\ +\\ +Chat-Nachtichten werden von Server in der Klasse \texttt{PVSConnectionManager} mittels der Methode \texttt{onChat} behandelt. Dort wird aus der Nachrit den Empfänger +und den Absender ausglesen und die Nachricht an beide versendet. So gilt das Empfangen eine eigene Nachricht als Bestätigung, dass die Nachricht ordentlich vom Server +behandelt und versendet wurde. Das Gestalt von solchen Nachrichten sieht folgendermaßen aus + +\begin{center} + PVSMSG +\end{center} +\begin{center} +\begin{tabular}{|l | p{3cm} | p{3cm} | p{3cm}|} +\hline +Type & Ident & Msg & sndID\\ +\hline +\texttt{PVSMESSAGE} & \texttt{} & \texttt{<:} & \texttt{<}\\ +\end{tabular} +\end{center} + +Informationsnachrichten werden ausschließlich vom PVSManager versendet.Dies geschiet in der Klasse \texttt{ConnectionList} mittels der Methode \texttt{on\_Message}. + +\begin{center} + PVSMSG +\end{center} +\begin{center} +\begin{tabular}{|l | l | p{6cm} | p{6cm}} +\hline +Type & Ident & Msg\\ +\hline +\texttt{PVSMESSAGE} & \texttt{BROADCAST} & \texttt{} \\ +\end{tabular} +\end{center} + +Informationnachrichten können außerdem einen oder mehrere Clients sperren, wenn sie den Ident \texttt{LOCKSTATION} enthalten. Sobald ein Client die Nachricht empfängt, +wird diese auf dem Bilschirm angezeigt und 10 Sekunden später wird der Client gesperrt. + +Abgesehen von der Behandlung der Nachrichten muss sich der Server darum kümmern, dass jeder verbunde Client über alle nötige Informationionen verfügt damit er +Nachrichten mit andren Clients austauschen kann. Dies wird folgendermaßen erledigt: +\begin{itemize} + \item \textbf{Einfügen eines Clients:} um die Verwaltung von Clients kümmert sich die Klasse \texttt{PVSConnectionManager}, in der die Methode \texttt{onClientNew} für das Einfügen +von neuen Clients zuständigt ist. Sowald ein neuer Client in der Client-Liste des Servers eingefügt wird, wird an ihn die Liste aller im Server bereits angemeldete +Clients geschickt. Dazu dient die Methode \texttt{sendEventToClients}. + +Bis hier ist der neue Client noch unbekannt für den Rest der Nutzer. Der neuer Client wird erst bekannt gegeben sobald er vom Server einen Benutzername +zugewissen bekommen hat. Da es sein kann, dass den Name, mit dem der neue Client sich beim Server anmelden wollte, +bereits vergeben ist und muss unter Umständen verändert werden. Diese Zuweisung findet in der Methode \texttt{onLoginUsername} statt, +wo nicht nur alle andere Clients sondern auch der neue Client darüber informiert werden. Auch hier kümmert sich die Methoder \texttt{sendEventToClients} +ums Vesenden der entsprechenden Informationen. + + \item \textbf{Entfernen eines Clients:} das Entfernen von Clients wird von der Methode +\\ +\texttt{onClientRemove} erledigt, wo analog wie +Oben alle Clients darüber informiert werden. +\end{itemize} + +Für dei Übermittlung solche Informationen werden Nachrichten mit folgenden Gestal benutzt + +\begin{center} + PVSMSG +\end{center} +\begin{center} +\begin{tabular}{|l | l | p{6cm} |} +\hline +Type & Ident & Msg\\ +\hline +\texttt{PVSMESSAGE} & \texttt{} & \texttt{:} \\ +\end{tabular} +\end{center} + +Es gibt drei unterschiedliche Befehle, die welche Änderung in der localen Client-Liste der Clients vorgenommen werden soll angeben. +\begin{enumerate} + \item \texttt{clientToAdd} +\item \texttt{clientToRemove} +\item \texttt{assignedName} +\end{enumerate} + +Wie es bei Servern gewöhnt ist, werden alle relevante Ereignisse in Log-Dateien protokolliert. Ereignisse werden im Chat-Log mit folgendem +Befehl eingetragen + +\begin{center} +\texttt{ConsoleLog writeChat()} +\end{center} + +\textbf{Chat-Interface der Steuerkonsole} +\\ +\\ +So wie alle Clients ist der PVSManager auch ein Teilnehmer im Chat. Der PVSManager steht wie alle andere Teilnehmer auch in der Nutzer-Liste +jedes Chat-Fenster und kann ebenfalls über private Nachrichten direkt angesprochen werden. Die Arbeitsweise dieser Chat-Interface ist sehr simple. +Da sie sich im Server befindet, müssen einfach alle Ereignise (Nachrichten senden ist die einzige Ausnahme) von der Klasse \texttt{PVSConnectionManager} +an die Klasse \texttt{MainWindow} weitergegeben werden. Dies kümmert sich darum, alle Informationen zu verarbeiten und diesein der Chat-Fenster der +Steuerkonsole anzuzeigen. + +Folgende Methoden der Klasse \texttt{MainWindow} ermöglichen das Anzeigen einer empfangenen Nachricht im Chat-Fenster der Steuerkonsole und Änderungen (Clients einfügen +und entfernen) in der sowohl im Chat-Fenster als auch in der Steuerkonsole angezeigten Client-Liste. +\\ +\\ +\texttt{receiveChatMsg(, , )} +\\ +\texttt{removeConnection(*pvsClient)} +\\ +\texttt{addConnection(*pvsClient)} +\\ +\\ +Alle diese Methoden werden im Gegensatz von der Methode \texttt{sendChatMsg(PVSMsg myMsg)} von der Klasse \texttt{PVSConnectionManager} aus ausgeführt. Da alle durchs +Netz empfangene Nachrichten müssen an die GUI-Weitergegeben werden. Beim Versenden von Nachrichten funktioniert es genau umgekehrt. Die Nachricht wird +vom Nutzer in der GUI eingegeben und muss an die Klasse \texttt{PVSConnectionManager} weitergeleitet werden, damit diese ins Netz gesendet wird. Darum kümmert +sich die Methode in der Klasse \texttt{MainWindow}. +\\ +\\ +\texttt{MainWindow::sendChatMsg(PVSMsg myMsg)} +\\ +\\ +\textbf{Chat-Clients} +\\ +\\ +So weit haben wir die Funtionsweisen des Servers im Bezug auf dem Chat kennengelernt. +Nun wird erläutert wie die einzelnen Clients die Nachrichten bearbeiten. +\\ +\\ +Auf der Client-Seite in der Klasse \texttt{PVSConnectionServer} werden alle Nachrichten des PVS-Protokolls empfangen und gefiltert (Siehe Methode \texttt{handleClientMsg}). +Nachrichten mit dem Ident \texttt{PVSMESSAGE} werden durch den Dispatcher direkt an die Klasse \texttt{PVSChatClient} weitergeleitet, wo die Methode \texttt{receive} feststellen wird, +ob es sich dabei um eine Gespräch-Nachricht oder eine Befehl-Nachricht handelt. Um es feststellen zu können, wird aus der empfangenen Nachricht ein PVSChatMsg-Objekt +erzeugt (siehe Konstruktor) und mittels der Methode \texttt{isCommand} erfährt man ob es sich um einen Befehl handelt oder nicht. +Falls ja leitet der Dispatche die Nachricht an die Stelle \texttt{PVS::UpdateChatClients} sonst an die Stelle \texttt{PVS::chat\_receive}, wo die Änderungen in der Client-Liste +vorgenommen werden oder die Gespräch-Nachricht der GUI abgegeben wird. + +\subsection{Multicast-Dateiversand} +\index{Dateiversand}\index{Multicast} + +Der Multicast-Dateiversand geschieht über die Bibliothek \texttt{OpenPGM}\index{OpenPGM} +(\url{http://code.google.com/p/openpgm/}), die das ,,\textit{Pragmatic General Multicast}''-Protokoll\index{Pragmatic General Multicast} +(PGM)\index{PGM} implementiert. +Darin enthalten ist eine Implementierung der \textit{PGMCC}-Methode zur +Regulierung der Sendebandbreite. +Vorteil der Verwendung einer externen Bibliothek ist, +dass die ,,schwierigen'' Probleme bei der Implementierung einer verlässlichen Datenstrom-orientierten +Multicast-Übertragung bereits von Netzwerkexperten gelöst wurden. + +Die Bibliothek ist in das PVS-System über die interne Bibliothek \texttt{libpvsmcast}\index{libpvsmcast} +eingebunden (der Quellcode findet sich im Verzeichnis \texttt{src/net/mcast}). +Diese stellt mit der Klasse \texttt{McastPGMSocket}\index{Klasse!\texttt{McastPGMSocket}} einen +objektorientierten, ereignisgetriebenen Wrapper zu OpenPGM bereit. +Die Konfigurationsdaten, die zur Einrichtung einer PGM-Verbindung notwendig sind, +sind in der Klasse \texttt{McastConfiguration}\index{Klasse!\texttt{McastConfiguration}} verpackt. + +Auf der nächsten Ebene wird der Versand einer Datei von den Klassen \texttt{McastSender}\index{Klasse!\texttt{McastSender}} +und \texttt{McastReceiver}\index{Klasse!\texttt{McastReceiver}} übernommen. +Diese brechen den Bytestrom der Datei in Pakete auf und formatieren diese wie in Tabelle \ref{tab:mcastpacket} +gezeigt. +\begin{table} +\begin{center} +\begin{tabular}{|l|l|l|} +\hline +\textbf{Format} & \textbf{Feld} & \textbf{Erläuterung} \\ +\hline +\texttt{quint64} & \texttt{magic\_number} & = 0x0x6d60ad83825fb7f9 \\ +\hline +\texttt{quint64} & \texttt{offset} & Position des Datenpaketes in der Datei \\ +\hline +\texttt{QByteArray} & \texttt{data} & Daten \\ +\hline +\texttt{quint64} & \texttt{checksum} & CRC16-CCITT der vorhergehenden Felder \\ +\hline +\end{tabular} +\caption{Paketformat für Multicast-Dateiversand}\label{tab:mcastpacket}\index{Multicast!Paketformat} +\end{center} +\end{table} +Das Paketformat ist mit Hilfe der Qt-eigenen Klasse \texttt{QDataStream} implementiert. +Numerische Felder werden in Netzwerk-Bytereihenfolge übertragen. +Das Ende einer Übertragung wird markiert durch ein Paket, in dessen \texttt{offset} +alle bits gesetzt sind und dessen \texttt{data} die MD5-Prüfsumme der übertragenen Datei +enthält. + +Zur Integration dieser -- prinzipiell von PVS unabhängigen -- Funktionalität +dienen die Klassen \texttt{PVSIncomingMulticastTransfer}\index{Klasse!\texttt{PVSIncomingMulticastTransfer}} +und \texttt{PVSOutgoingMulticastTransfer}\index{Klasse!{PVSOutgoingMulticastTransfer}}. +Diese sorgen hauptsächlich für die Konfiguration der Multicast-Funktionalität mit Hilfe der +PVS-Konfiguration und das Generieren der richtigen Signale einerseits in Bezug auf die Benutzerschnittstelle, +sowie andererseits in Bezug zur Netzwerkkomponente des PVS-Systems. + +Ein Client, der eine Datei per Multicast zu versenden wünscht, wählt zufällig einen Port und +kündigt diesen mit der Nachricht MCASTFTANNOUNCE an. +Falls innerhalb einer festgesetzten Zeit (30 Sekunden) keine MCASTFTRETRY-Nachricht eintrifft, +beginnt die Übertragung. +Die Nachricht MCASTFTCONFIG dient zum Setzen netzwerkweiter Parameter von der Steuerkonsole aus. + +\section{Fernsteuerung} + +Die Fernsteuerung eines Clients erfolgt durch den clientseitigen Empfang von \texttt{PVSCOMMAND}-Nachrichten +mit dem Ident \texttt{INPUTEVENT}. +Dieser ist die Base64-kodierte Binärdarstellung eines Eingabeereignisses angehängt, das +clientseitig nachvollzogen werden soll. +\begin{table} + \begin{tabular}{|l|l|p{4cm}|p{4cm}|} + \hline + \textbf{\texttt{type}} & \textbf{\texttt{code}} & \textbf{\texttt{value}} & \textbf{Beschreibung} \\ + \hline + \multirow{2}{*}{\texttt{ET\_KEY}} & + \texttt{EC\_PRESS} & + \multirow{2}{4cm}{Auslösende Taste und gehaltene Modifikatortasten} & + Taste gedrückt \\ + \cline{2-2}\cline{4-4} + & + \texttt{EC\_RELEASE} & + & + Taste losgelassen\newline \\ + \hline + \multirow{2}{*}{\texttt{ET\_BUTTON}} & + \texttt{EC\_PRESS} & + \multirow{2}{4cm}{Auslösende und + gedrückte Maustasten} & + Maustaste gedrückt \\ + \cline{2-2}\cline{4-4} + & + \texttt{EC\_RELEASE} & + & + Maustaste losgelassen \\ + \hline + \texttt{ET\_POINTER} & + --- & + Absolute Koordinaten & + Mauszeiger bewegt \\ + \hline + \multirow{4}{*}{\texttt{ET\_SPECIAL}} & + \texttt{EC\_REBOOT} & + --- & + Systemneustart \\ + \cline{2-4} + & + \texttt{EC\_KILL\_X} & + --- & + X-Server töten \\ + \cline{2-4} + & + \texttt{EC\_SYSRQ} & + Kommando & + Magic-SysRq-Taste \\ + \cline{2-4} + & + \texttt{EC\_SAY\_HELLO} & + --- & + Harmloses Kommando für Funktionstest \\ + \hline + \end{tabular} + \caption{Mögliche Eingabeereignisse\label{tab:input-events}\index{Eingabeereignis!\texttt{InputEvent}}} +\end{table} +Tabelle \ref{tab:input-events} zeigt die möglichen Eingabeereignisse. +Eingabeereignisse werden durch die PVS Input Library (libpvsinput) behandelt, +deren Funktion an dieser Stelle dargestellt werden soll. + +\subsection{Behandlung eines Eingabeereignisses} +\index{Eingabeereignis!Behandlung} + +Ein Eingabeereignis durchläuft die folgenden Stationen: +\begin{enumerate} + \item Die Steuerkonsole generiert ein Eingabeereignis und übergibt dieses an die Netzwerktransportschicht. + \item Der PVS-Client empfängt das Eingabeereignis und übergibt die Behandlung einer Instanz der + Klasse \texttt{InputEventHandlerChain}\index{Klasse!\texttt{InputEventHandlerChain}}. + \item Die Klasse \texttt{InputEventHandlerChain} arbeitet eine Liste von Instanzen der Klasse + \texttt{InputEventHandler}\index{Klasse!\texttt{InputEventHandler}} der Reihe nach ab, um zu sehen, ob eine dieser Instanzen + das Ereignis bearbeiten kann. + \item Falls die betrachtete Instanz das Ereignis bearbeiten kann, wird geprüft, ob der dafür + nötige Sicherheitskontext vorhanden ist. + \item Falls dies ebenfalls der Fall ist, wird die entsprechende Aktion in einer implementierung + der abstrakten Methode \texttt{InputEventHandler::handle} ausgeführt und die weitere Bearbeitung + beendet. + \item Falls keiner der vorherigen Handler das Ereignis behandelt hat, wird es durch + die Klasse \texttt{PrivilegedHandlerForwarder}\index{Klasse!\texttt{PrivilegedHandlerForwarder}} an den zusätzlichen Daemon \texttt{pvsprivinputd} + weitergegeben. + \item Der \texttt{pvsprivinputd}\index{pvsprivinputd} besitzt ebenfalls eine \texttt{InputEventHandlerChain}, die + nach dem gleichen Muster bearbeitet wird. + Falls hierbei kein passender Handler gefunden wird, wird das Ereignis in eine Logdatei geschrieben + und die Bearbeitung aufgegeben. +\end{enumerate} +Ereignishandler sind implementiert für Maus- und Tastatureingaben unter Linux/X11 (mit Hilfe der XTest-Erweiterung), +sowie zur Simulation von Strg+Alt+Entf, Strg+Alt+Rück und Magic SysRq. + +\subsection{Erweiterungen} + +Weitere Eingabehandler lassen sich der libpvsinput hinzufügen. +Dazu muss eine Klasse bereitgestellt werden, die von der Template-Klasse +\texttt{InputEventHandler} erbt. +Diese akzeptiert eine variable Anzahl\footnote{% + Bis zu 16, diese Zahl lässt sich jedoch durch Neugenerierung + der Datei \texttt{src/input/detail/ typelist\_autogen.h} erhöhen. + Ein entsprechendes Programm ist im Quellcode zu finden.} +von Templateparametern, die verschiedene Aspekte der Eingabeereignisbehandlung konfigurieren. + +Durch die Angabe eines Templateparameters \texttt{input\_policy::Match<\textit{typ}, \textit{code}, \textit{wert}>}\index{Klasse!\texttt{input\_policy::Match}}, +wobei \textit{code} und \textit{wert} weggelassen werden können, wird spezifiziert, +dass der betreffende Handler nur für Eingabeereignisse mit den entsprechenden Feldwerten aufgerufen wird. +Wird kein solcher Parameter angegeben, wird der betreffende Handler niemals aufgerufen. +Mehrere \texttt{Match}-Parameter werden mittels logischem ODER verknüpft. + +Ein Templateparameter der Form \texttt{input\_policy::Require<\textit{Merkmal\dots}>}\index{Klasse!\texttt{input\_policy::Require}} +gibt an, dass dieser Handler nur auf einem System lauffähig ist, das die entsprechenden \textit{Merkmale} +aufweist. +Eine Liste von Systemmerkmalen wird in der Datei \texttt{src/input/detail/systemTraits.h} +zentral verwaltet. +Hier lassen sich neue Merkmale mit Hilfe des Makros \texttt{DEFINE\_SYSTEM\_TRAIT} definieren +und mit Hilfe des Präprozessors zwischen den Zeilen \texttt{BEGIN\_SYSTEM\_TRAITS} und +\texttt{END\_SYSTEM\_TRAITS} einfügen. +Diese Vorgehensweise beschränkt die Nutzung des Präprozessors auf eine Datei. +Wird kein \texttt{Require}-Parameter angegeben, so wird der entsprechende Handler als +immer lauffähig eingestuft. +Mehrere \texttt{Require}-Parameter werden mittels logischem ODER verknüpft. + +Weiterhin kann ein Templateparameter der Form \texttt{input\_policy::Security<\textit{Richtlinie}>}\index{Klasse!\texttt{input\_policy::Security}} +angegeben werden. Hierbei stehen für \textit{Richtlinie} die Klassen \texttt{input\_policy::AllowLocal\-OrPrivileged} +oder \texttt{input\_policy::AllowEverybody} zur Verfügung. +Hierdurch wird bestimmt, welche Sicherheitsanforderungen zur Ausführung des Handlers erfüllt sein +müssen. +Die Richtlinie \texttt{input\_policy::AllowLocalOrPrivileged} bestimmt, dass nur Benutzer, +deren Sitzung lokal ist, oder solche, die nach der Konfiguration des pvsprivinputd als privilegiert +gelten, die entsprechende Aktion aufrufen dürfen (hierbei geht es um den Benutzer, der den PVS-Client +ausführt, und nicht den Benutzer, der die Steuerkonsole bedient). +Die Richtlinie \texttt{input\_policy::AllowEverybody} erlaubt die Ausführung der Aktion ohne +besonderen Sicherheitskontext. +Neue Sicherheitsrichtlinien der Form \texttt{input\_policy::Security<\textit{T}>} lassen sich +nutzen, indem eine Klasse \textit{T} eingeführt wird, die eine Methode\\ +\makebox[1cm]{}\texttt{static bool allow(InputEventContext const*)}\\ +besitzt, an die die Entscheidung, ob eine Aktion zuzulassen ist, delegiert wird. + +Der zu implementierende Eingabehandler braucht weiterhin eine Implementierung der abstrakten +Methode\\ +\makebox[1cm]{}\texttt{virtual void handle(InputEvent const\&, InputEventContext const*)},\\ +in der die entsprechende Aktion ausgeführt wird. + +Die Aufnahme des neuen Handlers in die Liste der abzuarbeitenden Handle erfolgt, +je nachdem ob erweiterte Berechtigungen zur Bearbeitung notwendig sind, +in einer der Dateien \texttt{privilegedHandlerChain.cpp} oder \texttt{unprivilegedHandler\-Chain.cpp} +in \texttt{src/input}, wo dem Kettenaufruf eine Zeile der Form\\ +\makebox[1cm]{}\texttt{.add<\textit{Handler}>()}\\ +hinzugefügt wird. +Die Verwendung des Präprozessors zum Ausschluss von Handlern, die auf dem +Zielsystem nicht lauffähig sind, ist an dieser Stelle nicht notwendig und wird durch die +\texttt{Require}-Richtlinie umgesetzt. +Notwendig ist lediglich, die Übersetzung des Handlers auf inkompatiblen Systemen zu verhindern. +Dies kann mit Hilfe des Build-Systems oder durch die Klammerung der gesamten Übersetzungseinheit +in Präprozessorbedingungen geschehen. + +Eine API-Referenz zur libpvsinput (Stand: 4.~November~2010) findet sich im Projektwiki +unter \url{http://lab.openslx.org/projects/pvs/wiki/RemoteKeyMouse}. + +\section{Prozesse fernsteuern} +\index{Prozesse fernsteuern} + +\subsection{Prozesse starten} +\index{Prozesse!starten} \index{starten} +Das ferngesteuerte Starten von Prozessen funktioniert durch den einfachen Versand eines PVSCOMMAND mit dem dem Ident STARTPROCESS an den Client, der Inhalt des PVSCOMMAND ist in diesem Fall ein durch den Dozenten angegebener Prozess. Der Client versucht diesen Prozess lokal zu starten.\\ +Sollte hierbei ein Fehler auftreten schickt der Client dem Manager ein PVSCOMMAND mit Ident PROCESSES, der Inhalt besteht dann aus der Nachricht START ERROR und einer Zahl, die die Art des Fehlers angibt.\\ +Die Fehlermeldung wird zusammen mit der Information über die Art des Fehlers (Fehlender Prozess/nicht genug Rechte, Crash, Timeout, Read Error, Write Error, Unbekannter Fehler) im Log angezeigt.\\ +Es ist möglich, dass der Dozent sich eine Liste von Prozessen, die er nutzen möchte erstellt und im PVSManager abspeichert, dies geht über den Prozesse starten-Dialog, er zeigt eine Liste an, die die beliebig erweiterbar ist. Einmal getätigte Änderungen werden in der Datei \textit{pvsmgr.conf} abgespeichert. Die Konfigurationsdatei ist nach folgendem Beispiel aufgebaut: +\begin{verbatim} +[RemoteProcessesList] +size=2 +1\command=oowriter +1\description=OpenOffice Writer +2\command=oocalc +2\description=OpenOffice Calc +\end{verbatim} +Hier ist zu beachten, dass size mit 1 beginnt.\\ + +\subsection{Prozesse beenden} +\index{Prozesse!beenden} \index{beenden} +Das ferngesteuerte Beenden von Prozessen funktioniert analog zum Starten durch den Versand eines PVSCOMMAND mit dem dem Ident KILLPROCESS an den Client, hier gibt der Inhalt die lokale PID, des zu beendenden Prozesses an.\\ +Auch hier schickt der Client dem Manager bei einem Fehler ein PVSCOMMAND mit Ident PROCESSES, der Inhalt besteht dann aus der Nachricht STOP ERROR und einer Zahl, die die Art des Fehlers angibt.\\ +Auch hier wird die Fehlermeldung zusammen mit der Information über die Art des Fehlers (Fehlender Prozess/nicht genug Rechte, Crash, Timeout, Read Error, Write Error, Unbekannter Fehler) im Log angezeigt. + +\subsection{Prozesseliste anzeigen} +\index{Prozesse!anzeigen} \index{anzeigen} +Hier sendet der Manager dem Client ein PVSCOMMAND mit Ident SHOWPROCESSES, der Inhalt der Nachricht gibt Prozesse an die herausgefiltert werden sollen. Das PVSCOMMAND mit Ident SHOW und Inhalt clear lässt den Client seine Prozessliste leeren.\\ +Anschließend wird der Inhalt von \textit{/proc/} auf dem Client ausgelesen, ist kein Inhalt vorhanden wird ein PVSCOMMAND mit Ident PROCESSES und Nachricht SHOW ERROR gesendet. Sonst werden sämtliche Ordner in \textit{/proc/} die nur aus Zahlen bestehen durchlaufen. Es wird die Datei \textit{status} ausgelesen um den Namen des Prozesses und die UID des Besitzers zu erhalten. Ist die UID nicht identisch mit der UID des Client wird dieser Prozess verworfen, somit ist sichergestellt, dass nur Prozesse angezeigt werden, bei denen auch tatsächlich die Berechtigung vorhanden ist sie zu beenden. Ist dies der Fall wird außerdem noch ein Teil der Datei \textit{cmdline} ausgelesen. Der Client sendet daraufhin ein PVSCOMMAND mit Ident SHOW und Inhalt PID<\#>Name<\#>cmdline und füllt somit seinen Prozessvektor auf. Ist \textit{/proc} komplett abgearbeitet wird ein PVSCOMMAND mit Ident SHOW und Inhalt finished abgesendet, dies löst ein erneuetes lesen der Prozessliste Managerseitig aus:\\ +Hier wird zu beginn die Prozessliste des Client gelöscht und der Prozessvektor des Clients gelesen. Für jeden Eintrag der Art PID<\#>Name<\#>cmdline wird eine neue Zeile in der Prozessliste geschrieben und PID, Name und cmdline in die jeweiligen Zellen geschrieben.\\ +Prozesse die aus der Liste herausgefiltert werden werden auch in der Datei \textit{pvsmgr.conf} abgespeichert. Eine mögliche Konfigurationsdatei sieht etwa so aus: +\begin{verbatim} +[RemoteProcessesList] +filter=pvs pvsgui pvsmgr +\end{verbatim} + +\section{Netzwerkkommunikation} +\index{Netzwerkkommunikation} + +\subsection{PVS-Protokoll} +\index{Protokoll!PVS} \index{Protokoll} +Im Zuge der Entwicklung des PVS wurde ein sehr einfaches Messagingprotokoll entwickelt. +Die Nachrichten bzw. Messages bestehen dabei aus Header, Nachrichtentyp, Ident und dem eigentlichen Nachrichtentext. Die einzelnen Nachrichtenteile, welche bis auf den Header selbst definiert werden können, werden verknüpft und versendet. Es sind schon Nachrichtentypen vordefiniert, welche sich nur durch unterschiedliche Dispatcher unterscheiden. +Bereits vorhandene Typen sind COMMAND, LOGIN, MESSAGE und UNKNOWN. Die Dispatcher (\_commandDispatcher, \_loginDispatcher und \_chatDispatcher) befinden sich im Client in der Klasse \texttt{ServerConnection}, in der Steuerkonsole in der Klasse \texttt{ClientConnection} bzw. \texttt{ListenServer}. Ein Ident wie z.B. Username, Befehl oder Beschreibung des Nachrichteninhalts dient zur Unterscheidung verschiedener Nachrichten mit demselben Nachrichtentyp, wobei die Nachricht dann den dem Ident entsprechenden Nachrichtentext enthält. +Um eine Funktion zur Behandlung einer bestimmten Nachricht zu definieren, wird diese Funktion als Handler mit dem entsprechenden Dispatcher verknüpft. Im PVS-Client beispielsweise befindet sich der Dispatcher für Nachrichten vom Typ Command in der Klasse \texttt{pvsServerConnection}, daher wird in der Klasse \texttt{pvs} die Funktion \texttt{void PVS::onCommand(PVSMsg cmdMessage)} wie folgt als Handler registriert: +\texttt{\_pvsServerConnection->addCommandHandler("*", this, \&PVS::onCommand)}. Erhält nun der Client eine Nachricht vom Typ COMMAND, so wird die Funktion onCommand mit dem entsprechenden Nachrichtenobjekt aufgerufen. Auf die eigentliche Nachricht kann dann über die Methoden \texttt{getIdent()} und \texttt{getMessage()} des Objektes zugegriffen werden. + +\subsection{PVS-Messages} +\index{Message!PVS} \index{Message} +In Tabelle \ref{tab:messagelist} sind die Messages, die zwischen den einzelnen PVS Komponenenten ausgetauscht werden, aufgelistet. +Der Nachrichtentyp gibt dabei an, welcher Dispatcher die Nachricht behandelt. +Der Ident einer Nachricht wird zur Verarbeitung einer empfangenen Nachricht in der aufzurufenden Funktion benötigt (Unterscheidung von anderen Nachrichten gleichen Typs). + +\begin{table} +\begin{center} +\begin{tabular}{l | l | p{2cm} | p{4cm}} +\label{pvs-msg-liste} +Nachrichtentyp & Nachrichten Ident & Inhalt & Beschreibung \\ +\hline +PVSCOMMAND & PROJECT & hostname port password quality & Hostname, Port, Passwort und Qualität des VNC Servers zu dem verbunden werden soll (durch Space getrennt) \\ +PVSCOMMAND & UNPROJECT & & \\ +PVSCOMMAND & LOCKSTATION & & \\ +PVSCOMMAND & LOCKSTATION & Message & Client mit Nachricht sperren \\ +PVSCOMMAND & UNLOCKSTATION & & \\ +PVSCOMMAND & STARTPROCESS & process & gibt Prozessnamen an der auf Client gestartet werden soll\\ +PVSCOMMAND & KILLPROCESS & PID & gibt ProzessID an von Prozess der auf Client beendet werden soll\\ +PVSCOMMAND & SHOWPROCESSES & filter & weist den Client an seine Prozesse auszulesen und den Prozessvektor zu füllen, filter ist eine Nachricht der Art 'Prozess1 Prozess2 Prozess3', wobei die Prozesse Prozess1, Prozess2 und Prozess3 aus der Liste der laufenden Prozesse ausgeblendet werden\\ +PVSLOGIN & USERNAME & username & Client Benutzername \\ +PVSLOGIN & PASSWORD & password & Serverpasswort \\ +PVSLOGIN & ID & id & \\ +PVSLOGIN & FAILED & "`Wrong Password"' & Wird bei falschem Passwort gesendet \\ +PVSCOMMAND & PORT & port & \\ +PVSCOMMAND & PASSWORD & password & VNC Passwort\\ +PVSCOMMAND & RWPASSWORD & rwpassword & Passwort für den Zugriff auf die Tastatur und Maus \\ +PVSCOMMAND & VNC & YES & Erlaube Zugriff \\ +PVSCOMMAND & VNC & NO & Verbiete Zugriff \\ +PVSCOMMAND & PING & & \\ +PVSCOMMAND & VNCREQUEST & & \\ +PVSCOMMAND & VNCSRVRESULT & result code & Der Rückgabewert des pvs-vncsrv Skripts \\ +\end{tabular} +\end{center} +\caption{Liste der PVS Messages} +\label{tab:messagelist} +\end{table} + +\begin{table} +\begin{center} +\begin{tabular}{l | l | p{2cm} | p{4cm}} +\label{pvs-msg-liste} +Nachrichtentyp & Nachrichten Ident & Inhalt & Beschreibung \\ +\hline +PVSCOMMAND & MCASTFTANNOUNCE & sender transferID basename size port & Ankündigung eines Multicast-Transfer \\ +PVSCOMMAND & MCASTFTRETRY & sender transferID & Rückmeldung: Konfiguration des Multicast-Empfängers fehlgeschlagen, bitte auf anderem Port noch einmal versuchen \\ +PVSCOMMAND & MCASTFTCONFIG & blob & Multicast-Konfiguration aus dem angehängten Binärblob neu laden \\ +PVSCOMMAND & INPUTEVENT & Base64-kodierte InputEvent-Struktur & Fernsteuerung \\ +PVSCOMMAND & PROCESSES & START ERROR errorlevel & errorlevel gibt an, welcher Fehler beim Starten eines Prozesses aufgetreten ist \\ +PVSCOMMAND & PROCESSES & STOP ERROR errorlevel & errorlevel gibt an, welcher Fehler beim Beenden eines Prozesses aufgetreten ist \\ +PVSCOMMAND & PROCESSES & SHOW ERROR & gibt an, dass beim Anzeigen der Prozessliste ein Fehler aufgetreten ist \\ +PVSCOMMAND & PROCESSES & SHOW clear & weist Client an den Prozessvektor zu leeren \\ +PVSCOMMAND & PROCESSES & SHOW finished & weist Manager an, Prozessliste neu zu füllen \\ +PVSMESSAGE & BROADCAST & MESSAGE &\\ +PVSMESSAGE & clientToAdd & & Client hinzufügen (Chat)\\ +PVSMESSAGE & clientToRemove & & Client entfernen (Chat)\\ +PVSMESSAGE & assignedName & & Festgelegter Name (Chat)\\ +\end{tabular} +\end{center} +\caption{Liste der PVS Messages (Fortsetzung} +\label{tab:messagelist} +\end{table} diff --git a/doc/devel/0310-service-discovery.tex b/doc/devel/0310-service-discovery.tex new file mode 100644 index 0000000..307234f --- /dev/null +++ b/doc/devel/0310-service-discovery.tex @@ -0,0 +1,84 @@ +Die Zuordnung von Clients zur Konsole erfolgt halb automatisch über ein +Service-Discovery-Modul. Jede Konsole sendet im Intervall von 7 Sekunden +einen Broadcast ins lokale Subnetz, um ihre Verfügbarkeit bekannt zu geben. +Die Clients können dadurch eine Liste von verfügbaren Servern anzeigen, +aus der der Benutzer nur noch den gewünschten auswählen muss. +Das Intervall sowie die verwendeten UDP-Ports für das Service-Discovery +können vor dem Kompilieren in der \textit{setup.h} festgelegt werden +\begin{verbatim} +#define SB_INTERVAL 7 // Broadcast interval in seconds +#define SD_PORT_CONSOLE 3491 // Not really used, Qt just wants a bind +#define SD_PORT_CLIENT 3492 // This is where we expect announcements +\end{verbatim} +Die zuständigen Klassen sind \textit{PVSServiceBroadcast} (Serverseitig) und +\textit{PVSServiceDiscovery} (Clientseitig).\\ +Auf Seite des Clients erfolgt außerdem eine Kommunikation mit der GUI +über DBus, um verfügbare Sitzungen anzeigen zu lassen, und damit +die GUI den Daemon veranlassen kann, zu einer bestimmten Sitzung +zu verbinden. +Die Methode \textit{connectToSession} in \textit{PVSServiceDiscovery} +ist dafür zuständig, zu einem gegebenem Sitzungsnamen die nötigen +Daten zu ermitteln und eine Verbindung zu initialisieren. + +\subsubsection{Absicherung und Verifikation der Identität} + +Um das Fälschen bzw. Manipulieren von diesen Broadcasts zu verhindern, +sodass es nicht möglich ist, Man-in-the-Middle Angriffe oder ähnliches +durchzuführen, soll gewährleistet werden, dass eine angezeigte Sitzung +auch die ist, für die man sie hält. + +Dafür wird auf das SSL-Protokoll zurückgegriffen. Zum einen bietet SSL +Verschlüsselung für Verbindungen an, und das Qt-Framework hat hierfür +auch schon einige Klassen parat. Zum anderen ist mit SSL durch seine +Zertifikate auch Identitätsverifikation möglich. Dazu kann das Zertifikat +des Servers anhand des Fingerprints auf Echtheit überprüft werden. +Beim Start der Konsole wird also, falls noch nicht vorhanden, ein neues +Serverzertifikat inklusive Schlüsselpaar erstellt, mit welchem Verbindungen +mit Clients fortan verschlüsselt werden. Außerdem wird der Fingerprint des +Zertifikats in den Service-Broadcasts übertragen, sodass die Clients +bereits vor der Verbindung den zu erwartenden Fingerprint kennen. +Somit kann beim Aufbau der Verbindung zur Konsole der Fingerprint +verglichen und eine eventuelle Manipulation erkannt werden. + +Für die Eindeutigkeit ist nur noch eine feste Zuordnung von Sitzungsnamen, +welcher dem Benutzer angezeigt wird, zum Fingerprint der zugehörigen +Konsole notwendig. Dies wird mit Hilfe eines einfachen Algorithmus erreicht, +der aus dem Fingerprint einen lesbaren String erzeugt. Wichtig ist, dass +Konsole und Client hier denselben Algorithmus verwenden, damit der +Dozent an der Konsole den Studenten den korrekten Sitzungsnamen mitteilen +kann. Wird der Algorithmus auf Seite der Konsole verändert, müssen auch +alle Clients aktualisiert werden. Er befindet sich in der \textit{serviceDiscoveryUtil.h} +und heißt \textit{sha1ToReadable}. + +Empfängt der Client einen Broadcast über einen neuen Server, baut dieser +zunächst zur Überprüfung eine Verbindung zu diesem Server auf und sofort wieder +ab, um den Fingerprint überprüfen zu können. Nur wenn dieser mit dem +angekündigten Fingerprint aus dem Broadcast übereinstimmt, wird die Sitzung +dem Benutzer zur Auswahl angezeigt. + +Die Überprüfung geschieht nicht sofort beim Empfang eines Service-Announcements +sondern verzögert in einem Timer, und dabei auch jeweils nur ein Server +in jedem Timer-Aufruf. Dies soll Missbrauch durch gefälschte Broadcastpakete +verhindern oder zumindest stark verlangsamen. Entsprechende Mechanismen gegen +Missbrauch finden sich in \textit{PVSServiceDiscovery::handleDiscovery} sowie +\textit{PVSServiceDiscovery::timerEvent}. + +\subsubsection{Generierung von Sitzungsnamen} + +Hier ist prinzipiell viel Spielraum für Kreativität vorhanden, beachtet werden +sollte lediglich, dass die Zahl der möglichen Namen, die durch den Algorithmus +erzeugt werden können, hoch genug ist, um nicht in kurzer Zeit durch einen +Brute-Force-Angriff einen Fingerprint mit dem selben Sitzungsnamen erzeugen zu +können. Außerdem sollte die Verteilung der zufälligen Namen über den Raum der +möglichen Namen etwa gleichmäßig sein. + +Der momentan verwendete Algorithmus generiert fünfsilbige Wörter, wobei jede +Silbe aus einem Konsonanten und einem Vokal besteht. Die Konsonanten werden +aus einer Liste von 13 Stück ausgewählt, wobei identisch oder zu ähnlich klingende +Konsonanten herausgefiltert wurden, um bei der mündlichen Übertragung keine +Ambiguitäten zu erzeugen. mit einer Wahrscheinlichkeit von 25\% wird einer Silbe +ein \textbf{n} angehängt. Damit sind $130^5 = 37.129.300.000$ (37 Mrd.) +unterschiedliche Sitzungsnamen möglich, was zwar deutlich weniger sind, als bei +einem 160Bit langen SHA1-Hash, allerdings ist dies bezogen auf das Einsatzgebiet +mehr als ausreichend. Alternativ bleibt natürlich nach wie vor das verwenden +alternativer Algorithmen die einen größeren Raum an möglichen Namen haben. \ No newline at end of file diff --git a/doc/devel/0400-pvs-console.tex b/doc/devel/0400-pvs-console.tex new file mode 100644 index 0000000..78574b2 --- /dev/null +++ b/doc/devel/0400-pvs-console.tex @@ -0,0 +1,176 @@ +\chapter{PVS-Steuerkonsole} + +Die Steuerkonsole ist das Hauptquartier des \textbf{Pool Video Switch}. Sie wird auf der Dozentmaschine oder +einer geeigneten weiteren Maschine ausgeführt und sie ist für die Steuerung der Clients-Maschine zuständig. +Alleine diese Rolle der Steuerkonsole setzt schon voraus, dass das GUI so benutzerfreundlich aufgebaut werden soll, +dass diese Aufgabe vereinfacht wird.~\\ + +Wir werden uns in den nächsten Punkten auf den technischen Aufbau der Steuerkonsole fokussieren. +Wir werden als erstes die Auswahl von Qt zum Aufbau des Server-GUI, dann werden wir die GUI Server-Konsole vorstellen und zum +Schluss werden wir die Beziehung Server-Client unter die Lupe nehmen. + +\section{pvsmgr in Qt} +Das Server-GUI wurde in der ersten Version in GTK/Gnome implementiert. Dank der Flexibilität, die von Qt ermöglicht wird, wurde die komplette +Anwendung in Qt umgeschrieben. Qt ist ein User Interface Framework und ermöglicht die Implementierung von Anwendungen, die unter Linux (Unix), Windows, mobile und eingebettete Systemen ausführbar sind. + +\section{GUI Server-Konsole} +Hier sollte die Hauptsteuerung des PVS abgewickelt werden. + +\subsection{Architektur} +Es wird u.a. möglich sein, Funktionen auszuführen wie: die Frame der einzelnen Clients ansehen, ein Profil anlegen, +Screenshot aufnehmen, ein (Un)Projektion ausführen, eine Nachricht an Clients verschicken, usw... Die Grundstruktur +des pvsmgr wird in der Abbildung \ref{fig:pvsmgr} illustriert. Das Bild zeigt uns das Hauptfenster (\textit{MainWindow}) +der Anwendung und seine unterschiedlichen Komponenten:~\\ ~\\ ~\\ ~\\ ~\\ +\begin{figure}[h] + \centering + \includegraphics[width=0.80\textwidth]{bilder/pvsmgr.jpg} + \caption{pvsmgr-Architektur} + \label{fig:pvsmgr} +\end{figure} +\textbf{MainWindow}~\\ +Die Klasse MainWindow wird vom QMainWindow abgeleitet; das ist der Parent an der Spitze der Hierachie; +Sie zu zerstören, bedeutet ein automatisches +Schließen der einzelnen Komponente, also der gesammten Anwendung. Alle anderen Komponenten bauen auf ihr auf. +Die Abbildung \ref{fig:mainwindow} zeigt ihr Abhängigkeitsdiagramm. +~\\ +Alle andere Komponenten (Klasse) der Anwendung haben die Klasse MainWindow als Parent. Qt verwaltet eine Struktur der +Art \textit{parent-child} Beziehung, so dass wenn ein Parent zerstört wird, werden alle seine Kinder (\textit{child}) +automatisch mit zersört; Das ist der sogenannte \textit{Domino-Effekt}. +~\\ +\begin{figure}[h] + \centering + \includegraphics[width=0.80\textwidth]{bilder/mainwindow.png} + \caption{Abhängigkeitsdiagram: MainWindow} + \label{fig:mainwindow} +\end{figure} + + +\textbf{Menubar}~\\ +Diese Klasse enthält eine Liste von \textit{pull-down}-Menu und QMainWindow speichert diese im QMenuBar. Die Klasse +wird also vom QMenuBar abgeleitet. Die gespeicherten Menüs enthalten jeweils die Menu-Items, die nichts anderes als \textit{QAction} sind. +Beim Betätigen einer Aktion (Menü-Item) wird ein korrespondiertes \textit{SIGNAL} gesendet, wir verbinden dann dieses zu einem \textit{SLOTS}, +wie hier gezeigt wird \textit{connect(actionCreate-profile, SIGNAL(triggered()), MainWindow, SLOT(createProfile()))}; Also beim Clicken auf das Menü-Item +"File->Profile manager" wird das Signal \textit{triggered()} gesendet, das automatisch das Slot \textit{createProfile()} aufruft. Genau dieses Prinzip +wird auch auf die Aktionen im Toolbar angewandt. + +\textbf{Toolbar}~\\ +Die Klasse wird vom QToolBatr abgeleitet und enthält eine Liste von Aktionen, die man unmittelbar auf die gesamten +oder die ausgewählten Clients in der ConnectionList anwenden kann. ~\\ ~\\ + +\textbf{ConnectionList}~\\ +Sie enthält die Liste der verbundenen Clients. Sie ist vom QTableView abgeleitet. Die vorhandenen Clients in der Liste können +in unterschiedlichen Bezeichnungen angezeigt werden. Es ist also möglich die Clients unter verschiedenen Sichten anzuzeigen. +Die Clients können mit Name, IP-Adresse oder Username angezeigt werden. Wir entnehmen also, dass das QTableView genauer gesehen +3 Spalten enthält, von denen nur eins davon immer sichtbar wird. Dieses Geschehen lässt sich ganz trivial ausführen. + Man soll lediglich dafür sorgen, dass wenn eine Spalte angezeigt wird, sollen die 2 anderen ausgeblendet werden. +Das QTableView steht zu diesem Zweck die Methode \textit{setColumnHidden(int column, bool hidden)} zur Verfügung, wobei \textit{column} + die betroffene Spaltenummer (die erste Spalte hat den Index 0) ist und \textit{hidden} legt dann fest, ob die Spalte +ein-(\textit{true}) oder ausgeblendet(\textit{false}) bleiben soll. Angesichts des angewandten Selection-Model + (\textit{QItemSelectionModel}) ist es möglich mehrere Clients (\textit{QAbstractItemView::ExtendedSelection}) aufzufassen und +die entsprechenden verfügbaren Aktionen aus dem Tollbar oder der ContexMenu auszuführen.~\\ + +\textbf{ConnectionWindow}~\\ +Die Klasse ist wie der zentrale Widget der Anwendung. Sie ist vom QWidget abgeleitet und enthält die Frame der +jeweiligen verbundenen Clients. Klarerweise hat diese Komponente die MainWindow-Klasse als Parent.~\\ + +\textbf{ConsoleLog}~\\ +Abgeleitet von QTextEdit, hier werden alle Logs angezeigt. Der Log-Bereich ist per Default ausgeblendet. +Man kann ihn aber anzeigen lassen. Man unterscheidet mehrere Arte von Logs: Chat, Error, Normal, Network und Terminal. +~\\ + +Die richtig konfigurierten Clients werden mit dem pvs-Server verbunden und werden auf der GUI Server-Konsole angezeigt. + Der Server bietet 2 unterschiedliche Sichten zur Anzeige der verbundenen Clients an. + +\subsubsection{Clientliste-Ansicht} +Diese Sicht ist eine Liste, die aus einem \textit{QTableview}-Object abgeleitet wird. Die Client-Liste ist definiert +durch die ConnectionList-Klasse die Abbildung \ref{fig:connectionlist} zeigt uns die Abhängigkeitsdiagramm dieser Klasse. +\begin{figure}[h] + \centering + \includegraphics[width=0.80\textwidth]{bilder/ConnectionList.png} + \caption{Abhängigkeitsdiagramm der ConnectionList-Klasse} + \label{fig:ConnectionList} +\end{figure} + +Die Tabelle enthält 3 Spalten, von denen nur eine angezeigt werden kann. Mit Hilfe passender Tastenkombinationen +können die anderen Spalten angezeigt werden. Die Spalten enthalten jeweils den Name der Clients, seine IP-Adresse und seinen Username. Außerdem +haben wir hier ein Kontextmenü per Überschreibung der Methode \textit{mouseReleaseEvent(QMouseEvent * e)} aus der Mutter-Klasse (QTableView) +zur Verfügung gestellt. Das Kontextmenü ist hier im Grunde ein Popup-Menü, das Menü-Item enthält. Diese Menü-Items sind nichts anderes als Actionen +und sie werden behandelt wie wir es schon oben beschrieben haben. Das Popup-Menü wird angezeigt, wenn die rechte Mause-Taste auf einem Item in +\textit{QTableView} losgelassen wird.\\ +Von der jeweiligen Clients in der ConnectionList wollen wir jetzt die entsprechenden VNC-Ansichten vorstellen. + +\subsubsection{VNC-Ansicht} + +Die zweite Anzeigemöglichkeit, die vom Server angeboten wird ist die Anzeige der VNC-Verbindung zwischen +Client und Server. Genauer gesagt, auf dem pvsmgr kann der Dozent jeder Zeit nachvollziehen, was auf der Client-Maschine +passiert, dies wird vom rfb (Remote Frame Buffer) ermöglicht. Zu dem jeweiligen Client wird vom Manager ein \textit{VNCClientThread()} initialisiert +und in dieser Klasse wird der rfb-Client instanziiert. Die Klasse\textit{VNCClientThread()} wird vom QThread abgeleitet, somit wird eine kontinuierliche +Abfrage des Client rfb gesichert. Als QThread kann man mit der Methode \textit{msleep(int updatefreq)} den Thread für eine bestimmte Zeit +(in Millisekunde) schlafen lassen; dies ermöglicht also den pvsmgr die Abfragefrequenz des Client-rfb zu steuern. Darüberhinaus wird +dem Dozent die Möglichkeit gegeben die Qualität der VNC-Qualität jeder Zeit festzulegen. Da es quasi nicht möglich ist, eine VNC-Qualität bei laufender +Verbindung zu ändern, ist es dann notwendig dem Thread der entsprechenden Client zu terminieren und einen neuen mit dem gewünschten +Quality zu starten und danach dem Client diesen neuen Thread wieder zuzuordnen.~\\ +\begin{figure}[h] + \centering + \includegraphics[width=0.80\textwidth]{bilder/connectionframe.png} + \caption{Abhängigkeitsdiagramm der ConnectionFrame-Klasse} + \label{fig:Connectionframe} +\end{figure} +Die VNC-Ströme werden in der ConnectionFrame-Klasse verwaltet. Die ConnectionFrame ist vom QGroupBox abgeleitet. Die Abbildung \ref{connectionframe} +das Abhängigkeitsdiagramm der Klasse. Die Klasse wird vom QGroupBox abgeleitet und enthält das Object QLabel, das die eigentlichen VNC-Ströme +anzeigt, denn QLabel ist im Qt eine optimale Unterstützung zum Anzeigen und zum skalieren von Bildern. Jede ConnectionFrame hat ein Kontextmenü und diese +werden genau so wie wir es in der ConnectionList beschrieben haben, verwaltet. \\ + +Wir fahren mit der Vorstellung der pvsmgr-Struktur fort. Wir wollen uns in den nächsten Punkten der Verbindung zwischen Client und Server +annähen, in dem wir dieser Aushandlung diese Verbindung betrachten. Allerdings werden wir nähere Details darüber in anderen Abschnitten erläutern. + +\subsection{Client-Seite} + +Wir wollen davon ausgehen, dass im Subnetz, indem sich die Client-Maschine befindet, bereits ein pvsmgr gestartet wurde. + Die Abwicklung auf dem server werden wir im nächsten Punkt erläutern. Nach dem Start eines Server sendet dieser eine +Broadcast-Nachricht, die von allen verfügbaren Client erhalten wird. Erhält ein Client diese Nachricht, dann weiß er, +dass ein Server gerade am laufen ist. Anschließend fügt der Client diesen Server in seiner Server-Liste hinzu. +Wird es eine von einen anderen Server gesendetete Broadcast-Nachricht empfangen, wird ebenfalls den entsprechenden +Server in die Server-Liste des Client hinzugenommen. +Der Client verfügt also über eine Liste von potentiellen Server, mit denen er eine PVS-Verbindung aufbauen kann, die dann schließlich +eine VNC-Verbindung wird und erst dann kann die Remote Frame Buffer initialisiert werden. Verläuft diese Initiliasierung erfolgreich, wird bei dem Server +der VNC-Frame angezeigt. +Aus seiner Server-Liste kann der Client freiwillig den Server auswählen, mit dem er sich verbinden möchte. Allerdings +erfolgt die eigentliche Verbindung zwischen Server und Client erst, nachdem der Client das vom Dozent gesetzte Passwort +richtig eingegeben hat. Beim Start des Server wird vom System ein zufälliges Passwort generiert und der Dozent soll dieses den Client +im Raum bekanntgegeben, so dass ein anderer Client, der im Nebenraum steht und auch die Server-Broadcast-Nachricht erhalten hat, +keine M{\"0}glichkeit hat, mit diesem Server eine Verbindung aufbauen zu können. +%Die genaue Spezifikation der Abwicklung der Verbindung zwischen und Client und Server kann in ServAppTech und in Service-Discovery entnommen werden. +Also nun hat ein Client das richtige Passwort eingeben und die Verbindung mit dem Server konnte erfolgreich aufgebaut werden. An dieser Stelle wollen +wir noch betonen, dass der Dozent selbst entscheiden kann, ob ein Passwort zum Verbindungsaufbau mit dem PVS-Server vom Client aus eingegeben werden +soll oder nicht. Dafür wird eine Checkbox auf dem pvsmgr-GUI eingebaut, die beim Ankreuzen per SIGNAL-SLOT die Funktion +\textit{PVSConnectionManager::getManager()->setNeedPassword(bool needed)} aufruft, wobei mit \textit{needed=TRUE} wird ein Passwort benötigt. \\ +Nun wollen wir erläutern wie der Server mit einer bestehenden Verbindung umgeht.~\\ + +\subsection{Server-Seite} + +Wir hatten schon erwähnt, dass der Server 2 Ansichtsmöglichkeiten zur Annzeige eines verbundenen Client verfügt. +Nachdem ein Client mit dem Server eine Verbindung erfolgreich aufgebaut hat, wird fast zeitgleich erstmal der Client +links in der Connection-Liste angezeigt und dann wird eine VNC-Verbindung zwischen Client und Server so aufgebaut, dass auf der rechten +Seite (\textit{Connectionwindow}) das Client-Frame angezeigt werden kann. Jeder Frame wird so beschriftet, +dass es jeder Zeit möglich wird, aus einem Client in der Liste (links) den entsprechenden Frame (recht) anzuordnen.\\ + +Somit hat der Server einen besseren {\"U}berblick über die gesamten vorhandenen Verbindungen. Der Server kann also jegliche verfügbare + Aktion ausführen. Der Betreiber (der Dozent) des pvsmgr verfügt über eine zweite Maschine, die an einen Beamer angeschlossen +wird und auf dieser Maschine läuft ein PVS-Client. Dieser Client wird als \textit{Superclient} bezeichnet und verfügt dementsprechend gegenüber anderen Clients über einen Sonderstatus. Z.B: bei einer LockAll-Aktion wird er nicht gesperrt und dabei muss geachtet werden, dass ein auf dem Superclient projektierter Client auch nicht gesperrt wird. + +\section{Verbindungsverwaltung und Projektion} + +Meldet sich ein Client an der PVS-Steuerkonsole an, wird der Bildschirminhalt des Clients zur Thumbnail Darstellung angefordert. Hierzu sendet der Client seine Verbindungsdaten, d.h. Passwort, RW Passwort und Port, an die Steuerkonsole (s.h. Liste der PVS Messages \ref{pvs-msg-liste}). Die Verbindungsdaten werden in der Klasse \texttt{pvsConnectionManager} in einer Liste \texttt{std::list \_listClients} von PVSClient Objekten verwaltet. Ein solches Clientobjekt enthält unter anderem Port, Passwort, RW Passwort sowie Flags, ob eine VNC Verbindung erlaubt ist, ob ein VNC Passwort vorhanden ist, und ob der Client gerade projeziert wird (siehe hierzu auch \texttt{/core/pvsClient.h}). Der pvsConnectionManager wird in allen Klassen verwendet, welche auf die Verbindungsdaten der Clients zugreifen müssen, daher ist er als Singleton implementiert und auf die entsprechende Instanz kann über \texttt{PVSConnectionManager::getManager()} zugegriffen werden. + +\subsection{Projektion} +\label{pvs-console-projection} +Um zu gewährleisten, dass bei einer Projektion ein als Quelle ausgewählter Client nicht als Ziel einer Projektion gewählt werden kann, werden in der Klasse \texttt{ConnectionList} +eine Liste \texttt{QList targetList} mit den Projektionszielen und eine Map \texttt{QMap > sourceMap} mit der Quelle und der zugehörigen Liste von Zielen geführt. Wird ein Client als Projektionsquelle ausgewählt, wird zunächst überprüft, ob dieser Client schon in der Liste der Projektionsziele vorhanden ist. Ist er nicht vorhanden, wird ein Auswahldialog \texttt{projectionDialog} mit allen verfügbaren Projektionszielen angezeigt (ProjectionDialog erhält die entsprechende Liste durch\\ \texttt{MainWindow::getWindow()->getConnectionList()->getTargetToDisplay(source)}). Projektionsziele können hierbei alle angemeldeten Clients sein, die nicht Ziel oder Quelle einer anderen Projektion sind. Die Auswahl der Ziele im \texttt{projectionDialog} erfolgt durch Checkboxen. Die hierdurch gewählten Clients werden zurück an die den \texttt{projectionDialog} aufrufende Klasse übergeben. Nachdem Quelle und Ziel ausgewählt wurden, wird die Funktion \texttt{projectStations}, welche zunächst prüft, ob auf dem Quell-Client überhaupt ein VNC Server läuft, in der Klasse \texttt{ConnectionWindow} mit dem Quell-Client als Parameter aufgerufen. Ist ein VNC Server gestartet, so werden die Verbindungsdaten des Quell-Clients, die über die get-Methoden des entsprechenden PVSClient Objekts ausgelesen werden, an alle Ziel-Clients als durch Leerzeichen separierte Liste gesendet. Auf Clientseite werden diese Verbindungsdaten dann in ein Array transformiert und an den \texttt{clientVNCViewer} übergeben (via DBus). +Soll ein Client als Ziel zu einer existierenden Projektion hinzugefügt werden, wird der entsprechende Quellclient und alle neuen bzw. zusätzlichen Projektionsziele gewählt. Die Zielclients werden dann einfach der in der \texttt{sourceMap} gespeicherten Liste der Quelle sowie der \texttt{targetList} hinzugefügt. +\subsubsection{Qualitätsoptionen} +\label{pvs-console-quality} +Zusätzlich zu den Verbindungsdaten werden Qualitätsoptionen zu der gesendeten Nachricht hinzugefügt. Die Qualitätsoption ist ein Integerwert 0,1 oder 2 wobei 0 der besten Qualität, 2 der schlechtesten Qualität entspricht. Dieser Wert wird an den Zielclient einer Projektion gesendet, welcher die Qualitätseinstellungen des VNC-Viewers entsprechend anpasst. Aktuell wird die Qualität immer auf 0 gesetzt, da noch die Einstellungsmöglichkeiten in der GUI fehlen. +\subsection{Remote Help} + +Remote Help funktioniert analog zur Projektion, jedoch ist hier zu gewährleisten, dass jeweils nur ein Quellclient und ein Zielclient ausgewählt werden, da es nicht sinnvoll ist, Tastatur und Maus eines Clients von mehreren anderen Clients aus zu steuern. Anstelle des Passworts wird das RW-Passwort des Clients verwendet. Die Möglichkeit, die Maus und die Tastatur eines Clients zu steuern, ist mit dem verwendeten VNC-Server schon gegeben, für die Steuerkonsole ändert sich hier nichts, lediglich der VNC Viewer muss die Tastatureingaben und die Mausbewegung an den VNC Server weitergeben (siehe hierzu auch \ref{pvsclient-remotehelp} Tastatur und Maussteuerung). \ No newline at end of file diff --git a/doc/devel/0500-pvs-client.tex b/doc/devel/0500-pvs-client.tex new file mode 100644 index 0000000..bbca766 --- /dev/null +++ b/doc/devel/0500-pvs-client.tex @@ -0,0 +1,243 @@ +\chapter{PVS-Client} +Der PVS-Client ist in ein Backend (\textbf{pvs}) und ein Frontend (\textbf{pvsgui}) aufgeteilt. Erster läuft als Daemon im Hintergrund und kommuniziert über ein gegebenes Netzwerk mit der Steuerkonsole (\textbf{pvsmgr}). Die Interprozesskommunikation (inter-process communication, IPC) zwischen Back- und Frontend erfolgt über D-Bus und wurde mit Hilfe der von Qt4 bereitgestellten Bibliothek QtDBus realisiert. Um das Backend von einer GUI komplett unabhängig zu halten, wurde darauf geachtet, dass alle Nachrichten, die an die GUI gerichtet sind, vom Backend als Signale über D-Bus verteilt werden. Umgekehrt, wenn das Frontend eine Nachricht an das Backend schicken will, muss es sich der im Backend implementierten Slots bedienen (s. Abbildung \ref{pdf:dbus}). Somit ist es sogar möglich, dass mehrere GUIs gleichzeitig ein und das selbe Backend benutzen. Ein weiteres Feature ist, dass das Frontend beim Start das Backend durch einen D-Bus Aufruf automatisch startet. Hierzu muss allerdings die Applikation zuvor mit \textbf{make install} auf dem System installiert worden sein.\\ + +\begin{figure} + \begin{center} + \includegraphics[scale=0.7]{bilder/DBus} + \caption{Back- und Frontend des PVS-Clients kommunizieren über D-Bus} + \label{pdf:dbus} + \end{center} +\end{figure} +Zunächst muss in der Hauptklasse des Backends (\textit{pvs.cpp}) das Qt-Makro +\begin{verbatim} +Q_CLASSINFO("D-Bus Interface","org.openslx.pvs") +\end{verbatim} +eingefügt werden, um dem späteren D-Bus-Interface einen Namen zu geben. Als nächstes werden alle zu exportierenden Slots wie gewohnt mit \texttt{Q\_SLOTS} bzw. Signale mit \texttt{Q\_SIGNALS} in der \textit{pvs.h} gekennzeichnet. Schließlich folgen ein paar Definitionen in der \textit{\mbox{CMakeLists.txt}}, deren Bedeutung aus den Kommentaren entnommen werden kann: +\begin{verbatim} +# QtDBus Modul aktivieren +SET( QT_USE_QTDBUS TRUE ) +# Signale und Slots aus pvs.h ins XML-Format exportieren +QT4_GENERATE_DBUS_INTERFACE( src/pvs.h org.openslx.pvs.xml ) +# D-Bus Adapter für Backend erzeugen +QT4_ADD_DBUS_ADAPTOR( PVS_SRCS ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml + src/pvs.h PVS ) +# Aus der zuvor erstellten XML-Datei ein Interface in C++ Syntax +# generieren +QT4_ADD_DBUS_INTERFACE( PVSGUI_SRCS + ${CMAKE_BINARY_DIR}/org.openslx.pvs.xml pvsinterface ) +\end{verbatim} +Sind die Vorbedingungen erfüllt, wird beim ersten Kompilieren eine Datei namens \textit{pvsinterface.h} erstellt, in der die Definition der Klasse \texttt{\mbox{OrgOpenslxPvsInterface}} gespeichert wurde. Diese Klasse kann nun in anderen Programmen (wie z.B. in der \textbf{pvsgui}) dazu benutzt werden, um Zugriff auf die freigegebenen Ressourcen des Backends zu erhalten. + +\section{Grafische Benutzeroberfläche} +Die Hauptklasse der Benutzeroberfläche des Clients heißt \texttt{PVSGUI} und befindet sich in der Datei \textit{pvsgui.cpp}. In dieser werden Referenzen auf alle benutzten Dialoge, das System Tray Icon sowie das D-Bus Interface zur Kommunikation mit dem Backend erzeugt. Weiter beinhaltet diese Klasse die \texttt{main()}-Funktion und bildet somit den Einstiegt für das Betriebssystem. Damit der Zugriff auf die Toolbar immer gewährleistet bleibt (auch wenn Videos oder eine virtuelle Maschine im Vollbild laufen), muss beim Zeichnen dieser der laufende Windowmanager umgangen werden. Hierbei hilft uns Qt mit der Anweisung: +\begin{verbatim} +setWindowFlags(Qt::WindowStaysOnTopHint|Qt::X11BypassWindowManagerHint); +\end{verbatim} +Wie bereits in der Einleitung erwähnt, wird das komplette Projekt mit Hilfe von CMake erstellt. Aus diesem Grund soll an dieser Stelle ebenfalls eine kleine Beschreibung folgen, wie man mit CMake Qt-Klassen einbindet, die mit dem Qt-Werkzeug \textbf{designer} erstellt worden sind. Als Beispiel dient die Klasse \texttt{PVSGUI}, wobei wir hier nicht auf die Qt eigenen Details eingehen werden. +\begin{verbatim} +# CMake anweisen, Qt4 auf lokalem System zu suchen +FIND_PACKAGE( Qt4 4.5.0 REQUIRED ) +INCLUDE( ${QT_USE_FILE} ) +# Sowohl Quell- als auch Zielverzeichnis auf Quelldateien durchsuchen +INCLUDE_DIRECTORIES( ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR} ) + +# Alle von der Software benötigten Quelldateien +SET( PVSGUI_SRCS src/pvsgui.cpp ) +# Vom Meta Object Compiler benötigte Header-Dateien +SET( PVSGUI_MOC_HDRS src/pvsgui.h ) +# Auflistung aller benötigten .ui Dateien +SET( PVSGUI_UIS src/gui/ui/clientToolbar.ui ) +# Ressourcendateien +SET( PVSGUI_RCS pvsgui.qrc ) + +# Qt Meta Object Compiler ausführen (moc) +QT4_WRAP_CPP( PVSGUI_MOC_SRCS ${PVSGUI_MOC_HDRS} ) +# Qt User Interface Compiler ausführen (uic) +QT4_WRAP_UI( PVSGUI_UI_HDRS ${PVSGUI_UIS} ) +# Qt Resource Compiler ausführen (rrc) +QT4_ADD_RESOURCES( PVSGUI_RC_SRCS ${PVSGUI_RCS} ) + +# Applikation mit allen benötigten Variablen bauen +ADD_EXECUTABLE( pvs ${PVS_SRCS} ${PVS_MOC_SRCS} ${PVS_RC_SRCS} ) +# Mit der Qt-Bibliothek linken +TARGET_LINK_LIBRARIES( pvsgui ${QT_LIBRARIES} ) +\end{verbatim} + +\section{User-Interface für Benutzerkonfiguration} +Der eingebaute Konfigurationsdialog besteht hauptsächlich aus der Klasse \texttt{ClientConfig\-Dialog} und ist in der Datei \textit{clientConfigDialog.cpp} definiert. Es handelt sich hierbei um einen gewöhnlichen \texttt{QDialog}, dessen graphische Implementierung in der Datei \textit{clientConfigDialog.ui} gespeichert ist.\\ +Den Kern dieser Klasse bildet ein \texttt{QSettings} Objekt, das sowohl zum Speichern als auch zum Laden der Benutzerkonfiguration benutzt wird. Ablage aller Einstellungen ist die Datei \textit{\textasciitilde/.config/openslx/pvsgui.conf}. Diese kann jedoch zentral für die gesamte Applikation in der Funktion \texttt{PVSGUI::main(int argc, char *argv[])} geändert werden.\\ +Um weitere Komponenten der GUI über Änderungen der aktuellen Konfiguration zu informieren, wird das Signal \texttt{configChanged()} emittiert. + +\section{Darstellung von VNC-Datenströmen} +\label{pvsclient-datenstrom} +Die übertragenen Bildinformationen können in einem separaten Fenster oder im Vollbildmodus dargestellt werden. Hierzu wählt der Dozent über die Steuerkonsole (\textbf{pvsmgr}) eine Quelle und ein oder mehrere Ziele zur Projektion aus, was zur Folge hat, dass an alle gewählten Clients (\textbf{pvs}) eine Nachricht mit den benötigten Informationen geschickt wird. Als nächstes sendet das Backend ein Signal über D-Bus an sein Frontend, das die benötigten Informationen (Host, Port, Passwort, Qualität) enthält. Somit kann nun die GUI eine Verbindung zum gegebenen VNC-Server aufbauen und den Datenstrom darstellen.\\ + +Der Aufbau des VNC-Viewers besteht aus zwei Klassen: +\begin{itemize} + \item Die Klasse \texttt{VNCClientThread} stellt mit Hilfe eines \texttt{rfbclient} (aus libvncserver0) eine Verbindung zum VNC-Server her. Zunächst werden sämtliche Verbindungsparameter über den Konstruktor definiert und nach einem Aufruf von \texttt{VNCClientThread::start()} eine Verbindung aufgebaut. Da diese Klasse selbst von \texttt{QThread} abgeleitet ist, läuft sie in einem eigenständigem Thread, um die GUI nicht zu blockieren. Der Informationsaustausch erfolgt über das Signal \texttt{VNCClientThread::imageUpdated(int x, int y, int w, int h)}, welches die Koordinaten einer Änderung des Framebuffers enthält. + \item Die Darstellung des Datenstroms wird von der Klasse \texttt{ClientVNCViewer} übernommen. Da beide Klassen auf ein und den selben Ressourcen arbeiten, müssen die Signale des \texttt{VNCClientThread} mit dem Parameter \texttt{Qt::BlockingQueuedConnection} verbunden werden. Dies stellt sicher, dass der Thread solange pausiert, bis der Slot des \texttt{ClientVNCViewer} abgearbeitet wurde (\texttt{ClientVNCViewer::updateImage(int x, int y, int w, int h)}). +\end{itemize} +Bei der Entwicklung des VNC-Viewers musste stark auf die Performanz geachtet werden. Das Ziel ist es, sowohl Bandbreite als auch CPU-Last einzusparen. Um die Netzwerkauslastung konfigurierbar zu machen, stehen drei Qualitätsstufen zur Wahl, von denen eine gewählt werden muss. Durch diese serverseitige Konfiguration wird beispielsweise auf der niedrigsten Qualitätsstufe die Farbtiefe verringert und die Kompressionsstufe erhöht (verlustbehaftet), was die zu übertragenen Bildinformationen minimiert. Um den Prozessor des Zielrechners nicht unnötig zu belasten, werden wie im VNC-Protokoll vorgesehen, nur die Bereiche des Framebuffers neu gezeichnet und skaliert, die sich auch geändert haben. + +\section{Chat-Interface} +Die vom Chat-Interface verwendeten Klassen und Dialoge befinden sich in den Dateien \textit{clientChatDialog.cpp} und \textit{clientChatDialog.ui}. Der Informationsaustausch erfolgt hier wieder über D-Bus direkt mit dem Backend.\\ +Zum Versenden einer Nachricht wird der Slot \texttt{PVS::chat\_send()} und zum Empfang das Signal \texttt{PVS::chat\_receive()} des Backends benutzt. Um die Liste aller Chatteilnehmer aktuell zu halten, wird analog vorgegangen. Hierzu existieren die Slots \texttt{PVS::chat\_client\_add()} und \texttt{PVS::chat\_client\_remove()}.\\ +Um neben dem öffentlichen Chat auch private Unterhaltungen zwischen zwei Teilnehmern zu ermöglichen, wurde ein \texttt{QTabWidget} benutzt. Auf diesem wird bei jeder neu begonnenen Unterhaltung ein \texttt{QTextEdit} platziert, dass dem Gesprächspartner durch ein \texttt{QHash} direkt zugeordnet wird. + +\section{Dateiübertragung und Interface} +Die graphische Benutzerschnittstelle des Clients ermöglicht allen Chatteilnehmern binäre Dateien untereinander zu tauschen. Dazu wurden zwei Dialoge entwickelt -- einer zum Senden und einer zum Empfang. Diese Dialoge stellen nicht nur das Benutzerinterface dar sondern bilden ebenfalls die komplette Grundlage (Client-Server) zur Übertragung binärer Daten. Die hierfür entworfenen Klassen sind \texttt{ClientFileSendDialog} und \texttt{ClientFileReceiveDialog}, zu denen die gleichnamigen .ui Dateien gehören.\\ + +Daten senden:\\ +Um eine Datei zu senden, sind der Name des Chatteilnehmers (Nickname) sowie der Pfad der zu sendenden Datei erforderlich. Falls diese Informationen nicht vorhanden sind, wird der Benutzer durch Pop-Ups danach gefragt. Der nächste Schritt besteht darin, die IP bzw. den Hostnamen des Chatteilnehmers zu erfragen. Dies geschieht automatisch, indem das Backend (\textbf{pvs}) diesbezüglich über D-Bus befragt wird. Stehen alle Angaben zur Verfügung, wird an den Zielrechner ein kleiner Header mit folgenden Informationen geschickt: +\begin{verbatim} +Nickname_des_Senders;Dateiname;Dateigröße\n +\end{verbatim} +Sollte sich der Kommunikationspartner für den Empfang der angebotenen Datei entscheiden, wird von diesem eine Bestätigung verschickt (ack), die den eigentlichen Übertragungsvorgang startet. Das Ende der Übertragung wird dem Empfänger durch das Schließen des benutzen Sockets signalisiert.\\ +Während der Übertragung wird ein Dialog angezeigt der den Sender über den Fortschritt mit Hilfe einer \texttt{QProgressBar} informiert. Der Vorgang kann jederzeit abgebrochen werden und über aufgetretene Fehler wird durch Pop-Ups informiert.\\ + +Daten empfangen:\\ +Sobald die graphische Benutzeroberfläche des Clients startet, wird durch eine Instanz des \texttt{QTcpServer} der Port 29481 geöffnet und auf eingehende Verbindungen gewartet. Wird nun von einem anderen Teilnehmer eine Datei angeboten, so wird eine Instanz des \texttt{ClientFile\-ReceiveDialog} angelegt, die sich um den weiteren Verlauf kümmert. Der Empfänger kann nun, die Übertragung akzeptieren und einen Speicherort wählen. Danach wird eine Bestätigung an den Sender verschickt und die eigentliche Datenübertragung gestartet.\\ +Auch der Empfänger wird durch einen Dialog über den Fortschritt informiert und kann die Übertragung jederzeit abbrechen.\\ + +Wichtig an dieser Stelle ist die Speicherfreigabe beendeter Übertragungsdialoge. Da wir gleichzeitig beliebig viele Übertragungen erlauben wollen, muss natürlich für jede ein eigenständiger Dialog erzeugt werden. Um keine Liste mit laufenden Dialogen führen zu müssen (und einzelne zu löschen) wird hier auf einen komfortablen Qt-Mechanismus zurückgegriffen. Sobald ein Dialog mit \texttt{accept()} oder \texttt{reject()} beendet wird, sendet dieser das Signal \mbox{\texttt{finished(int)}}. Auf der anderen Seite besitzt jede Klasse, die von \texttt{QObject} abgeleitet wurde, den Slot \texttt{deleteLater()}. Die Qt-API garantiert, dass Qt nach dem Aufruf dieser Methode dieses Objekt selbstständig aus dem Speicher entfernt. Also müssen wir dieses Signal dem Slot zuordnen (in \texttt{ClientFileSendDialog} und \texttt{ClientFileReceiveDialog}): +\begin{verbatim} +connect(this, SIGNAL(finished(int)), this, SLOT(deleteLater())); +\end{verbatim} + +\section{VNC Server} +Um den Bildschirminhalt von Clients zum einen in der Übersicht (Thumbnails) der Steuerkonsole und zum anderen auf anderen Clients und dem Beamer darstellen zu können, wird das sogenannte Remote Framebuffer Protokoll (RFB), welches auch der Virtual Network Computing (VNC) Software zugrundeliegt, benutzt. Um VNC bzw RFB nutzen zu können, wird ein VNC Server und ein VNC Viewer benötigt. Aktuell wird als VNC Server \texttt{x11vnc} verwendet sowie der, wie in \ref{pvsclient-datenstrom} beschrieben, in den den PVS-Client integrierte rfbclient bzw. ClientVNCViewer. Bei der VNC Verbindung wird zwischen einer Verbindung ohne Maus und Tastatursteuerung, dem sogenannten Viewonly oder Readonly Modus, und einer Verbindung mit Maus und Tastatursteuerung, im folgendenden Read-Write (RW) Modus genannt, unterschieden. + +\subsection{Vergleich von VNC Servern} +Es gibt zwei Arten von VNC Servern. Server, die eine laufende Sitzung bzw. ein vorhandenes Display darstellen bzw. übermitteln können, und Server, die eine eigene Sitzung bzw. ein eigenes Display bereitstellen (virtuell). Für PVS ist die zweite Art, welche auf dem ursprünglichen VNC basiert, nicht verwendbar, da man hierbei nicht den aktuellen Bildschirminhalt der Clients in der Steuerkonsole anzeigen bzw. projezieren kann. Daher wurden folgende VNC Server im Weiteren nicht betrachtet: Xvnc (RealVNC), vnc4server, TightVNC. + +Motivation für den eigentlichen Vergleich ist die Integration mancher VNC Server in die Desktopumgebung. Hier müsste der x11vnc nicht extra installiert werden. Wichtig für den Einsatz im PVS ist vor allem die Unterstützung von Shared Modus, d.h. mehrere VNC Viewer können sich gleichzeitig mit dem VNC Server verbinden, und Forever Modus, d.h. der VNC Server wird nicht nach Trennung des letzten Clients beendet. Sicherheitsoptionen wie die Vergabe von Passwörtern und die Unterscheidung von RW und Viewonly Modus sind ebenso nicht zu vernachlässigen. + +\paragraph{Vino} +\begin{sloppypar} +~\\ +Vino ist der VNC Server der Gnome Desktopumgebung. +Er wird standardmäßig über die graphische Oberfläche \textbf{vino-preferences} konfiguriert. Über die Kommandozeile ist Vino entweder über \textbf{gconftool-2} oder über direktes editieren der Datei \\ +\textit{\~{}/.gconf/desktop/gnome/remote\_access/\%gconf.xml} konfigurierbar. +Parameter können nicht übergeben werden, was die Verwendbarkeit im PVS einschränkt. +Vino benutzt standardmäßig den Port 5900, um auf eingehende Verbindungen zu warten. Dieser Port kann nur durch +\texttt{gconftool-2 -s -t int \/desktop/gnome/remote\_access/alternative\_port } bzw. das Einfügen von z.B. +\texttt{''/>} +in die entsprechende \%gconf.xml Datei geändert werden. Hierbei ist zu beachten, dass nicht überprüft wird, ob der entsprechende Port schon belegt ist. Dementsprechend wird auch kein anderer freier Port gewählt. +Außerdem wird eine Änderung des Ports erst nach dem Neustart der grafischen Oberfläche aktiv. +Vino unterstützt die Vergabe eines Passworts, welches base64 kodiert in der gconf Datei abgelegt wird. Ebenso kann man den Zugriff auf den Viewonly Modus beschränken. Unterschiedliche Passwörter für den RW Modus und den Viewonly Modus können jedoch nicht vergeben werden. Der Shared und Forever Modus sind standardmäßig aktiv. +\end{sloppypar} + +\paragraph{Krfb} +~\\ +Krfb ist das Pendant zu Vino der KDE Desktopumgebung und kann entweder über eine Konfigurationsdatei oder über die grafische Oberfläche konfiguriert werden. Es kann entweder das Einladungssystem verwendet werden, bei dem eine Einladung mit einem Einmalpasswort generiert wird, oder man erlaubt uneingeladene Verbindungen und vergibt ein eigenes Passwort. Um Krfb über eine Konfigurationsdatei mit einem selbstgewählten Passwort für uneingeladene Verbindungen zu konfigurieren, erstellt man die Datei wie im folgenden angegeben und übergibt sie an krfb mit \texttt{krfb --config } bzw überschreibt oder bearbeitet die eigentliche Konfigurationsdatei in \textit{~/.kde/share/config/krfbrc}. +%\label{pvs-client-krfbconfig} +\begin{verbatim} +[Security] +allowDesktopControl=false +allowUninvitedConnections=true +uninvitedConnectionPassword= + +[TCP] +port= +useDefaultPort=false +\end{verbatim} + +Mit allowDesktopControl kann zwischen RW und Viewonly Modus gewechselt werden, unterschiedliche Passwörter können hierfür nicht vergeben werden. Zu beachten ist, dass die Passwörter für uneingeladene Verbindungen unverschlüsselt gespeichert werden. Wie auch Vino läuft Krfb standardmäßig im Shared und Forever Modus. + +\paragraph{x11vnc} +~\\ +x11vnc ist ein auf libvncserver basierender VNC-Server, der von Karl Runge entwickelt wurde, um unter Linux/Unix Systemen existierende Displays über VNC anzeigen zu lassen. +x11vnc wird über Parameter von der Kommandozeile aus konfiguriert. +Eine ausführliche Liste aller verfügbaren Parameter findet sich unter +\url{http://www.karlrunge.com/x11vnc/x11vnc_opts.html}. Zu beachten ist hierbei, dass alle Parameter, die an x11vnc übergeben werden (also beispielsweise auch Passwörter), in der z.B. durch \textbf{ps aux} abrufbaren Prozessliste anzeigbar sind. +Daher sollte eine Passwortdatei, welche auch nach dem Auslesen automatisch von x11vnc gelöscht werden kann (s.h. \ref{pvs-vnc-script}), benutzt werden. Die Struktur einer solchen Passwortdatei ist wie folgt: +\begin{verbatim} + rwpassword1 + . + . + [rwpasswordX] + [\_\_BEGIN_VIEWONLY\_\_] + [password1] + . + . + [passwordX] +\end{verbatim} +Es muss mindestens ein Passwort vorhanden sein. Alle Passwörter bis zu der Zeile, welche \_\_BEGIN\_VIEWONLY\_\_ enthält, werden als rw-Passwörter angesehen (außer in dem Spezialfall, dass nur zwei Passwörter und keine Zeile mit BEGIN\_VIEWONLY vorhanden sind, dann wird das zweite Passwort automatisch als Viewonly Passwort behandelt). Alle Passwörter nach der entsprechenden Viewonly-Zeile werden als Viewonly Passwörter gesehen. So ist es möglich beliebig viele Viewonly und bzw. oder RW-Passwörter zu generieren. + + +\subsection{VNC Script} +\label{pvs-vnc-script} +Der VNC Server wird durch ein Bash-Skript (\textit{/misc/pvs-vncsrv}) von der Klasse \textit{pvs} gestartet. Es wird zufällig jeweils ein Passwort für Standardzugriff und ein Passwort für den Zugriff mit Maus und Tastaturunterstützung generiert. Die generierten Passwörter werden dem Skript als Parameter übergeben. \textbf{pvs-vncsrv} wird zum Starten wie folgt aufgerufen: +\texttt{pvs-vncsrv start port passwort [rwpasswort]}. +Der Parameter \texttt{rwpasswort} ist optional und kann beim Starten des x11vnc zur Verwendung im Viewonly Modus weggelassen werden. +Um den VNC Server zu stoppen, kann das VNC Script mit dem Parameter \texttt{stop} aufgerufen werden. +Die übergebenen Passwörter werden zunächst auf folgende Weise in die Datei \textit{~/.pvs/vncpassword} geschrieben: \verb|rwpasswort __BEGIN_VIEWONLY__ passwort|. +Als nächstes wird x11vnc mit folgenden Parametern ausgeführt: +\begin{itemize} + \item -auth ... - die Xauthority Datei + \item -bg - im Hintergrund starten + \item -forever - den X Server nicht beenden, wenn sich ein Client trennt + \item -display :0 - das anzuzeigende Display + \item -passwdfile rm:... - Pfad der Passwortdatei + \item -o ... - Pfad der Logdatei (~/.pvs/log.vncsrv) + \item -shared - erlaube mehreren Clients, sich zu verbinden +\end{itemize} + +Zu beachten ist vor allem das \texttt{rm:} vor der Pfadangabe bei \texttt{-passwdfile}. Dies bewirkt das Löschen der Passwortdatei, nachdem x11vnc sie eingelesen hat. +Die Passwortdatei wird verwendet, da man ansonsten Passwörter, die nur als Parameter im Klartext an x11vnc übergeben werden, mittels \textbf{ps aux} lesen könnte. + +Um einen Mehrfachstart des VNC Servers zu verhindern, wird zunächst immer ein \texttt{pvs-vncsrv stop} ausgeführt, welches nach der Prozessid des x11vnc sucht und diesen mit kill -9 beendet. + +\section{VNC Viewer} +Der VNC Viewer ist, wie in der \ref{pvsclient-datenstrom} Darstellung von VNC-Datenströmen beschrieben, implementiert. +Die direkte Integration des Viewers im Gegensatz zum Einsatz eines externen VNC Servers bietet sich hier wegen der Integrationsmöglichkeiten in die GUI an (der VNC-Server ist GUI unabhängig). Jedoch muss der VNC-Viewer zur Unterstützung des RW-Modus des VNC-Servers noch verändert werden. +\subsection{Tastatur und Maussteuerung} +\label{pvsclient-remotehelp} +\begin{sloppypar} +Um die Maus- und Tastatureingaben an den VNC-Server weiterzuleiten, müssen zunächst die Eingaben in der Klasse \texttt{ClientVNCViewer} abgefangen und verarbeitet werden. Dies kann durch Überschreiben der geerbten Methode \texttt{event} erreicht werden \texttt{bool ClientVNCViewer::event(QEvent *event)}. Hier kann durch \texttt{event->type()} der Typ des Events herausgefunden werden. +Zu behandelnde Eventtypen sind: +\end{sloppypar} + +\begin{itemize} +\item QEvent:KeyPress - Eine Taste wurde gedrückt +\item QEvent:KeyRelease - Eine Taste wurde losgelassen +\item QEvent:MouseButtonDblClick - Mausdoppelklick +\item QEvent:MouseButtonPress - Maustaste gedrückt +\item QEvent:MouseButtonRelease - Maustaste losgelassen +\item QEvent:MouseMove - Maus wurde bewegt +\item QEvent:Wheel - Mausrad wurde bewegt +\end{itemize} + +Hier können nun die jeweils zuständigen Funktionen aufgerufen werden. Dabei ist zu beachten, dass die Methode \texttt{event()} bei allen Eingaben, die von einer eigenen Funktion behandelt werden, true zurückgibt (d.h. das Event wurde akzeptiert und behandelt). In den aufgerufenen Methoden kann dann zwischen den verschiedenen Maustasten (Qt:LeftButton, Qt:MidButton, Qt:RightButton) und den verschiedenen Tasten der Tastatur (z.B. Qt:Key\_A, Qt:Key\_B, Qt:Key\_Alt siehe hierzu auch \url{http://doc.trolltech.com/4.6/qt.html#Key-enum}) unterschieden werden. +Die Tastatur- und Mauseingaben müssen dann entsprechend an \texttt{vncClientThread} weitergeleitet werden. +In der Klasse vncClientThread werden die Eingaben dann in Objekte gekapselt in einer Queue, welche regelmäßig geleert wird, gespeichert. Die Objekte sind dabei zum einen ein \texttt{PointerEvent} und ein \texttt{KeyEvent}. \texttt{PointerEvents} enthalten die Koordinaten des Mauszeigers (x,y) und einen hexadezimalen Wert, der die Maustasten und deren Zustand repräsentiert. +Werte sind dabei: +\begin{itemize} + \item 0x01 = linke Maustaste gedrückt + \item 0x02 = mittlere Maustaste gedrückt + \item 0x03 = rechte Maustaste gedrückt + \item 0xfe = linke Maustaste losgelassen + \item 0xfd = mittlere Maustaste losgelassen + \item 0xfb = rechte Maustaste losgelassen +\end{itemize} +\begin{sloppypar} +\texttt{KeyEvents} bestehen aus einem hexadezimalen Wert, der die Taste repräsentiert, und True oder False je nachdem, ob die Taste gedrückt wurde oder nicht. Die hexadezimalen Werte entsprechen den Werten in einem X Window System und können in der Headerdatei \texttt{} nachgeschlagen werden (siehe hierzu auch \url{http://www.realvnc.com/docs/rfbproto.pdf} - RFB Protokollspezifikation, Abschnitt KeyEvent). Beim Leeren der Queue werden die Methoden der rfbclient Klasse der libvnc Bibliothek \texttt{SendPointerEvent(cl, \_x, \_y, \_buttonMask)} und \texttt{SendKeyEvent(cl, \_key, \_pressed)} mit den entsprechenden Werten aufgerufen (cl entspricht dabei einem Pointer auf die eigentliche rfbClient Instanz). +\end{sloppypar} + +\section{Signalbehandlung} + +\begin{sloppypar} +Um zu gewährleisten, dass bei einer Terminierung des PVS-Clients auch der gegebenenfalls gestartete VNC-Server gestoppt wird, werden Sigterm, Sighup, Sigquit und Sigint Signale abgefangen und weiterbehandelt. +Um die Signale behandeln zu können, muss die C Bibliothek \texttt{signals.h} eingebunden werden und ein sigaction Objekt erstellt werden. Das Feld sa\_handler des sigaction Objektes gibt dabei die aufzurufende Funktion an (Pointer auf die Funktion). Diese Funktion (in der Klasse \texttt{pvs} die Funktion \texttt{signalHandler}) muss dabei vom Typ void sein und die Signalnummer als Parameter erwarten (\texttt{void PVS::signalHandler(int signal)}). +\end{sloppypar} + +\begin{verbatim} + struct sigaction act; + act.sa_handler = &PVS::signalHandler; +\end{verbatim} + +\begin{sloppypar} +Um Signale abfangen zu können, muss nun noch das sigaction Objekt durch \texttt{sigaction(SIGTERM, \&act, 0)} mit den entsprechenden Signalen (hier SIGTERM) verknüpft werden (muss für alle zu behandelnde Signale durchgeführt werden). +Danach wird, sobald ein entsprechendes Signal erhalten wird, die Funktion aufgerufen und die Signalnummer übergeben. +Für alle Signale kann die gleiche Funktion aufgerufen werden, hier kann die Unterscheidung dann mittels der in \texttt{signal.h} vorhandenen Konstanten SIGHUP, SIGTERM, SIGQUIT usw. erfolgen. Zu beachten ist hierbei, dass ein SIGKILL nicht abgefangen werden kann. +\end{sloppypar} \ No newline at end of file diff --git a/doc/doxconf b/doc/doxconf deleted file mode 100644 index fefbae6..0000000 --- a/doc/doxconf +++ /dev/null @@ -1,1512 +0,0 @@ -# Doxyfile 1.5.8 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = "Pool Video Switch" - -# 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 = 17 - -# 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 = . - -# 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 = YES - -# 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, Serbian-Cyrilic, 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 = YES - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = NO - -# 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 = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) - -JAVADOC_AUTOBRIEF = YES - -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 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 - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Doxygen selects the parser to use depending on the extension of the files it parses. -# With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this tag. -# The format is ext=language, where ext is a file extension, and language is one of -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C - -EXTENSION_MAPPING = - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. - -TYPEDEF_HIDES_STRUCT = NO - -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penality. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will rougly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = 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 = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespace are hidden. - -EXTRACT_ANON_NSPACES = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = 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 = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# 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 = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name -# of the layout file. - -LAYOUT_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# 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 = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = ./doxwarnlog - -#--------------------------------------------------------------------------- -# 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 = ../src/input - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.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 = ./tests - -# 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 EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = ./documentation/images - -# 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 -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. - -REFERENCES_LINK_SOURCE = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = NO - -# 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 HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). - -HTML_DYNAMIC_SECTIONS = NO - -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. - -GENERATE_DOCSET = NO - -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. - -CHM_INDEX_ENCODING = - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER -# are set, an additional index file will be generated that can be used as input for -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated -# HTML documentation. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace - -QHP_NAMESPACE = - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders - -QHP_VIRTUAL_FOLDER = doc - -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see -# Qt Help Project / Custom Filters. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. -# Qt Help Project / Filter Attributes. - -QHP_SECT_FILTER_ATTRS = - -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. - -QHG_LOCATION = - -# 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 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, 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. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE -# respectively. - -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 - -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. - -FORMULA_FONTSIZE = 10 - -#--------------------------------------------------------------------------- -# 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 = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. -# This is useful -# if you want to understand what is going on. -# On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# 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 = YES - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = "DOXYGEN_RUNNING" \ - "BEGIN_POLICY_CLASS(name)=class name" \ - "END_POLICY_CLASS=;" - -# 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 = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option 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 = YES - -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see -# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = YES - -# By default doxygen will write a font called FreeSans.ttf to the output -# directory and reference it in all dot files that doxygen generates. This -# font does not include all possible unicode characters however, so when you need -# these (or just want a differently looking font) you can specify the font name -# using DOT_FONTNAME. You need need to make sure dot is able to find the font, -# which can be done by putting it in a standard location or by setting the -# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory -# containing the font. - -DOT_FONTNAME = FreeSans - -# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. -# The default size is 10pt. - -DOT_FONTSIZE = 10 - -# By default doxygen will tell dot to use the output directory to look for the -# FreeSans.ttf font (which doxygen will put there itself). If you specify a -# different font using DOT_FONTNAME you can set the path where dot -# can find it using this tag. - -DOT_FONTPATH = - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# 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 DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of -# nodes that will be shown in the graph. If the number of nodes in a graph -# becomes larger than this value, doxygen will truncate the graph, which is -# visualized by representing a node as a red box. Note that doxygen if the -# number of direct children of the root node in a graph is already larger than -# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note -# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. - -DOT_GRAPH_MAX_NODES = 50 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that the size of a graph can be further restricted by -# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not -# seem to support this out of the box. Warning: Depending on the platform used, -# enabling this option may lead to badly anti-aliased labels on the edges of -# a graph (i.e. they become hard to read). - -DOT_TRANSPARENT = 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 - -#--------------------------------------------------------------------------- -# Options 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/doc/header.tex b/doc/header.tex new file mode 100644 index 0000000..06488b5 --- /dev/null +++ b/doc/header.tex @@ -0,0 +1,58 @@ + +\thispagestyle{empty} +\vspace*{\stretch{0.5}} +{\center +\hspace*{5mm}{\huge \bf Pool Video Switch}\\ +\hspace*{5mm}{\huge Benutzer- und Entwicklerdokumentation \\ +\vspace*{\stretch{1}}} +\begin{figure}[h] +\center +\includegraphics[width=9cm]{bilder/siegel-neu.jpg} +\end{figure} +\vspace*{\stretch{0.5}} +\Large Entwickler-Team\\ \vspace*{\stretch{0.5}} +\large {\it Projekt des Lehrstuhls für Kommunikationssysteme} \\ +\vspace*{\stretch{0.3}} +Rechenzentrum / Institut für Informatik \\ +\vspace*{\stretch{0.3}} +\vspace*{\stretch{0.5}} +April 2010 \\} +\normalsize +\newpage +\thispagestyle{empty} +{\small back of titlepage} +\newpage + +\thispagestyle{empty} +\newcommand{\HRule}{\rule{\linewidth}{1mm}} +\setlength{\parindent}{0mm} +\setlength{\parskip}{0mm} +\vspace*{\stretch{1}} +\HRule +\begin{center} +\Huge Pool Video Switch\\[5mm] +\Large Benutzer- und Entwicklerdokumentation +\end{center} +\HRule +\vspace*{\stretch{2}} +\begin{center} +\large\textsc{OpenSLX Project\\Freiburg\\2010} +\end{center} + +\newpage +\thispagestyle{empty} + +. \\ +OpenSLX Project \\ +Lehrstuhl für Kommunikationssysteme \\ +Rechenzentrum \& Institut für Informatik an der Technischen Fakultät \\ +Herrmann-Herder-Str. 10 \\ +79104 FREIBURG i.Br. \\ +pvs@uni-freiburg.de \\ + + +\vspace*{\stretch{2}} + + +\newpage + diff --git a/doc/intro/0000-chapter.tex b/doc/intro/0000-chapter.tex new file mode 100644 index 0000000..6b3319b --- /dev/null +++ b/doc/intro/0000-chapter.tex @@ -0,0 +1,17 @@ +\chapter{Idee} +\label{einleitung} +\index{Einleitung} \index{Video Switch} \index{Laptop} \index{VGA} \index{DVI} \index{Klassenraum} \index{Student Control Panel} \index{Idee} + +Video-Switches für Klassenräume sind schon seit langem auf dem Markt: Sie setzen typischerweise auf eine Hardware-Lösung, die das Verlegen von vielen Metern Kabel bei dadurch erzwungener statischer Anordnung der Rechner verlangt. Sie sind nicht nur aufgrund des Einsatzes spezieller Hardware relativ teuer, sondern unflexibel bei technischen Weiterentwicklungen: Höhere Bildschirmauflösungen oder der Wechsel vom VGA auf den DVI oder PS2 auf den USB-Stecker sind nur durch einen Komplettaustausch oder unangenehme Kompromisse zu haben. Ziemlich ungeeignet erweisen sich hardware-basierte Lösungen beim Einsatz mobiler Geräte wie Laptops. Zudem erschweren sie die Veränderung der ursprünglichen Aufstellung der Maschinen und schaffen damit ungünstige Bedingungen für neue didaktische Konzepte. +\begin{figure}[h] +\center +\includegraphics[width=11.5cm]{bilder/studentctlpanel.png} +\caption{Student Control Panel des Edubuntu-Pakets, welches im Umfeld von Linux-Terminalservern eingesetzt werden kann.\label{uscp}} +\end{figure} +Neben den Hardware-basierten Varianten existieren inzwischen eine Reihe von Software-Produkten. Leider bieten sie keine optimalen Lösungen: Neben oft exorbitanten Lizenzkosten, die oft mit einem didaktisch und konzeptionell fragwürdigen Feature-Set begründet werden, orientieren sie sich an einem einzigen auf den Schulungs-PCs festinstalliertem Betriebssystem. Oft stehen sie nur für ausgewählte Microsoft-Betriebssysteme zur Verfügung und können damit nicht dem Anspruch einer breiten und allgemeinen universitären Umgebung entsprechen. Zudem kommen regelmäßige, typischerweise kostenpflichtige Produkt-Updates hinzu, denen sich nur begrenzt ausweichen läßt. + +Dem soll ein eigener Ansatz entgegengesetzt werden, der die eingangs genannten Beschränkungen aufhebt und dem Anspruch einer modernen universitären computer-gestützten Lehre entgegenkommt. Das Projekt soll stufenweise von einer einfachen Basislösung in Rückmeldung mit den Lehrenden weiterentwickelt werden. Ein Open-Source-Ansatz gewährleistet zudem eine größere Nachhaltigkeit. Selbst bei einer Projekteinstellung können andere auf den Code weiterhin zurückgreifen und damit einerseits bestehende Installationen aktualisieren und andererseits eigene Entwicklungen schneller vorantreiben. + +Bei der Entwicklung steht nicht die Neuerfindung bereits vorhandener Technologien, sondern deren intelligente Verknüpfung im Vordergrund. So bieten bereits Techniken wie VNC oder Xorg/X11 viele notwendige Grundlagen, die um pfiffige Werkzeuge mit intuitiven Oberflächen erweitert werden sollen. Eine gute Anschauung bietet beispielsweise die Open Source Software ''Student Control Panel'' des Edubuntu-Linux (\ref{uscp}). + +Eine sehr vergleichbare Applikation ist iTalc. diff --git a/doc/intro/0100-funktionen.tex b/doc/intro/0100-funktionen.tex new file mode 100644 index 0000000..966a065 --- /dev/null +++ b/doc/intro/0100-funktionen.tex @@ -0,0 +1,21 @@ +\chapter{Funktionen eines Software-Video-Switchs} +\label{funktionen} +\index{Funktion} + +Damit ein Software-Video-Switch Hardwarelösungen ersetzen kann, muss zumindest eine gewisse Grundmenge an Funktionalität bereitgestellt werden. Diese Funktionen lassen sich in weiteren Schritten erweitern und können dabei über die der Hardwareimplementierungen hinausgehen. Gegebenenfalls muss eine Softwarelösung sich um Aspekte kümmern, die bei einer Hardwarelösung kaum ein Problem darstellen. Hierzu zählt das Thema der Abhörsicherheit. + +\section{Basisfunktionen} + +In der verfügbaren Version wurden eine Reihe von Features realisiert. Hierzu zählt die Anzeige aller Display-Inhalte der Teilnehmerarbeitsplätze in verkleinerter Form auf einem separaten Steuer-PC, die Möglichkeit einzelne Teilnehmerarbeitsplätze auf den Dozenten-PC und damit auf den Beamer zu schalten, per Chat-Interface von der Dozentin Nachrichten auf die Bildschirme einzelner oder aller Teilnehmer zu schicken, die Inhalte des Dozenten-PC auf alle Teilnehmer-Displays zu schalten und das Sperrenvon Maus- und Tastatur der Teilnehmer. +\begin{figure}[h] +\center +\includegraphics[width=11.5cm]{bilder/studentctlpanel.png} +\caption{Student Control Panel des Edubuntu-Pakets, welches im Umfeld von Linux-Terminalservern eingesetzt werden kann.\label{uscp}} +\end{figure} +Bei der Realisierung wurde einerseits auf die Absicherung der Steuerverbindungen und andererseits auf die Aspekte des Datenschutzes geachtet. Anders als bei vergleichbaren Produkten liegt in der Standardinstallation die Kontrolle bei den Teilnehmern. + + +\section{Funktionserweiterungen} + +In weiteren Schritten wurden Funktionen wie das Übertragen von Dateien zwischen einzelnen Maschinen oder das Senden von Dateien an mehrere Teilnehmer gleichzeitig implementiert (\ref{}). Ebenso besteht die Möglichkeit einzelne und mehrere +Maschinen gemeinsam mit Tastatur und Maus zu steuern. diff --git a/doc/intro/0900-textaufbau.tex b/doc/intro/0900-textaufbau.tex new file mode 100644 index 0000000..70d2a66 --- /dev/null +++ b/doc/intro/0900-textaufbau.tex @@ -0,0 +1,13 @@ +\chapter{Aufbau dieses Handbuchs} +\label{aufbau} +\index{Aufbau} \index{Bedienungsanleitung} \index{Entwicklerdokumentation} + +Das Handbuch ist in drei Teile gegliedert, wobei der erste Teil mit diesen Erläuterungen bereits abgeschlossen wird. Der zweite Teil wendet sich an die Endanwender dieses Projekts und versteht sich als Bedienungsanleitung mit dem Fokus auf den Überblick zum Funktionsumfang und zur Konfiguration. Der dritte Teil umfasst die Entwicklerdokumentation. Dabei werden die einzelnen Komponenten und das Kommunikationsprotokoll detaillierter aus technischer Sicht dargestellt. + +\section{Heraushebungen und Formatierungen} +\index{Schreibweise} \index{Kommando} \index{Quelltext} \index{Konfiguration} +\index{Formatierung} \index{Verzeichnis} \index{Dateiname} + +Zur besseren Lesbarkeit gibt es einige Konventionen zur Formatierung von einfachen Kommandos, Kommandozeilen oder Verzeichnis- und Dateinamen. Ebenso sind Skripte oder Auszüge aus C++-Quelltexten zur Heraushebung anders gesetzt. + +Hierbei gelten folgende Regelungen: Ein einfaches Kommando wird \textbf{fett} gesetzt, wie beispielsweise \textbf{pvsmgr}. Dieses lässt sich in einem Terminalfenster absetzen oder über die Ausführenoption der grafischen Desktops. Kommandos mit Optionen und bei Bedarf Parametern werden so wie Skripten und Quelltexte in \texttt{Schreibmaschinenschrift} gesetzt aber nicht aus dem allgemeinen Textsatz herausgehoben. Solche Heraushebungen werden jedoch ab zwei Druckzeilen aufwärts sinnvoll. Verzeichnis- und Dateinamen, wobei es bei letzteren dann nicht um den Programmnamen, sondern Quelltexte, Konfigurationen etc. geht, werden \textit{kursiv} gedruckt, wie beispielsweise \textit{/etc/pvs}. diff --git a/doc/mystyle-pdf.tex b/doc/mystyle-pdf.tex new file mode 100644 index 0000000..034ae31 --- /dev/null +++ b/doc/mystyle-pdf.tex @@ -0,0 +1,112 @@ +\documentclass[12pt,a4paper,ngerman]{book} + +\usepackage[ngerman]{babel} +\usepackage{ucs} +\usepackage[T1]{fontenc} +\usepackage[utf8x]{inputenc} +%\usepackage[latin1]{inputenc} +\usepackage{multicol} +\usepackage{graphicx} +\usepackage{makeidx} +\usepackage{ulem} +\usepackage{xcolor} +\usepackage{moreverb} + +%using serif-less Font +\renewcommand{\familydefault}{\sfdefault} + +% european A4 paper format---------> +\setlength{\textwidth}{15.8cm} % width of main text +\setlength{\textheight}{23.5cm} % height of main text +\setlength{\topmargin}{-1in} % Subtract default offset +\addtolength{\topmargin}{2.2cm} % Topmargin +\setlength{\topskip}{30pt} % between header and text +%%\setlength{\headheight}{0.0in} % no header +%%\setlength{\headsep}{0.0in} % +\setlength{\hoffset}{-1in} % Subtract default offset +\addtolength{\hoffset}{2.2cm} +\setlength{\evensidemargin}{\paperwidth} +\addtolength{\evensidemargin}{-\textwidth} +\addtolength{\evensidemargin}{-\oddsidemargin} +\addtolength{\evensidemargin}{-2in} +\addtolength{\evensidemargin}{-\hoffset} +\addtolength{\evensidemargin}{-\hoffset} +\addtolength{\oddsidemargin}{-1.5mm} +% + +\usepackage{fancyhdr} +\fancyhf{} +\renewcommand{\headrulewidth}{0pt} +\setlength{\fboxsep}{3mm} +\addtolength{\headwidth}{\marginparsep} +\addtolength{\headwidth}{\marginparwidth} +%\renewcommand{\chaptermark}[1]% +% {\markboth{#1}{}} +%\renewcommand{\sectionmark}[1]% +% {\markright{\thesection\ #1}} + +%define pagenumberbox +\newcommand{\mylthepage}{\colorbox{gray}{\makebox[1.8cm][r]{\color{white}{\bf{\thepage}}}}} +\newcommand{\myrthepage}{\colorbox{gray}{\makebox[1.8cm][l]{\color{white}{\bf{\thepage}}}}} + +%set pagenumber and chapter information +\lhead[\mylthepage]{\bf{\color{gray}{\rightmark}}} +\rhead[\bf{\color{gray}{\leftmark}}]{\myrthepage} +\cfoot{} +\pagestyle{fancy} +\fancypagestyle{plain}{ +\renewcommand{\headrulewidth}{0pt} +\setlength{\fboxsep}{3mm} +%\addtolength{\headwidth}{\marginparsep} +%\addtolength{\headwidth}{\marginparwidth} +%\lhead[\mylthepage]{ } +%\rhead[ ]{\myrthepage} +\cfoot{} +} +% +\makeatletter +\renewcommand\thechapter{\arabic{chapter}} +\def\@makechapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \par\nobreak + \vskip 20\p@ + \fi + \fi + \interlinepenalty\@M + \Huge \bfseries \thechapter\ #1\par\nobreak + \vskip 40\p@ + }} +\makeatother +% icons/darrow16.svg icons/ok16.svg - icons/cam32.svg icons/cam_on32.svg icons/cam_off32.svg diff --git a/src/gui/clientConfigDialog.cpp b/src/gui/clientConfigDialog.cpp index b7ba407..0ddada0 100644 --- a/src/gui/clientConfigDialog.cpp +++ b/src/gui/clientConfigDialog.cpp @@ -96,16 +96,6 @@ void ClientConfigDialog::readSettings() else radioButtonOtherNO->setChecked(true); } - - reply = _ifaceDBus->getConfigValue("Permissions/allow_chat"); - reply.waitForFinished(); - if (reply.isValid()) - checkBoxAllowChat->setChecked(reply.value() == "T"); - - reply = _ifaceDBus->getConfigValue("Permissions/allow_filetransfer"); - reply.waitForFinished(); - if (reply.isValid()) - checkBoxAllowFiletransfer->setChecked(reply.value() == "T"); } void ClientConfigDialog::writeSettings() @@ -125,12 +115,6 @@ void ClientConfigDialog::writeSettings() else _ifaceDBus->setConfigValue("Permissions/vnc_other", "no"); - _ifaceDBus->setConfigValue("Permissions/allow_chat", - QString(checkBoxAllowChat->isChecked() ? "T" : "F")); - _ifaceDBus->setConfigValue("Permissions/allow_filetransfer", - QString(checkBoxAllowFiletransfer->isChecked() ? "T" : "F")); - _ifaceDBus->setConfigValue("multicast/interface", interfaceList->currentText()); - _settings.sync(); emit configChanged(); } diff --git a/src/gui/ui/clientConfigDialog.ui b/src/gui/ui/clientConfigDialog.ui index bb4bdc9..aa73433 100644 --- a/src/gui/ui/clientConfigDialog.ui +++ b/src/gui/ui/clientConfigDialog.ui @@ -6,8 +6,8 @@ 0 0 - 445 - 266 + 366 + 195 @@ -27,7 +27,7 @@ QTabWidget::North - 2 + 0 @@ -130,30 +130,6 @@ - - - - - - Accept chat messages - - - true - - - - - - - Accept file transfers - - - true - - - - - diff --git a/src/pvs.cpp b/src/pvs.cpp old mode 100755 new mode 100644 index 1f751b8..cf45dd7 --- a/src/pvs.cpp +++ b/src/pvs.cpp @@ -46,9 +46,7 @@ PVS::PVS() : _vncRequested = false; readPolicyFiles(); loadCommands(); - /*#ifndef __WIN32__*/ - _blankScreen = NULL; - /*#endif*/ + _blankScreen = NULL; _vncPort = -1; _masterMcastConfig = new McastConfiguration(this); @@ -81,7 +79,6 @@ PVS::PVS() : _timerLockTest = 0; _timerLockDelay = 0; - #ifndef __WIN32__ //add signalhandling for sigterm signals struct sigaction act; act.sa_handler = &PVS::signalHandler; @@ -95,7 +92,6 @@ PVS::PVS() : sigaction(SIGQUIT, &act, 0); initializeInputEventHandling(); - #endif /*__WIN32__*/ } PVS::~PVS() @@ -593,18 +589,12 @@ int PVS::startVNCScript(int port, QString pass, QString rwpass) if (!system(NULL)) ConsoleLog writeError("No Command processor available"); int result = system(commandLine.toUtf8().data()); - #ifndef __WIN32__ -//TODO Win32 result = WEXITSTATUS(result); if (result != 0) ConsoleLog writeError(QString("VNC-Server is not running, code: ") + int2String(result)); else ConsoleLog writeLine("VNC-Server should be running"); return result; - #else - /*Code fuer VNC-Aufruf unter Windows einfuegen*/ - return 0; - #endif /*__WIN32__*/ } else { @@ -620,7 +610,6 @@ int PVS::stopVNCScript() { if (gotVNCScript()) { - #ifndef __WIN32__ ConsoleLog writeLine("Stopping VNC-Script"); QString commandLine(_vncScriptPath); commandLine.append(" "); @@ -632,10 +621,6 @@ int PVS::stopVNCScript() ConsoleLog writeLine("VNC-Server should be stopped"); int result = system(commandLine.toUtf8().data()); return WEXITSTATUS(result); - #else - /*Code fuer VNC-Server stoppen unter Windows einfuegen*/ - return 0; - #endif /*__WIN32__*/ } else { @@ -713,7 +698,6 @@ QString PVS::getIpByNick(QString nick) void PVS::signalHandler(int signal) { ConsoleLog writeLine(QString("Received Signal ").append (int2String(signal))); - #ifndef __WIN32__ switch (signal) { case SIGHUP: mainClient->quit(); @@ -728,10 +712,6 @@ void PVS::signalHandler(int signal) mainClient->quit(); break; } - #else - ConsoleLog writeLine("Abfang nicht definiert fuer Windows"); - #endif /*__WIN32__*/ - } bool PVS::createMulticastTransfer(QString const& objectPath, quint64& transferID, QString& errorReason) diff --git a/src/pvs.h b/src/pvs.h old mode 100755 new mode 100644 index 49c2b4c..b2a84cf --- a/src/pvs.h +++ b/src/pvs.h @@ -13,10 +13,8 @@ #define PVSCLIENT_H_ #include -#ifndef __WIN32__ - #include - #include -#endif +#include +#include #include #include "setup.h" @@ -141,9 +139,7 @@ private: bool _locked; ///< are we locked? QString _lockMsg; ///< message to display while we're locked bool _vncAllowed; ///< whether vncConnections to this client are allowed (dup?) - /*#ifndef __WIN32__*/ - BlankScreen *_blankScreen;///< object to blank the screen - /*#endif*/ + BlankScreen *_blankScreen;///< object to blank the screen QFileSystemWatcher* _notify; ///< used to get notifies about file changes //vnc-server diff --git a/src/pvsDaemon.cpp b/src/pvsDaemon.cpp index 1784a14..9f2572c 100644 --- a/src/pvsDaemon.cpp +++ b/src/pvsDaemon.cpp @@ -64,9 +64,6 @@ int main(int argc, char** argv) bool _daemon = false; int frequency = 5; int port = -1; -#ifdef as_daemon - bool no_fork = false; -#endif QCoreApplication app(argc, argv); app.setOrganizationName("openslx"); @@ -78,11 +75,6 @@ int main(int argc, char** argv) app.installTranslator(&translator); QFileInfo script; -#ifdef __WIN32__ - //TODO Win32 - if (!script.exists()) - script.setFile(getHomeDir() + "/.pvs/pvs-vncsrv_win32.bat"); -#else QSettings settings; if (!QFile::exists(settings.fileName())) { @@ -97,7 +89,6 @@ int main(int argc, char** argv) script.setFile("/usr/local/bin/pvs-vncsrv"); if (!script.exists()) script.setFile(getHomeDir() + "/.pvs/pvs-vncsrv"); -#endif //__WIN32__ PVSLocalhostCommunicator com(getPolicyFilePath(QString( ".comfile"))); @@ -122,9 +113,6 @@ int main(int argc, char** argv) { "freq", required_argument, 0, 'f' }, { "client", required_argument, 0, 'e' }, { "script", required_argument, 0, 's' }, -#ifdef as_daemon - { "no-fork", no_argument, 0, 'F' }, -#endif { 0, 0, 0, 0 }, }; /* getopt_long stores the option index here. */ @@ -232,13 +220,6 @@ int main(int argc, char** argv) } break; } -#ifdef as_daemon - case 'F': - { - no_fork = true; - break; - } -#endif case '?': { ConsoleLog writeError( @@ -264,11 +245,7 @@ int main(int argc, char** argv) ConsoleLog writeLine(QString("PVS-Client started.")); if (_daemon) - { - #ifndef __WIN32__ daemon(1, 1); - #endif /*__WIN32__*/ - } mainClient = new PVS(); com.getDispatcher()->addListener("*", mainClient, &PVS::onDaemonCommand); diff --git a/src/pvsgui.cpp b/src/pvsgui.cpp index 1f11790..4294206 100644 --- a/src/pvsgui.cpp +++ b/src/pvsgui.cpp @@ -345,7 +345,6 @@ void PVSGUI::disconnected() { statusLabel->setText( "

Offline

"); - showMessage(tr("PVS connection"), tr("Disconnected")); if (_hosts->contains(hostButton->text())) _hosts->value(hostButton->text())->setChecked(false); hostButton->setText("-"); diff --git a/src/util/clientGUIUtils.h b/src/util/clientGUIUtils.h index 7f7ea47..e797ea0 100755 --- a/src/util/clientGUIUtils.h +++ b/src/util/clientGUIUtils.h @@ -25,7 +25,6 @@ private: BlankScreen_Sysdep* _sysdep; }; -#ifndef __WIN32__ # include class X11Info @@ -33,6 +32,5 @@ class X11Info public: static Display* display(); }; -#endif /* !__WIN32__ */ #endif diff --git a/src/util/clientGUIUtils_Win32.cpp b/src/util/clientGUIUtils_Win32.cpp deleted file mode 100755 index 1b4d2ae..0000000 --- a/src/util/clientGUIUtils_Win32.cpp +++ /dev/null @@ -1,46 +0,0 @@ - -#include "clientGUIUtils.h" -#include - -struct BlankScreen_Sysdep { - - bool locked; - QWidget* blankwin; - - QString lockMsg; - int blackColor, whiteColor; - int offX, offY; -}; - -BlankScreen::BlankScreen() -{ - _sysdep = new BlankScreen_Sysdep; - _sysdep->blankwin = new QWidget(0, Qt::X11BypassWindowManagerHint | Qt::FramelessWindowHint | Qt::WindowStaysOnTopHint); - _sysdep->blankwin->setWindowState(Qt::WindowFullScreen); - _sysdep->blankwin->show(); -} - -BlankScreen::~BlankScreen() -{ - delete _sysdep; -} - -void BlankScreen::draw(bool force) -{ - -} - -bool BlankScreen::lock() -{ - return true; -} - -bool BlankScreen::lock_inputs() -{ - return true; -} - -bool BlankScreen::unlock() -{ - return true; -} diff --git a/src/util/util.cpp b/src/util/util.cpp index 05a209f..0fcfa84 100755 --- a/src/util/util.cpp +++ b/src/util/util.cpp @@ -7,10 +7,6 @@ #include #include #include -#ifdef __WIN32__ - #include - #include -#endif //__WIN32__ PVSServerEntry::PVSServerEntry(QString name) { @@ -49,11 +45,7 @@ int getRandom(int min, int max) if (init) { init = false; - #ifndef __WIN32__ srand ( time(NULL) + getpid() ); - #else - srand ( time(NULL) ); /*might be solved by another random factor*/ - #endif } if (min >= max) return rand(); return rand() % (max-min+1) + min; @@ -193,24 +185,10 @@ QString colonSplitter(QString line, bool first) QString getUserName() { QString username; - #ifdef __WIN32__ - WCHAR* lpszSystemInfo; // pointer to system information - DWORD cchBuff = 256; // size of user name - WCHAR tchBuffer[UNLEN + 1]; // buffer for expanded string + struct passwd* passUser = getpwuid(getuid()); + if (passUser) + username = QString(passUser->pw_name); - lpszSystemInfo = tchBuffer; - - // Get and display the user name. - GetUserNameW(lpszSystemInfo, &cchBuff); - - //Unicode string needs to be converted - username = QString::fromWCharArray(lpszSystemInfo); - #else - struct passwd* passUser = getpwuid(getuid()); - if (passUser) - username = QString(passUser->pw_name); - - #endif //#ifdef __WIN32__ if (username.isEmpty()) { qDebug("USERNAME COULDNT BE RETRIEVED!"); @@ -223,21 +201,19 @@ QString getUserName() QString getFullUsername() { QString fullname = getUserName(); - #ifndef __WIN32__ - struct passwd *pd; + struct passwd *pd; - if (NULL == (pd = getpwuid(getuid()))) - {ConsoleLog writeError("getpwuid() error.");} - else + if (NULL == (pd = getpwuid(getuid()))) + {ConsoleLog writeError("getpwuid() error.");} + else + { + QString tmp = pd->pw_gecos; + QStringList userData = tmp.split(","); + if(userData[0].length() > 0 ) { - QString tmp = pd->pw_gecos; - QStringList userData = tmp.split(","); - if(userData[0].length() > 0 ) - { - fullname = userData[0]; - } + fullname = userData[0]; } - #endif //__WIN32__ //might be completed some time to a full solution for WIN32 + } return fullname; } diff --git a/src/util/util.h b/src/util/util.h index 4f2d0ee..0fab33f 100755 --- a/src/util/util.h +++ b/src/util/util.h @@ -1,19 +1,12 @@ #include #include -//#include #include #include #include -#ifndef __WIN32__ - #include -#else - /*#include "pwd_win32.h"*/ -#endif /*__WIN32*/ +#include #include #include - - #ifndef _PVSSERVERENTRY_H_ #define _PVSSERVERENTRY_H_ class PVSServerEntry -- cgit v1.2.3-55-g7522