diff options
Diffstat (limited to 'doc/devel')
| -rw-r--r-- | doc/devel/0000-chapter.tex | 0 | ||||
| -rw-r--r-- | doc/devel/0100-build.tex | 69 | ||||
| -rw-r--r-- | doc/devel/0200-gui-lib.tex | 31 | ||||
| -rw-r--r-- | doc/devel/0300-pvs.tex | 505 | ||||
| -rw-r--r-- | doc/devel/0310-service-discovery.tex | 84 | ||||
| -rw-r--r-- | doc/devel/0400-pvs-console.tex | 176 | ||||
| -rw-r--r-- | doc/devel/0500-pvs-client.tex | 243 |
7 files changed, 1108 insertions, 0 deletions
diff --git a/doc/devel/0000-chapter.tex b/doc/devel/0000-chapter.tex new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/doc/devel/0000-chapter.tex 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-<version>-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{<Username des Empfängers>} & \texttt{<<Username des Absenders>:<Die eigentliche nachrich>} & \texttt{<<Vom server zugewissene ID des Absenders>}\\ +\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{<Die eigentliche nachrich>} \\ +\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{<Befehl>} & \texttt{<Benutzername>:<IP-Adresse>} \\ +\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(<Beschreibung des Ereignisses>)} +\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(<Absender>, <Empfänger>, <Nachricht>)} +\\ +\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<PVSClient*> \_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<QString> targetList} mit den Projektionszielen und eine Map \texttt{QMap<QString, QList<QString> > 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<QString, QTextEdit*>} 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 <portnumber>} bzw. das Einfügen von z.B. +\texttt{<entry name=``alternative\_port'' mtime=``1259858032'' type= ``int'' value=``<portnumber>''/>} +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 <Pfad> } 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=<passwort> + +[TCP] +port=<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{<X11/keysymdef.h>} 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 |