[X2go-Commits] python-x2go.git - master (branch) updated: 0.2.1.1-23-g4b05f61

The branch, master has been updated via 4b05f61aec2d1e9f8dfde42416be4883782c40b5 (commit) from b014bae497840deba4b094e5fdee4e79478b989b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 4b05f61aec2d1e9f8dfde42416be4883782c40b5 Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Sun Jan 13 23:29:58 2013 +0100 rename every occurence from X2go to X2Go, including class names ----------------------------------------------------------------------- Summary of changes: Makefile.docupload | 2 +- README | 6 +- README.Trinity-Desktop | 2 +- examples/x2go_resume_session.py | 2 +- examples/x2go_start_session.py | 2 +- .../x2go_start_session_with_progress_status.py | 2 +- x2go/__init__.py | 72 ++-- x2go/backends/control/__init__.py | 4 +- x2go/backends/control/_stdout.py | 132 +++---- x2go/backends/info/__init__.py | 8 +- x2go/backends/info/_stdout.py | 30 +- x2go/backends/printing/__init__.py | 8 +- x2go/backends/printing/_file.py | 40 +- x2go/backends/printing/_gconf.py | 22 +- x2go/backends/printing/_winreg.py | 22 +- x2go/backends/profiles/__init__.py | 10 +- x2go/backends/profiles/_file.py | 50 +-- x2go/backends/profiles/_gconf.py | 18 +- x2go/backends/profiles/_httpsbroker.py | 18 +- x2go/backends/profiles/_winreg.py | 18 +- x2go/backends/proxy/__init__.py | 4 +- x2go/backends/proxy/_nx3.py | 14 +- x2go/backends/proxy/base.py | 34 +- x2go/backends/settings/__init__.py | 8 +- x2go/backends/settings/_file.py | 18 +- x2go/backends/settings/_gconf.py | 20 +- x2go/backends/settings/_winreg.py | 20 +- x2go/backends/terminal/__init__.py | 4 +- x2go/backends/terminal/_stdout.py | 150 ++++---- x2go/cache.py | 64 ++-- x2go/checkhosts.py | 48 +-- x2go/cleanup.py | 12 +- x2go/client.py | 382 ++++++++++---------- x2go/defaults.py | 78 ++-- x2go/forward.py | 30 +- x2go/guardian.py | 26 +- x2go/inifiles.py | 22 +- x2go/log.py | 10 +- x2go/mimebox.py | 44 +-- x2go/mimeboxactions.py | 64 ++-- x2go/printactions.py | 94 ++--- x2go/printqueue.py | 48 +-- x2go/pulseaudio.py | 18 +- x2go/registry.py | 166 ++++----- x2go/rforward.py | 82 ++--- x2go/session.py | 254 ++++++------- x2go/sftpserver.py | 64 ++-- x2go/sshproxy.py | 42 +-- x2go/tests/test_printing.py | 24 +- x2go/utils.py | 6 +- x2go/x2go_exceptions.py | 56 +-- x2go/xserver.py | 30 +- 52 files changed, 1202 insertions(+), 1202 deletions(-) The diff of changes is: diff --git a/Makefile.docupload b/Makefile.docupload index aa4869d..9356f57 100644 --- a/Makefile.docupload +++ b/Makefile.docupload @@ -16,7 +16,7 @@ docbuild: rm -Rf .epydoc/html/* epydoc --debug -n "Python X2Go" -u http://www.x2go.org -v --html --no-private -o .epydoc/html x2go/ #epydoc --debug --pdf --no-private -o .epydoc/pdf.tmp x2go/ - #mv .epydoc/pdf.tmp/api.pdf .epydoc/pdf/Python-X2go_API.pdf + #mv .epydoc/pdf.tmp/api.pdf .epydoc/pdf/Python-X2Go_API.pdf #rm -Rf .epydoc/pdf.tmp diff --git a/README b/README index da4bc54..1dc3d28 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ Published under the terms of the GNU Affero General Public License. See http://www.gnu.org/licenses/agpl.html for a recent copy. -=== What is Python X2go? === +=== What is Python X2Go? === The Python X2Go module integrates X2Go client support into your python programmes. Python X2Go is used in the headless X2Go client »pyhoca-cli« and by the tiny systray GUI @@ -59,7 +59,7 @@ and wholeheartedness concerning this inner process. * use Pulse Audio sound * X2Go printing * reading/writing session profiles from file -* sharing of local (client-side) folders (SFTP server is integrated in Python X2go) +* sharing of local (client-side) folders (SFTP server is integrated in Python X2Go) * connect via proxy SSH server * X2Go MIME box support * color depth auto-recognition @@ -107,7 +107,7 @@ Testing and writing a short howto for this section is very welcome. === How to use it from the command line? === A good example for the usage of Python X2Go is the pyhoca-cli programme, a headless -X2Go client that aims at 100% compatibility with X2goClient applications released in +X2Go client that aims at 100% compatibility with X2GoClient applications released in the X2Go project. On Debian/Ubuntu you can easily install the X2Go Client by running APT again: diff --git a/README.Trinity-Desktop b/README.Trinity-Desktop index 90ffa21..2bab505 100644 --- a/README.Trinity-Desktop +++ b/README.Trinity-Desktop @@ -1,4 +1,4 @@ -Trinity Deskop (KDE3.5 fork) and (Python) X2go +Trinity Deskop (KDE3.5 fork) and (Python) X2Go ============================================== Python X2Go brings support to start Trinity Desktops on remote diff --git a/examples/x2go_resume_session.py b/examples/x2go_resume_session.py index 2afc739..1a15e86 100644 --- a/examples/x2go_resume_session.py +++ b/examples/x2go_resume_session.py @@ -37,7 +37,7 @@ username = "foo" password = getpass.getpass() -cli = x2go.X2goClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) +cli = x2go.X2GoClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) s_uuid = cli.register_session(server, port=port, username=username, geometry="800x600", add_to_known_hosts=True) cli.connect_session(s_uuid, password=password) diff --git a/examples/x2go_start_session.py b/examples/x2go_start_session.py index d260f64..2b3a0a0 100644 --- a/examples/x2go_start_session.py +++ b/examples/x2go_start_session.py @@ -37,7 +37,7 @@ command = "GNOME" password = getpass.getpass() -cli = x2go.X2goClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) +cli = x2go.X2GoClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) s_uuid = cli.register_session(server, port=port, username=username, cmd=command, diff --git a/examples/x2go_start_session_with_progress_status.py b/examples/x2go_start_session_with_progress_status.py index e594953..0ce3226 100644 --- a/examples/x2go_start_session_with_progress_status.py +++ b/examples/x2go_start_session_with_progress_status.py @@ -45,7 +45,7 @@ def my_progress_bar(ps): password = getpass.getpass() -cli = x2go.X2goClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) +cli = x2go.X2GoClient(use_cache=False, loglevel=x2go.log.loglevel_DEBUG) s_uuid = cli.register_session(server, port=port, username=username, cmd=command, diff --git a/x2go/__init__.py b/x2go/__init__.py index 8398a96..3183204 100644 --- a/x2go/__init__.py +++ b/x2go/__init__.py @@ -38,25 +38,25 @@ API Concept Python X2Go only offers five public API classes. With the release of version 0.1.0.0, we will try to keep these five public API classes - of future releases as compatible as possible with versions of Python X2go + of future releases as compatible as possible with versions of Python X2Go greater/equal than v0.1.0.0. The five public API classes are: - - L{X2goClient} --- a whole X2Go client API - - L{X2goSession} --- management of an individual X2Go - session--either started standalone or from within an L{X2goClient} instance - - L{X2goClientSettings} --- provide access to X2Go (global and + - L{X2GoClient} --- a whole X2Go client API + - L{X2GoSession} --- management of an individual X2Go + session--either started standalone or from within an L{X2GoClient} instance + - L{X2GoClientSettings} --- provide access to X2Go (global and user) configuration node »settings« - - L{X2goClientPrinting} --- provide access to X2Go (global and + - L{X2GoClientPrinting} --- provide access to X2Go (global and user) configuration node »printing« - - L{X2goSessionProfiles} --- provide access to X2Go (global and + - L{X2GoSessionProfiles} --- provide access to X2Go (global and user) configuration node »sessions« Plus two extra classes on MS Windows platforms: - - L{X2goClientXConfig} and L{X2goXServer} --- these classes will be initialized - during L{X2goClient} instantiation on MS Windows platforms and start an installed XServer + - L{X2GoClientXConfig} and L{X2GoXServer} --- these classes will be initialized + during L{X2GoClient} instantiation on MS Windows platforms and start an installed XServer Any other of the Python X2Go classes may be subject to internal changes and the way of addressing these classes in code may vary between different @@ -68,40 +68,40 @@ API Structure ============= When using Python X2Go in your applications, the basic idea is that you - create your own class and inherit the X2goClient class in that:: + create your own class and inherit the X2GoClient class in that:: import x2go - class MyX2goClient(x2go.X2goClient): + class MyX2GoClient(x2go.X2GoClient): ... Python X2Go is capable of handling multiple running/suspended sessions within the same client instance, so for your application, there should not be any need of - instantiating more than one L{X2goClient} object in parallel. + instantiating more than one L{X2GoClient} object in parallel. NOTE: Doing so is--herewith--fully disrecommended. - The L{X2goClient} class flattens the complex structure of Python X2Go into - many L{X2goClient} methods that you can use in your own C{MyX2goClient} instance. + The L{X2GoClient} class flattens the complex structure of Python X2Go into + many L{X2GoClient} methods that you can use in your own C{MyX2GoClient} instance. However, it might be handy to retrieve a whole X2Go session instance - from the L{X2goClient} instance. This can be achieved by the - L{X2goClient.register_session()} method:: + from the L{X2GoClient} instance. This can be achieved by the + L{X2GoClient.register_session()} method:: import x2go - my_x2gocli = MyX2goClient() + my_x2gocli = MyX2GoClient() reg_session_instance = my_x2gocli.register_session(<options>, return_object=True) Whereas <options> can be as simple as:: »profile_name=<PROFILE_NAME_IN_SESSIONS_FILE>« - or contain a whole set of L{X2goSession} parameters that can be used to start a + or contain a whole set of L{X2GoSession} parameters that can be used to start a session manually (i.e. a session that is based on a pre-configured session profile in either of the »sessions« config files). - The L{X2goClient.register_session()} method---in object-retrieval-mode---returns - an L{X2goSession} instance. With this instance you can then manage + The L{X2GoClient.register_session()} method---in object-retrieval-mode---returns + an L{X2GoSession} instance. With this instance you can then manage your X2Go session:: import gevent, getpass @@ -126,8 +126,8 @@ API Structure How to access---especially how to modify---the X2Go client configuration files »settings«, »printing«, »sessions« and »xconfig« (Windows only) is explained in detail with each class declaration in this API documentation. - Please refer to the class docs of L{X2goClientSettings}, L{X2goClientPrinting}, - L{X2goSessionProfiles} and L{X2goXServer}. + Please refer to the class docs of L{X2GoClientSettings}, L{X2GoClientPrinting}, + L{X2GoSessionProfiles} and L{X2GoXServer}. Configuration and Session Management @@ -142,22 +142,22 @@ Configuration and Session Management section, a section in the Windows registry, etc. NOTE: Each configuration node will be re-read whenever it is needed - by an X2Go sesion or the X2goClient class itself. + by an X2Go sesion or the X2GoClient class itself. Conclusively, any change to either of the configuration nodes will be reflected as a change in your X2Go client behaviour: - - L{X2goSessionProfiles}: changes to a session profile in + - L{X2GoSessionProfiles}: changes to a session profile in the »sessions« node will be available for the next registered - L{X2goSession} instance - - L{X2goClientPrinting}: on each incoming X2Go print job the + L{X2GoSession} instance + - L{X2GoClientPrinting}: on each incoming X2Go print job the »printing« configuration node will be re-read, thus you can change your X2Go client's print setup during a running session - - L{X2goClientSettings}: also the configuration node »settings« + - L{X2GoClientSettings}: also the configuration node »settings« is re-read whenever needed in the course of X2Go session management - - L{X2goClientXConfig} and L{X2goXServer} (Windows only): these classes will only be initialized + - L{X2GoClientXConfig} and L{X2GoXServer} (Windows only): these classes will only be initialized once (starting the XServer on Windows platforms) on construction - of an L{X2goClient} instance + of an L{X2GoClient} instance Dependencies ============ @@ -185,12 +185,12 @@ monkey.patch_all() import utils -from client import X2goClient -from backends.profiles import X2goSessionProfiles -from backends.printing import X2goClientPrinting -from backends.settings import X2goClientSettings -from session import X2goSession -from sshproxy import X2goSSHProxy +from client import X2GoClient +from backends.profiles import X2GoSessionProfiles +from backends.printing import X2GoClientPrinting +from backends.settings import X2GoClientSettings +from session import X2GoSession +from sshproxy import X2GoSSHProxy from x2go_exceptions import * from log import * @@ -204,5 +204,5 @@ from defaults import X2GO_SESSIONS_ROOTDIR from defaults import X2GO_SSH_ROOTDIR if X2GOCLIENT_OS == 'Windows': - from xserver import X2goClientXConfig, X2goXServer + from xserver import X2GoClientXConfig, X2GoXServer diff --git a/x2go/backends/control/__init__.py b/x2go/backends/control/__init__.py index 81de8bb..ec17e90 100644 --- a/x2go/backends/control/__init__.py +++ b/x2go/backends/control/__init__.py @@ -19,6 +19,6 @@ from x2go.defaults import BACKEND_CONTROLSESSION_DEFAULT -from _stdout import X2goControlSessionSTDOUT +from _stdout import X2GoControlSessionSTDOUT -X2goControlSession = eval(BACKEND_CONTROLSESSION_DEFAULT) +X2GoControlSession = eval(BACKEND_CONTROLSESSION_DEFAULT) diff --git a/x2go/backends/control/_stdout.py b/x2go/backends/control/_stdout.py index ef8da9c..264e8b3 100644 --- a/x2go/backends/control/_stdout.py +++ b/x2go/backends/control/_stdout.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goControlSessionSTDOUT class - core functions for handling your individual X2Go sessions. +X2GoControlSessionSTDOUT class - core functions for handling your individual X2Go sessions. This backend handles X2Go server implementations that respond via server-side STDOUT. @@ -48,10 +48,10 @@ import x2go.x2go_exceptions as x2go_exceptions import x2go.defaults as defaults import x2go.checkhosts as checkhosts -from x2go.backends.terminal import X2goTerminalSession as _X2goTerminalSession -from x2go.backends.info import X2goServerSessionInfo as _X2goServerSessionInfo -from x2go.backends.info import X2goServerSessionList as _X2goServerSessionList -from x2go.backends.proxy import X2goProxy as _X2goProxy +from x2go.backends.terminal import X2GoTerminalSession as _X2GoTerminalSession +from x2go.backends.info import X2GoServerSessionInfo as _X2GoServerSessionInfo +from x2go.backends.info import X2GoServerSessionList as _X2GoServerSessionList +from x2go.backends.proxy import X2GoProxy as _X2GoProxy import x2go._paramiko x2go._paramiko.monkey_patch_paramiko() @@ -103,7 +103,7 @@ def _rewrite_password(cmd, user=None, password=None): return cmd -class X2goControlSessionSTDOUT(paramiko.SSHClient): +class X2GoControlSessionSTDOUT(paramiko.SSHClient): """\ In the Python X2Go concept, X2Go sessions fall into two parts: a control session and one to many terminal sessions. @@ -119,10 +119,10 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): known_hosts=None, forward_sshagent=False, unique_hostkey_aliases=False, - terminal_backend=_X2goTerminalSession, - info_backend=_X2goServerSessionInfo, - list_backend=_X2goServerSessionList, - proxy_backend=_X2goProxy, + terminal_backend=_X2GoTerminalSession, + info_backend=_X2GoServerSessionInfo, + list_backend=_X2GoServerSessionList, + proxy_backend=_X2GoProxy, client_rootdir=os.path.join(defaults.LOCAL_HOME, defaults.X2GO_CLIENT_ROOTDIR), sessions_rootdir=os.path.join(defaults.LOCAL_HOME, defaults.X2GO_SESSIONS_ROOTDIR), ssh_rootdir=os.path.join(defaults.LOCAL_HOME, defaults.X2GO_SSH_ROOTDIR), @@ -134,7 +134,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): control session and one to many terminal sessions that all server-client-communicate via this one common control session. - A control session normally gets set up by an L{X2goSession} instance. Do not use it directly!!! + A control session normally gets set up by an L{X2GoSession} instance. Do not use it directly!!! @param profile_name: the profile name of the session profile this control session works for @type profile_name: C{str} @@ -150,11 +150,11 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param terminal_backend: X2Go terminal session backend to use @type terminal_backend: C{class} @param info_backend: backend for handling storage of server session information - @type info_backend: C{X2goServerSessionInfo*} instance + @type info_backend: C{X2GoServerSessionInfo*} instance @param list_backend: backend for handling storage of session list information - @type list_backend: C{X2goServerSessionList*} instance + @type list_backend: C{X2GoServerSessionList*} instance @param proxy_backend: backend for handling the X-proxy connections - @type proxy_backend: C{X2goProxy*} instance + @type proxy_backend: C{X2GoProxy*} instance @param client_rootdir: client base dir (default: ~/.x2goclient) @type client_rootdir: C{str} @param sessions_rootdir: sessions base dir (default: ~/.x2go) @@ -164,10 +164,10 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param published_applications_no_submenus: published applications menus with less items than C{published_applications_no_submenus} are rendered without submenus @type published_applications_no_submenus: C{int} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goControlSessionSTDOUT} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoControlSessionSTDOUT} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @param kwargs: catch any non-defined parameters in C{kwargs} @@ -197,7 +197,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self._server_features = None if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -276,7 +276,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param remote_path: full remote path name of the server-side target location, path names have to be Unix-compliant @type remote_path: C{str} - @raise X2goControlSessionException: if the SSH connection dropped out + @raise X2GoControlSessionException: if the SSH connection dropped out """ ssh_transport = self.get_transport() @@ -290,7 +290,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): # react to connection dropped error for SSH connections self.session_died = True self._transport_lock.release() - raise x2go_exceptions.X2goControlSessionException('The SSH connection was dropped during an sFTP put action.') + raise x2go_exceptions.X2GoControlSessionException('The SSH connection was dropped during an sFTP put action.') self.sftp_client = None self._transport_lock.release() @@ -305,7 +305,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param content: a text file, multi-line files use Unix-link EOL style @type content: C{str} - @raise X2goControlSessionException: if the SSH connection dropped out + @raise X2GoControlSessionException: if the SSH connection dropped out """ ssh_transport = self.get_transport() @@ -322,7 +322,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self.session_died = True self._transport_lock.release() self.logger('sFTP-write: opening remote file %s on host %s failed' % (remote_path, self.remote_peername()), loglevel=log.loglevel_WARN) - raise x2go_exceptions.X2goControlSessionException('The SSH connection was dropped during an sFTP write action.') + raise x2go_exceptions.X2GoControlSessionException('The SSH connection was dropped during an sFTP write action.') self.sftp_client = None self._transport_lock.release() @@ -335,7 +335,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param remote_path: full remote path name of the server-side file to be removed, path names have to be Unix-compliant @type remote_path: C{str} - @raise X2goControlSessionException: if the SSH connection dropped out + @raise X2GoControlSessionException: if the SSH connection dropped out """ ssh_transport = self.get_transport() @@ -349,7 +349,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self.session_died = True self._transport_lock.release() self.logger('sFTP-write: removing remote file %s on host %s failed' % (remote_path, self.remote_peername()), loglevel=log.loglevel_WARN) - raise x2go_exceptions.X2goControlSessionException('The SSH connection was dropped during an sFTP remove action.') + raise x2go_exceptions.X2GoControlSessionException('The SSH connection was dropped during an sFTP remove action.') self.sftp_client = None self._transport_lock.release() @@ -372,7 +372,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: C{True} if the command could be successfully executed on the remote X2Go server @rtype: C{bool} - @raise X2goControlSessionException: if the command execution failed (due to a lost connection) + @raise X2GoControlSessionException: if the command execution failed (due to a lost connection) """ if type(cmd_line) == types.ListType: @@ -403,37 +403,37 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self._transport_lock.release() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session has died unexpectedly') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session has died unexpectedly') except EOFError: self.session_died = True self._transport_lock.release() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session has died unexpectedly') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session has died unexpectedly') except x2go_exceptions.SSHException: self.session_died = True self._transport_lock.release() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session has died unexpectedly') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session has died unexpectedly') except gevent.timeout.Timeout: self.session_died = True self._transport_lock.release() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session command timed out') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session command timed out') except socket.error: self.session_died = True self._transport_lock.release() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session has died unexpectedly') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session has died unexpectedly') finally: timer.cancel() else: self._transport_lock.release() - raise x2go_exceptions.X2goControlSessionException('the X2Go control session is not connected') + raise x2go_exceptions.X2GoControlSessionException('the X2Go control session is not connected') self._transport_lock.release() return _retval @@ -543,7 +543,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: SSH transport's user name @rtype: C{str} - @raise X2goControlSessionException: on SSH connection loss + @raise X2GoControlSessionException: on SSH connection loss """ if self._remote_username is None: @@ -552,7 +552,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self._remote_username = self.get_transport().get_username() except: self.session_died = True - raise x2go_exceptions.X2goControlSessionException('Lost connection to X2Go server') + raise x2go_exceptions.X2GoControlSessionException('Lost connection to X2Go server') return self._remote_username def remote_peername(self): @@ -562,7 +562,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: SSH transport's peer name @rtype: C{tuple} - @raise X2goControlSessionException: on SSH connection loss + @raise X2GoControlSessionException: on SSH connection loss """ if self._remote_peername is None: @@ -571,7 +571,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self._remote_peername = self.get_transport().getpeername() except: self.session_died = True - raise x2go_exceptions.X2goControlSessionException('Lost connection to X2Go server') + raise x2go_exceptions.X2GoControlSessionException('Lost connection to X2Go server') return self._remote_peername @property @@ -683,7 +683,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @param force_password_auth: non-paramiko option, disable pub/priv key authentication completely, even if the C{pkey} or the C{key_filename} parameter is given @type force_password_auth: C{bool} - @param session_instance: an instance L{X2goSession} using this L{X2goControlSessionSTDOUT} + @param session_instance: an instance L{X2GoSession} using this L{X2GoControlSessionSTDOUT} instance. @type session_instance: C{obj} @param use_sshproxy: connect through an SSH proxy @@ -721,9 +721,9 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @raise SSHException: if there was any other error connecting or establishing an SSH session @raise socket.error: if a socket error occurred while connecting - @raise X2goSSHProxyException: any SSH proxy exception is passed through while establishing the SSH proxy connection and tunneling setup - @raise X2goSSHAuthenticationException: any SSH proxy authentication exception is passed through while establishing the SSH proxy connection and tunneling setup - @raise X2goRemoteHomeException: if the remote home directory does not exist or is not accessible + @raise X2GoSSHProxyException: any SSH proxy exception is passed through while establishing the SSH proxy connection and tunneling setup + @raise X2GoSSHAuthenticationException: any SSH proxy authentication exception is passed through while establishing the SSH proxy connection and tunneling setup + @raise X2GoRemoteHomeException: if the remote home directory does not exist or is not accessible """ _fake_hostname = None @@ -736,7 +736,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): if not sshproxy_tunnel: sshproxy_tunnel = "localhost:44444:%s:%s" % (hostname, port) - self.sshproxy_session = sshproxy.X2goSSHProxy(known_hosts=self.known_hosts, + self.sshproxy_session = sshproxy.X2GoSSHProxy(known_hosts=self.known_hosts, sshproxy_host=sshproxy_host, sshproxy_port=sshproxy_port, sshproxy_user=sshproxy_user, @@ -771,10 +771,10 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): port = self.sshproxy_session.get_local_proxy_port() if not add_to_known_hosts and session_instance: - self.set_missing_host_key_policy(checkhosts.X2goInteractiveAddPolicy(caller=self, session_instance=session_instance, fake_hostname=_fake_hostname)) + self.set_missing_host_key_policy(checkhosts.X2GoInteractiveAddPolicy(caller=self, session_instance=session_instance, fake_hostname=_fake_hostname)) if add_to_known_hosts: - self.set_missing_host_key_policy(checkhosts.X2goAutoAddPolicy(caller=self, session_instance=session_instance, fake_hostname=_fake_hostname)) + self.set_missing_host_key_policy(checkhosts.X2GoAutoAddPolicy(caller=self, session_instance=session_instance, fake_hostname=_fake_hostname)) # disable pub/priv key authentication if forced if force_password_auth: @@ -882,7 +882,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): ssh_transport = self.get_transport() ssh_transport.reverse_tunnels = {} - # mark Paramiko/SSH transport as X2goControlSession + # mark Paramiko/SSH transport as X2GoControlSession ssh_transport._x2go_session_marker = True self._session_password = password @@ -906,7 +906,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): self.close() if self.sshproxy_session: self.sshproxy_session.stop_thread() - raise x2go_exceptions.X2goRemoteHomeException('remote home directory does not exist') + raise x2go_exceptions.X2GoRemoteHomeException('remote home directory does not exist') return (self.get_transport() is not None) @@ -915,7 +915,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): Drop an associated terminal session. @param terminal_session: the terminal session object to remove from the list of associated terminals - @type terminal_session: C{X2goTerminalSession*} + @type terminal_session: C{X2GoTerminalSession*} """ for t_name in self.associated_terminals.keys(): @@ -938,9 +938,9 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): try: if not self.session_died: t_obj.suspend() - except x2go_exceptions.X2goTerminalSessionException: + except x2go_exceptions.X2GoTerminalSessionException: pass - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.session_died t_obj.__del__() for t_name in t_names: @@ -1008,7 +1008,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): try: if self._x2go_exec_command('echo', loglevel=log.loglevel_DEBUG): return True - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.session_died = True self.disconnect() return False @@ -1223,8 +1223,8 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): """\ Start a new X2Go session. - The L{X2goControlSessionSTDOUT.start()} method accepts any parameter - that can be passed to any of the C{X2goTerminalSession} backend class + The L{X2GoControlSessionSTDOUT.start()} method accepts any parameter + that can be passed to any of the C{X2GoTerminalSession} backend class constructors. @param kwargs: parameters that get passed through to the control session's @@ -1245,17 +1245,17 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): """\ Resume a running/suspended X2Go session. - The L{X2goControlSessionSTDOUT.resume()} method accepts any parameter - that can be passed to any of the C{X2goTerminalSession*} backend class constructors. + The L{X2GoControlSessionSTDOUT.resume()} method accepts any parameter + that can be passed to any of the C{X2GoTerminalSession*} backend class constructors. @return: True if the session could be successfully resumed @rtype: C{bool} - @raise X2goUserException: if the remote user is not allowed to launch/resume X2Go sessions. + @raise X2GoUserException: if the remote user is not allowed to launch/resume X2Go sessions. """ if not self.is_x2gouser(self.get_transport().get_username()): - raise x2go_exceptions.X2goUserException('remote user %s is not allowed to run X2Go commands' % self.get_transport().get_username()) + raise x2go_exceptions.X2GoUserException('remote user %s is not allowed to run X2Go commands' % self.get_transport().get_username()) try: if session_name is not None: @@ -1285,7 +1285,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): _success = _terminal.resume() else: _success = _terminal.start() - except x2go_exceptions.X2goTerminalSessionException: + except x2go_exceptions.X2GoTerminalSessionException: _success = False if _success: @@ -1322,7 +1322,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: True if the session could be successfully shared @rtype: C{bool} - @raise X2goDesktopSharingException: if C{username} and C{dislpay} do not relate to a + @raise X2GoDesktopSharingException: if C{username} and C{dislpay} do not relate to a sharable desktop session """ @@ -1330,7 +1330,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): user = desktop.split('@')[0] display = desktop.split('@')[1] if not (user and display): - raise x2go_exceptions.X2goDesktopSharingException('Need user name and display number of sharable desktop.') + raise x2go_exceptions.X2GoDesktopSharingException('Need user name and display number of sharable desktop.') cmd = '%sXSHAD%sXSHAD%s' % (share_mode, user, display) @@ -1351,7 +1351,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: a list of X2Go desktops available for sharing @rtype: C{list} - @raise X2goTimeOutException: on command execution timeouts, with the server-side C{x2golistdesktops} + @raise X2GoTimeOutException: on command execution timeouts, with the server-side C{x2golistdesktops} command this can sometimes happen. Make sure you ignore these time-outs and to try again """ @@ -1374,7 +1374,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): # if we do not get a reply here after <maxwait> seconds we will raise a time out, we have to # make sure that we catch this at places where we want to ignore timeouts (e.g. in the # desktop list cache) - raise x2go_exceptions.X2goTimeOutException('x2golistdesktop command timed out') + raise x2go_exceptions.X2GoTimeOutException('x2golistdesktop command timed out') finally: timeout.cancel() @@ -1395,7 +1395,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): @return: a list of client-side mounts for X2Go session C{<session_name>} on the server @rtype: C{list} - @raise X2goTimeOutException: on command execution timeouts, queries with the server-side + @raise X2GoTimeOutException: on command execution timeouts, queries with the server-side C{x2golistmounts} query should normally be processed quickly, a time-out may hint that the control session has lost its connection to the X2Go server @@ -1417,7 +1417,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): except gevent.timeout.Timeout: # if we do not get a reply here after <maxwait> seconds we will raise a time out, we have to # make sure that we catch this at places where we want to ignore timeouts - raise x2go_exceptions.X2goTimeOutException('x2golistmounts command timed out') + raise x2go_exceptions.X2GoTimeOutException('x2golistmounts command timed out') finally: timeout.cancel() @@ -1431,12 +1431,12 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): C{x2golistsessions} is returned. @type raw: C{bool} - @return: normally an instance of a C{X2goServerSessionList*} backend is returned. However, + @return: normally an instance of a C{X2GoServerSessionList*} backend is returned. However, if the raw argument is set, the plain text output of the server-side C{x2golistsessions} command is returned - @rtype: C{X2goServerSessionList} instance or str + @rtype: C{X2GoServerSessionList} instance or str - @raise X2goControlSessionException: on command execution timeouts, if this happens the control session will + @raise X2GoControlSessionException: on command execution timeouts, if this happens the control session will be interpreted as disconnected due to connection loss """ if raw: @@ -1471,7 +1471,7 @@ class X2goControlSessionSTDOUT(paramiko.SSHClient): if _count >= _maxwait: self.session_died = True self.disconnect() - raise x2go_exceptions.X2goControlSessionException('x2golistsessions command failed after we have tried 20 times') + raise x2go_exceptions.X2GoControlSessionException('x2golistsessions command failed after we have tried 20 times') # update internal variables when list_sessions() is called for _session_name, _terminal in self.associated_terminals.items(): diff --git a/x2go/backends/info/__init__.py b/x2go/backends/info/__init__.py index 4183215..352f931 100644 --- a/x2go/backends/info/__init__.py +++ b/x2go/backends/info/__init__.py @@ -20,8 +20,8 @@ from x2go.defaults import BACKEND_SERVERSESSIONINFO_DEFAULT from x2go.defaults import BACKEND_SERVERSESSIONLIST_DEFAULT -from _stdout import X2goServerSessionInfoSTDOUT -from _stdout import X2goServerSessionListSTDOUT +from _stdout import X2GoServerSessionInfoSTDOUT +from _stdout import X2GoServerSessionListSTDOUT -X2goServerSessionInfo = eval(BACKEND_SERVERSESSIONINFO_DEFAULT) -X2goServerSessionList = eval(BACKEND_SERVERSESSIONLIST_DEFAULT) +X2GoServerSessionInfo = eval(BACKEND_SERVERSESSIONINFO_DEFAULT) +X2GoServerSessionList = eval(BACKEND_SERVERSESSIONLIST_DEFAULT) diff --git a/x2go/backends/info/_stdout.py b/x2go/backends/info/_stdout.py index 7182a95..0e1a4c5 100644 --- a/x2go/backends/info/_stdout.py +++ b/x2go/backends/info/_stdout.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goServerSessionList and X2goServerSessionInfo classes - data handling for +X2GoServerSessionList and X2GoServerSessionInfo classes - data handling for X2Go server sessions. This backend handles X2Go server implementations that respond with session infos @@ -34,17 +34,17 @@ import re import x2go.defaults as defaults -class X2goServerSessionInfoSTDOUT(object): +class X2GoServerSessionInfoSTDOUT(object): """\ - L{X2goServerSessionInfo} is used to store all information + L{X2GoServerSessionInfo} is used to store all information that is retrieved from the connected X2Go server on - C{X2goTerminalSessionBACKEND.start()} resp. C{X2goTerminalSessionBACKEND.resume()}. + C{X2GoTerminalSessionBACKEND.start()} resp. C{X2GoTerminalSessionBACKEND.resume()}. """ def __str__(self): return self.name def __repr__(self): - result = 'X2goServerSessionInfoSTDOUT(' + result = 'X2GoServerSessionInfoSTDOUT(' for p in dir(self): if '__' in p or not p in self.__dict__ or type(p) is types.InstanceType: continue result += p + '=' + str(self.__dict__[p]) +',' @@ -52,7 +52,7 @@ class X2goServerSessionInfoSTDOUT(object): def _parse_x2golistsessions_line(self, x2go_output): """\ - Parse a single line of X2go's listsessions output. + Parse a single line of X2Go's listsessions output. @param x2go_output: output from ,,x2golistsessions'' command (as list of strings/lines) @type x2go_output: C{list} @@ -214,7 +214,7 @@ class X2goServerSessionInfoSTDOUT(object): def clear(self): """\ - Clear all properties of a L{X2goServerSessionInfo} object. + Clear all properties of a L{X2GoServerSessionInfo} object. """ self.name = '' @@ -235,10 +235,10 @@ class X2goServerSessionInfoSTDOUT(object): def update(self, session_info): """\ - Update all properties of a L{X2goServerSessionInfo} object. + Update all properties of a L{X2GoServerSessionInfo} object. @param session_info: a provided session info data structure - @type session_info: C{X2goServerSessionInfo*} + @type session_info: C{X2GoServerSessionInfo*} """ if type(session_info) == type(self): @@ -253,21 +253,21 @@ class X2goServerSessionInfoSTDOUT(object): """ Class constructor, identical to L{clear()} method. """ -class X2goServerSessionListSTDOUT(object): +class X2GoServerSessionListSTDOUT(object): """\ - L{X2goServerSessionListSTDOUT} is used to store all information + L{X2GoServerSessionListSTDOUT} is used to store all information that is retrieved from a connected X2Go server on a - C{X2goControlSessionBACKEND.list_sessions()} call. + C{X2GoControlSessionBACKEND.list_sessions()} call. """ - def __init__(self, x2go_output, info_backend=X2goServerSessionInfoSTDOUT): + def __init__(self, x2go_output, info_backend=X2GoServerSessionInfoSTDOUT): """\ @param x2go_output: X2Go server's C{x2golistsessions} command output, each session separated by a newline character. Session values are separated by Unix Pipe Symbols ('|') @type x2go_output: str @param info_backend: the session info backend to use - @type info_backend: C{X2goServerSessionInfo*} + @type info_backend: C{X2GoServerSessionInfo*} """ self.sessions = {} @@ -290,7 +290,7 @@ class X2goServerSessionListSTDOUT(object): @type session_name: C{str} @return: the session info of C{<session_name>} - @rtype: C{X2goServerSessionInfo*} or C{None} + @rtype: C{X2GoServerSessionInfo*} or C{None} """ try: diff --git a/x2go/backends/printing/__init__.py b/x2go/backends/printing/__init__.py index 94cbd97..7672c30 100644 --- a/x2go/backends/printing/__init__.py +++ b/x2go/backends/printing/__init__.py @@ -19,9 +19,9 @@ from x2go.defaults import BACKEND_CLIENTPRINTING_DEFAULT -from _file import X2goClientPrintingFILE -from _winreg import X2goClientPrintingWINREG -from _gconf import X2goClientPrintingGCONF +from _file import X2GoClientPrintingFILE +from _winreg import X2GoClientPrintingWINREG +from _gconf import X2GoClientPrintingGCONF -X2goClientPrinting = eval(BACKEND_CLIENTPRINTING_DEFAULT) +X2GoClientPrinting = eval(BACKEND_CLIENTPRINTING_DEFAULT) diff --git a/x2go/backends/printing/_file.py b/x2go/backends/printing/_file.py index ba136da..dfce53c 100644 --- a/x2go/backends/printing/_file.py +++ b/x2go/backends/printing/_file.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goClientPrintingFILE} class is one of Python X2go's public API classes. +L{X2GoClientPrintingFILE} class is one of Python X2Go's public API classes. -Retrieve an instance of this class from your L{X2goClient} instance. +Retrieve an instance of this class from your L{X2GoClient} instance. Use this class in your Python X2Go based applications to access the »printing« configuration of your X2Go client application. @@ -58,13 +58,13 @@ _print_property_map = { }, } -class X2goClientPrintingFILE(inifiles.X2goIniFile): +class X2GoClientPrintingFILE(inifiles.X2GoIniFile): """\ - L{X2goClientPrintingFILE} provides access to the X2Go ini-like file + L{X2GoClientPrintingFILE} provides access to the X2Go ini-like file »printing« as stored in C{~/.x2goclient/printing} resp. globally C{/etc/x2goclient/printing}. - An instance of L{X2goClientPrintingFILE} is created on each incoming + An instance of L{X2GoClientPrintingFILE} is created on each incoming print job. This facilitates that on every print job the print action for this job is derived from the »printing« configuration file. @@ -81,18 +81,18 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): directory filename) @type config_files: C{list} @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2go's hard coded defaults in L{defaults} + Python X2Go's hard coded defaults in L{defaults} @type defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintAction} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintAction} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ self.client_instance = client_instance - inifiles.X2goIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) + inifiles.X2GoIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) self._detect_print_action() @@ -108,23 +108,23 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): _show_dialog = self.get('General', 'showdialog', key_type=types.BooleanType) if _show_dialog and self.client_instance is not None: - self._print_action = printactions.X2goPrintActionDIALOG(client_instance=self.client_instance, logger=self.logger) + self._print_action = printactions.X2GoPrintActionDIALOG(client_instance=self.client_instance, logger=self.logger) elif _general_pdfview and _view_open: _view_command = self.get('view', 'command') - self._print_action = printactions.X2goPrintActionPDFVIEW(client_instance=self.client_instance, pdfview_cmd=_view_command, logger=self.logger) + self._print_action = printactions.X2GoPrintActionPDFVIEW(client_instance=self.client_instance, pdfview_cmd=_view_command, logger=self.logger) elif _general_pdfview and not _view_open: _safe_folder = self.get('save', 'folder') - self._print_action = printactions.X2goPrintActionPDFSAVE(client_instance=self.client_instance, save_to_folder=_safe_folder, logger=self.logger) + self._print_action = printactions.X2GoPrintActionPDFSAVE(client_instance=self.client_instance, save_to_folder=_safe_folder, logger=self.logger) elif not _general_pdfview and not _print_startcmd: _cups_defaultprinter = self.get('CUPS', 'defaultprinter') - self._print_action = printactions.X2goPrintActionPRINT(client_instance=self.client_instance, printer=_cups_defaultprinter, logger=self.logger) + self._print_action = printactions.X2GoPrintActionPRINT(client_instance=self.client_instance, printer=_cups_defaultprinter, logger=self.logger) elif not _general_pdfview and _print_startcmd: _print_command = self.get('print', 'command') - self._print_action = printactions.X2goPrintActionPRINTCMD(client_instance=self.client_instance, print_cmd=_print_command, logger=self.logger) + self._print_action = printactions.X2GoPrintActionPRINTCMD(client_instance=self.client_instance, print_cmd=_print_command, logger=self.logger) @property def print_action(self): @@ -173,7 +173,7 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): @return: the stored value for C{<print_property>} @rtype: C{str} - @raise X2goClientPrintingException: if the printing property does not exist + @raise X2GoClientPrintingException: if the printing property does not exist """ if print_property in _print_property_map.keys(): @@ -181,7 +181,7 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): _ini_option = _print_property_map[print_property]['ini_option'] return self.get_value(_ini_section, _ini_option) else: - raise x2go_exceptions.X2goClientPrintingException('No such X2Go client printing property ,,%s\'\'' % print_property) + raise x2go_exceptions.X2GoClientPrintingException('No such X2Go client printing property ,,%s\'\'' % print_property) def set_property(self, print_property, value): """\ @@ -192,7 +192,7 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): @param value: the value to be stored as C{<print_property>} @rtype: C{str} - @raise X2goClientPrintingException: if the printing property does not exist or if there is a type mismatch + @raise X2GoClientPrintingException: if the printing property does not exist or if there is a type mismatch """ if print_property in _print_property_map.keys(): @@ -202,10 +202,10 @@ class X2goClientPrintingFILE(inifiles.X2goIniFile): if type(value) is types.UnicodeType: value = value.encode('utf-8') if _default_type != type(value): - raise x2go_exceptions.X2goClientPrintingException('Type mismatch error for property ,,%s\'\' - is: %s, should be: %s' % (print_property, str(type(value)), str(_default_type))) + raise x2go_exceptions.X2GoClientPrintingException('Type mismatch error for property ,,%s\'\' - is: %s, should be: %s' % (print_property, str(type(value)), str(_default_type))) self.update_value(_ini_section, _ini_option, value) else: - raise x2go_exceptions.X2goClientPrintingException('No such X2Go client printing property ,,%s\'\'' % print_property) + raise x2go_exceptions.X2GoClientPrintingException('No such X2Go client printing property ,,%s\'\'' % print_property) def store_print_action(self, print_action, **print_properties): """\ diff --git a/x2go/backends/printing/_gconf.py b/x2go/backends/printing/_gconf.py index 11bc718..4f719fe 100644 --- a/x2go/backends/printing/_gconf.py +++ b/x2go/backends/printing/_gconf.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goClientPrintingGCONF} class is one of Python X2go's public API classes. +L{X2GoClientPrintingGCONF} class is one of Python X2Go's public API classes. -Retrieve an instance of this class from your L{X2goClient} instance. +Retrieve an instance of this class from your L{X2GoClient} instance. Use this class in your Python X2Go based applications to access the »printing« configuration of your X2Go client application. @@ -36,14 +36,14 @@ from x2go.defaults import X2GO_CLIENTPRINTING_DEFAULTS as _X2GO_CLIENTPRINTING_D from x2go.defaults import X2GO_PRINTING_CONFIGFILES as _X2GO_PRINTING_CONFIGFILES import x2go.inifiles as inifiles -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goClientPrintingGCONF(inifiles.X2goIniFile): +class X2GoClientPrintingGCONF(inifiles.X2GoIniFile): """\ - L{X2goClientPrintingGCONF} provides access to the GCONF based configuration + L{X2GoClientPrintingGCONF} provides access to the GCONF based configuration of the X2Go client printing setup. - An instance of L{X2goClientPrintingGCONF} is created on each incoming + An instance of L{X2GoClientPrintingGCONF} is created on each incoming print job. This facilitates that on every print job the print action for this job is derived from the »printing« configuration file. @@ -56,16 +56,16 @@ class X2goClientPrintingGCONF(inifiles.X2goIniFile): def __init__(self, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2go's hard coded defaults in L{defaults} + Python X2Go's hard coded defaults in L{defaults} @type defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintAction} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintAction} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ - raise X2goNotImplementedYetException('GCONF backend support is not implemented yet') + raise X2GoNotImplementedYetException('GCONF backend support is not implemented yet') diff --git a/x2go/backends/printing/_winreg.py b/x2go/backends/printing/_winreg.py index 839be52..2ae42c4 100644 --- a/x2go/backends/printing/_winreg.py +++ b/x2go/backends/printing/_winreg.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goClientPrintingWINREG} class is one of Python X2go's public API classes. +L{X2GoClientPrintingWINREG} class is one of Python X2Go's public API classes. -Retrieve an instance of this class from your L{X2goClient} instance. +Retrieve an instance of this class from your L{X2GoClient} instance. Use this class in your Python X2Go based applications to access the »printing« configuration of your X2Go client application. @@ -36,14 +36,14 @@ from x2go.defaults import X2GO_CLIENTPRINTING_DEFAULTS as _X2GO_CLIENTPRINTING_D from x2go.defaults import X2GO_PRINTING_CONFIGFILES as _X2GO_PRINTING_CONFIGFILES import x2go.inifiles as inifiles -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goClientPrintingWINREG(inifiles.X2goIniFile): +class X2GoClientPrintingWINREG(inifiles.X2GoIniFile): """\ - L{X2goClientPrintingWINREG} provides access to the Windows registry based configuration + L{X2GoClientPrintingWINREG} provides access to the Windows registry based configuration of the X2Go client printing setup. - An instance of L{X2goClientPrintingWINREG} is created on each incoming + An instance of L{X2GoClientPrintingWINREG} is created on each incoming print job. This facilitates that on every print job the print action for this job is derived from the »printing« configuration file. @@ -56,14 +56,14 @@ class X2goClientPrintingWINREG(inifiles.X2goIniFile): def __init__(self, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2go's hard coded defaults in L{defaults} + Python X2Go's hard coded defaults in L{defaults} @type defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintAction} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintAction} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ - raise X2goNotImplementedYetException('WINREG backend support is not implemented yet') + raise X2GoNotImplementedYetException('WINREG backend support is not implemented yet') diff --git a/x2go/backends/profiles/__init__.py b/x2go/backends/profiles/__init__.py index 796245b..f5d2ac7 100644 --- a/x2go/backends/profiles/__init__.py +++ b/x2go/backends/profiles/__init__.py @@ -19,10 +19,10 @@ from x2go.defaults import BACKEND_SESSIONPROFILES_DEFAULT -from _file import X2goSessionProfilesFILE -from _winreg import X2goSessionProfilesWINREG -from _httpsbroker import X2goSessionProfilesHTTPSBROKER -from _gconf import X2goSessionProfilesGCONF +from _file import X2GoSessionProfilesFILE +from _winreg import X2GoSessionProfilesWINREG +from _httpsbroker import X2GoSessionProfilesHTTPSBROKER +from _gconf import X2GoSessionProfilesGCONF -X2goSessionProfiles = eval(BACKEND_SESSIONPROFILES_DEFAULT) +X2GoSessionProfiles = eval(BACKEND_SESSIONPROFILES_DEFAULT) diff --git a/x2go/backends/profiles/_file.py b/x2go/backends/profiles/_file.py index 6e241a8..3c60ec2 100644 --- a/x2go/backends/profiles/_file.py +++ b/x2go/backends/profiles/_file.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goSessionProfiles} class - managing x2goclient session profiles. +L{X2GoSessionProfiles} class - managing x2goclient session profiles. -L{X2goSessionProfiles} is a public API class. Use this class in your Python X2Go based +L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based applications. """ @@ -37,10 +37,10 @@ from x2go.defaults import X2GO_DESKTOPSESSIONS as _X2GO_DESKTOPSESSIONS import x2go.inifiles as inifiles import x2go.log as log import x2go.utils as utils -from x2go.x2go_exceptions import X2goProfileException +from x2go.x2go_exceptions import X2GoProfileException -class X2goSessionProfilesFILE(inifiles.X2goIniFile): +class X2GoSessionProfilesFILE(inifiles.X2GoIniFile): defaultSessionProfile = _X2GO_SESSIONPROFILE_DEFAULTS _non_profile_sections = ('embedded') @@ -55,10 +55,10 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): @type defaults: C{dict} @param session_profile_defaults: a default session profile @type session_profile_defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goSessionProfilesFILE} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoSessionProfilesFILE} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -70,14 +70,14 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): self._profiles_need_profile_id_renewal = [] if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ - # providing defaults for an X2goSessionProfiles instance will---in the worst case---override your + # providing defaults for an X2GoSessionProfiles instance will---in the worst case---override your # existing sessions file in your home directory once you write the sessions back to file... - inifiles.X2goIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) + inifiles.X2GoIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) if utils._checkSessionProfileDefaults(session_profile_defaults): self.defaultSessionProfile = session_profile_defaults @@ -159,7 +159,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): self._profiles_need_profile_id_renewal = [] # at last write the profile config as is... - inifiles.X2goIniFile.write(self) + inifiles.X2GoIniFile.write(self) def get_profile_option_type(self, option): @@ -233,7 +233,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): return value else: - raise X2goProfileException('no such session profile parameter: %s' % parameter) + raise X2GoProfileException('no such session profile parameter: %s' % parameter) return _profile_config def default_profile_config(self): @@ -260,7 +260,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): try: self.check_profile_id_or_name(profile_id_or_name) return True - except X2goProfileException: + except X2GoProfileException: return False @property @@ -326,7 +326,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): elif len(_profile_ids) == 0: return None else: - raise X2goProfileException('The sessions config file contains multiple session profiles with name: %s' % profile_name) + raise X2GoProfileException('The sessions config file contains multiple session profiles with name: %s' % profile_name) def to_profile_name(self, profile_id): """\ @@ -400,16 +400,16 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): """ try: profile_id = profile_id or self.check_profile_id_or_name(section) - except X2goProfileException: + except X2GoProfileException: profile_id = section if key == 'name': profile_name = value current_profile_name = self.get_value(profile_id, key) if not profile_name: - raise X2goProfileException('profile name for profile id %s may not be empty' % profile_id) + raise X2GoProfileException('profile name for profile id %s may not be empty' % profile_id) else: if profile_name != current_profile_name and profile_name in self.profile_names: - raise X2goProfileException('a profile of name ,,%s'' already exists' % profile_name) + raise X2GoProfileException('a profile of name ,,%s'' already exists' % profile_name) self._cached_profile_names = [] if key == 'export' and type(value) == types.DictType: @@ -425,7 +425,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): if _config.has_key('host') and _config['host'] != value: self._profiles_need_profile_id_renewal.append(profile_id) - inifiles.X2goIniFile.update_value(self, profile_id, key, value) + inifiles.X2GoIniFile.update_value(self, profile_id, key, value) def check_profile_id_or_name(self, profile_id_or_name): """\ @@ -437,7 +437,7 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): @return: profile ID @rtype: C{str} - @raise X2goProfileException: if no such session profile exists + @raise X2GoProfileException: if no such session profile exists """ _profile_id = None @@ -448,19 +448,19 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): # we were given a session profile id... _profile_id = profile_id_or_name else: - raise X2goProfileException('No session profile with id or name ,,%s\'\' exists.' % profile_id_or_name) + raise X2GoProfileException('No session profile with id or name ,,%s\'\' exists.' % profile_id_or_name) return _profile_id def to_session_params(self, profile_id_or_name=None, profile_id=None): """\ - Convert session profile options to L{X2goSession} constructor method parameters. + Convert session profile options to L{X2GoSession} constructor method parameters. @param profile_id_or_name: either profile ID or profile name is accepted @type profile_id_or_name: C{str} @param profile_id: profile ID (fast than specifying C{profile_id_or_name}) @type profile_id: C{str} - @return: a dictionary of L{X2goSession} constructor method parameters + @return: a dictionary of L{X2GoSession} constructor method parameters @rtype: C{dict} """ @@ -469,11 +469,11 @@ class X2goSessionProfilesFILE(inifiles.X2goIniFile): def get_session_param(self, profile_id_or_name, param): """\ - Get a single L{X2goSession} parameter from a specific session profile. + Get a single L{X2GoSession} parameter from a specific session profile. @param profile_id_or_name: either profile ID or profile name is accepted @type profile_id_or_name: C{str} - @param param: the parameter name in the L{X2goSession} constructor method + @param param: the parameter name in the L{X2GoSession} constructor method @type param: C{str} @return: the value of the session profile option represented by C{param} diff --git a/x2go/backends/profiles/_gconf.py b/x2go/backends/profiles/_gconf.py index 1926e44..35afb88 100644 --- a/x2go/backends/profiles/_gconf.py +++ b/x2go/backends/profiles/_gconf.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goSessionProfiles} class - managing x2goclient session profiles. +L{X2GoSessionProfiles} class - managing x2goclient session profiles. -L{X2goSessionProfiles} is a public API class. Use this class in your Python X2Go based +L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based applications. """ @@ -32,9 +32,9 @@ from x2go.defaults import X2GO_SESSIONPROFILE_DEFAULTS import x2go.inifiles as inifiles import x2go.log as log -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goSessionProfilesGCONF(inifiles.X2goIniFile): +class X2GoSessionProfilesGCONF(inifiles.X2GoIniFile): defaultSessionProfile = X2GO_SESSIONPROFILE_DEFAULTS _non_profile_sections = ('embedded') @@ -45,12 +45,12 @@ class X2goSessionProfilesGCONF(inifiles.X2goIniFile): @param session_profile_defaults: a default session profile @type session_profile_defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goSessionProfilesGCONF} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoSessionProfilesGCONF} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ - raise X2goNotImplementedYetException('GCONF backend support is not implemented yet') + raise X2GoNotImplementedYetException('GCONF backend support is not implemented yet') diff --git a/x2go/backends/profiles/_httpsbroker.py b/x2go/backends/profiles/_httpsbroker.py index b56b237..ce17c04 100644 --- a/x2go/backends/profiles/_httpsbroker.py +++ b/x2go/backends/profiles/_httpsbroker.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goSessionProfiles} class - managing x2goclient session profiles. +L{X2GoSessionProfiles} class - managing x2goclient session profiles. -L{X2goSessionProfiles} is a public API class. Use this class in your Python X2Go based +L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based applications. """ @@ -32,9 +32,9 @@ from x2go.defaults import X2GO_SESSIONPROFILE_DEFAULTS import x2go.inifiles as inifiles import x2go.log as log -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goSessionProfilesHTTPSBROKER(inifiles.X2goIniFile): +class X2GoSessionProfilesHTTPSBROKER(inifiles.X2GoIniFile): defaultSessionProfile = X2GO_SESSIONPROFILE_DEFAULTS _non_profile_sections = ('embedded') @@ -45,12 +45,12 @@ class X2goSessionProfilesHTTPSBROKER(inifiles.X2goIniFile): @param session_profile_defaults: a default session profile @type session_profile_defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goSessionProfilesHTTPSBROKER} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoSessionProfilesHTTPSBROKER} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ - raise X2goNotImplementedYetException('HTTPSBROKER backend support is not implemented yet') + raise X2GoNotImplementedYetException('HTTPSBROKER backend support is not implemented yet') diff --git a/x2go/backends/profiles/_winreg.py b/x2go/backends/profiles/_winreg.py index 7fb1319..0ee9bca 100644 --- a/x2go/backends/profiles/_winreg.py +++ b/x2go/backends/profiles/_winreg.py @@ -18,9 +18,9 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goSessionProfiles} class - managing x2goclient session profiles. +L{X2GoSessionProfiles} class - managing x2goclient session profiles. -L{X2goSessionProfiles} is a public API class. Use this class in your Python X2Go based +L{X2GoSessionProfiles} is a public API class. Use this class in your Python X2Go based applications. """ @@ -32,9 +32,9 @@ from x2go.defaults import X2GO_SESSIONPROFILE_DEFAULTS import x2go.inifiles as inifiles import x2go.log as log -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goSessionProfilesWINREG(inifiles.X2goIniFile): +class X2GoSessionProfilesWINREG(inifiles.X2GoIniFile): defaultSessionProfile = X2GO_SESSIONPROFILE_DEFAULTS _non_profile_sections = ('embedded') @@ -45,13 +45,13 @@ class X2goSessionProfilesWINREG(inifiles.X2goIniFile): @param session_profile_defaults: a default session profile @type session_profile_defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goSessionProfilesWINREG} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoSessionProfilesWINREG} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ - raise X2goNotImplementedYetException('WINREG backend support is not implemented yet') + raise X2GoNotImplementedYetException('WINREG backend support is not implemented yet') diff --git a/x2go/backends/proxy/__init__.py b/x2go/backends/proxy/__init__.py index 4b15847..a1f6ebe 100644 --- a/x2go/backends/proxy/__init__.py +++ b/x2go/backends/proxy/__init__.py @@ -19,6 +19,6 @@ from x2go.defaults import BACKEND_PROXY_DEFAULT -from _nx3 import X2goProxyNX3 +from _nx3 import X2GoProxyNX3 -X2goProxy = eval(BACKEND_PROXY_DEFAULT) +X2GoProxy = eval(BACKEND_PROXY_DEFAULT) diff --git a/x2go/backends/proxy/_nx3.py b/x2go/backends/proxy/_nx3.py index 22ba3ef..67cc00e 100644 --- a/x2go/backends/proxy/_nx3.py +++ b/x2go/backends/proxy/_nx3.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goProxy classes - proxying your connection through NX3 and others. +X2GoProxy classes - proxying your connection through NX3 and others. """ __NAME__ = 'x2goproxynx3-pylib' @@ -32,20 +32,20 @@ import base from x2go.defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS -class X2goProxyNX3(base.X2goProxyBASE): +class X2GoProxyNX3(base.X2GoProxyBASE): """\ - X2goNX3Proxy is a NX version 3 based X2Go proxy connection class. + X2GoNX3Proxy is a NX version 3 based X2Go proxy connection class. - It basically fills L{X2goProxyBASE} variables with sensible content. Its + It basically fills L{X2GoProxyBASE} variables with sensible content. Its methods mostly wrap around the corresponding methods of the parent class. """ def __init__(self, *args, **kwargs): """\ - For available parameters refer to L{X2goProxyBASE} class documentation. + For available parameters refer to L{X2GoProxyBASE} class documentation. """ - base.X2goProxyBASE.__init__(self, *args, **kwargs) + base.X2GoProxyBASE.__init__(self, *args, **kwargs) # setting some default environment variables, nxproxy paths etc. if _X2GOCLIENT_OS == "Windows": @@ -136,7 +136,7 @@ class X2goProxyNX3(base.X2goProxyBASE): self.logger('NX3 Proxy mode is server, cookie=%s, host=127.0.0.1, port=%s.' % (self.session_info.cookie, self.session_info.graphics_port,), loglevel=log.loglevel_DEBUG) self.logger('NX3 proxy writes session log to %s.' % os.path.join(self.session_info.local_container, 'session.log'), loglevel=log.loglevel_DEBUG) - p, p_ok = base.X2goProxyBASE.start_proxy(self) + p, p_ok = base.X2GoProxyBASE.start_proxy(self) if self.ok(): self.logger('NX3 proxy is up and running.', loglevel=log.loglevel_INFO) diff --git a/x2go/backends/proxy/base.py b/x2go/backends/proxy/base.py index 38e80da..31af34e 100644 --- a/x2go/backends/proxy/base.py +++ b/x2go/backends/proxy/base.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goProxyBASE class - proxying your connection through NX3 and others. +X2GoProxyBASE class - proxying your connection through NX3 and others. """ __NAME__ = 'x2goproxy-pylib' @@ -47,12 +47,12 @@ from x2go.defaults import LOCAL_HOME as _LOCAL_HOME from x2go.defaults import X2GO_SESSIONS_ROOTDIR as _X2GO_SESSIONS_ROOTDIR -class X2goProxyBASE(threading.Thread): +class X2GoProxyBASE(threading.Thread): """\ - X2goProxy is an abstract class for X2Go proxy connections. + X2GoProxy is an abstract class for X2Go proxy connections. This class needs to be inherited from a concrete proxy class. Only - currently available proxy class is: L{X2goProxyNX3}. + currently available proxy class is: L{X2GoProxyNX3}. """ PROXY_CMD = '' @@ -75,30 +75,30 @@ class X2goProxyBASE(threading.Thread): session_instance=None, logger=None, loglevel=log.loglevel_DEFAULT, ): """\ - @param session_info: session information provided as an C{X2goServerSessionInfo*} backend + @param session_info: session information provided as an C{X2GoServerSessionInfo*} backend instance - @type session_info: C{X2goServerSessionInfo*} instance + @type session_info: C{X2GoServerSessionInfo*} instance @param ssh_transport: SSH transport object from C{paramiko.SSHClient} @type ssh_transport: C{paramiko.Transport} instance @param session_log: name of the proxy's session logfile @type session_log: C{str} @param sessions_rootdir: base dir where X2Go session files are stored (by default: ~/.x2go) @type sessions_rootdir: C{str} - @param proxy_options: a set of very C{X2goProxy*} backend specific options; any option that is not known - to the C{X2goProxy*} backend will simply be ignored + @param proxy_options: a set of very C{X2GoProxy*} backend specific options; any option that is not known + to the C{X2GoProxy*} backend will simply be ignored @type proxy_options: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goProxy} constructor - @param session_instance: the L{X2goSession} instance this C{X2goProxy*} instance belongs to - @type session_instance: L{X2goSession} instance - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoProxy} constructor + @param session_instance: the L{X2GoSession} instance this C{X2GoProxy*} instance belongs to + @type session_instance: L{X2GoSession} instance + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: int """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -180,7 +180,7 @@ class X2goProxyBASE(threading.Thread): if self.ssh_transport.getpeername() in ('::1', '127.0.0.1', 'localhost', 'localhost.localdomain'): local_graphics_port += 10000 except socket.error: - raise x2go_exceptions.X2goControlSessionException('The control session has died unexpectedly.') + raise x2go_exceptions.X2GoControlSessionException('The control session has died unexpectedly.') local_graphics_port = utils.detect_unused_port(preferred_port=local_graphics_port) self.fw_tunnel = forward.start_forward_tunnel(local_port=local_graphics_port, @@ -244,7 +244,7 @@ class X2goProxyBASE(threading.Thread): 1. remove processed proxy_options from self.proxy_options 2. once you have finished processing the proxy_options call - the parent class method X2goProxyBASE.process_proxy_options() + the parent class method X2GoProxyBASE.process_proxy_options() """ # do the logging of remaining options diff --git a/x2go/backends/settings/__init__.py b/x2go/backends/settings/__init__.py index a1cb355..75841d1 100644 --- a/x2go/backends/settings/__init__.py +++ b/x2go/backends/settings/__init__.py @@ -19,9 +19,9 @@ from x2go.defaults import BACKEND_CLIENTSETTINGS_DEFAULT -from _file import X2goClientSettingsFILE -from _gconf import X2goClientSettingsGCONF -from _winreg import X2goClientSettingsWINREG +from _file import X2GoClientSettingsFILE +from _gconf import X2GoClientSettingsGCONF +from _winreg import X2GoClientSettingsWINREG -X2goClientSettings = eval(BACKEND_CLIENTSETTINGS_DEFAULT) +X2GoClientSettings = eval(BACKEND_CLIENTSETTINGS_DEFAULT) diff --git a/x2go/backends/settings/_file.py b/x2go/backends/settings/_file.py index 14b5c56..0044127 100644 --- a/x2go/backends/settings/_file.py +++ b/x2go/backends/settings/_file.py @@ -18,10 +18,10 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goClientSettings class - managing x2goclient settings file (incl. LDAP-Support). +X2GoClientSettings class - managing x2goclient settings file (incl. LDAP-Support). -The L{X2goClientSettings} class one of Python X2go's a public API classes. -Use this class (indirectly by retrieving it from an L{X2goClient} instance) +The L{X2GoClientSettings} class one of Python X2Go's a public API classes. +Use this class (indirectly by retrieving it from an L{X2GoClient} instance) in your Python X2Go based applications to access the »settings« configuration file of your X2Go client application. @@ -35,20 +35,20 @@ from x2go.defaults import X2GO_CLIENTSETTINGS_DEFAULTS as _X2GO_CLIENTSETTINGS_D import x2go.inifiles as inifiles -class X2goClientSettingsFILE(inifiles.X2goIniFile): +class X2GoClientSettingsFILE(inifiles.X2GoIniFile): """\ - Configuration file based settings for L{X2goClient} instances. + Configuration file based settings for L{X2GoClient} instances. """ defaultValues = _X2GO_CLIENTSETTINGS_DEFAULTS def __init__(self, config_files=_X2GO_SETTINGS_CONFIGFILES, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - Constructs an L{X2goClientSettingsFILE} instance. This is normally done from within an L{X2goClient} instance. - You can retrieve this L{X2goClientSettingsFILE} instance with the L{X2goClient.get_client_settings()} + Constructs an L{X2GoClientSettingsFILE} instance. This is normally done from within an L{X2GoClient} instance. + You can retrieve this L{X2GoClientSettingsFILE} instance with the L{X2GoClient.get_client_settings()} method. - On construction the L{X2goClientSettingsFILE} object is filled with values from the configuration files:: + On construction the L{X2GoClientSettingsFILE} object is filled with values from the configuration files:: /etc/x2goclient/settings ~/.x2goclient/settings @@ -58,4 +58,4 @@ class X2goClientSettingsFILE(inifiles.X2goIniFile): C{/etc/x2goclient/settings}. """ - inifiles.X2goIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) + inifiles.X2GoIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) diff --git a/x2go/backends/settings/_gconf.py b/x2go/backends/settings/_gconf.py index a20bcbb..f544b16 100644 --- a/x2go/backends/settings/_gconf.py +++ b/x2go/backends/settings/_gconf.py @@ -18,10 +18,10 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goClientSettings class - managing x2goclient settings file (incl. LDAP-Support). +X2GoClientSettings class - managing x2goclient settings file (incl. LDAP-Support). -The L{X2goClientSettings} class one of Python X2go's a public API classes. -Use this class (indirectly by retrieving it from an L{X2goClient} instance) +The L{X2GoClientSettings} class one of Python X2Go's a public API classes. +Use this class (indirectly by retrieving it from an L{X2GoClient} instance) in your Python X2Go based applications to access the »settings« configuration file of your X2Go client application. @@ -34,25 +34,25 @@ from x2go.defaults import X2GO_SETTINGS_CONFIGFILES as _X2GO_SETTINGS_CONFIGFILE from x2go.defaults import X2GO_CLIENTSETTINGS_DEFAULTS as _X2GO_CLIENTSETTINGS_DEFAULTS import x2go.inifiles as inifiles -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goClientSettingsGCONF(inifiles.X2goIniFile): +class X2GoClientSettingsGCONF(inifiles.X2GoIniFile): """\ - Configure settings for L{X2goClient} instances with the GConf daemon. + Configure settings for L{X2GoClient} instances with the GConf daemon. """ defaultValues = _X2GO_CLIENTSETTINGS_DEFAULTS def __init__(self, config_files=_X2GO_SETTINGS_CONFIGFILES, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - Constructs an L{X2goClientSettingsGCONF} instance. This is normally done from within an L{X2goClient} instance. - You can retrieve this L{X2goClientSettingsGCONF} instance with the L{X2goClient.get_client_settings()} + Constructs an L{X2GoClientSettingsGCONF} instance. This is normally done from within an L{X2GoClient} instance. + You can retrieve this L{X2GoClientSettingsGCONF} instance with the L{X2GoClient.get_client_settings()} method. - On construction the L{X2goClientSettingsGCONF} object is filled with values as found in GConf:: + On construction the L{X2GoClientSettingsGCONF} object is filled with values as found in GConf:: <GConf paths, FIXME: give proper locations here> """ - raise X2goNotImplementedYetException('GCONF backend support is not implemented yet') + raise X2GoNotImplementedYetException('GCONF backend support is not implemented yet') diff --git a/x2go/backends/settings/_winreg.py b/x2go/backends/settings/_winreg.py index c5f6f31..9f6f37b 100644 --- a/x2go/backends/settings/_winreg.py +++ b/x2go/backends/settings/_winreg.py @@ -18,10 +18,10 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goClientSettings class - managing x2goclient settings file (incl. LDAP-Support). +X2GoClientSettings class - managing x2goclient settings file (incl. LDAP-Support). -The L{X2goClientSettings} class one of Python X2go's a public API classes. -Use this class (indirectly by retrieving it from an L{X2goClient} instance) +The L{X2GoClientSettings} class one of Python X2Go's a public API classes. +Use this class (indirectly by retrieving it from an L{X2GoClient} instance) in your Python X2Go based applications to access the »settings« configuration file of your X2Go client application. @@ -34,25 +34,25 @@ from x2go.defaults import X2GO_SETTINGS_CONFIGFILES as _X2GO_SETTINGS_CONFIGFILE from x2go.defaults import X2GO_CLIENTSETTINGS_DEFAULTS as _X2GO_CLIENTSETTINGS_DEFAULTS import x2go.inifiles as inifiles -from x2go.x2go_exceptions import X2goNotImplementedYetException +from x2go.x2go_exceptions import X2GoNotImplementedYetException -class X2goClientSettingsWINREG(inifiles.X2goIniFile): +class X2GoClientSettingsWINREG(inifiles.X2GoIniFile): """\ - Windows registry based settings for L{X2goClient} instances. + Windows registry based settings for L{X2GoClient} instances. """ defaultValues = _X2GO_CLIENTSETTINGS_DEFAULTS def __init__(self, config_files=_X2GO_SETTINGS_CONFIGFILES, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - Constructs an L{X2goClientSettingsWINREG} instance. This is normally done from within an L{X2goClient} instance. - You can retrieve this L{X2goClientSettingsWINREG} instance with the L{X2goClient.get_client_settings()} + Constructs an L{X2GoClientSettingsWINREG} instance. This is normally done from within an L{X2GoClient} instance. + You can retrieve this L{X2GoClientSettingsWINREG} instance with the L{X2GoClient.get_client_settings()} method. - On construction the L{X2goClientSettings} object is filled with values from the Windows registry:: + On construction the L{X2GoClientSettings} object is filled with values from the Windows registry:: <HKLM path, FIXME: give proper locations here> <HKCU path, FIXME: give proper locations here> """ - raise X2goNotImplementedYetException('WINREG backend support is not implemented yet') + raise X2GoNotImplementedYetException('WINREG backend support is not implemented yet') diff --git a/x2go/backends/terminal/__init__.py b/x2go/backends/terminal/__init__.py index 315441e..f52da17 100644 --- a/x2go/backends/terminal/__init__.py +++ b/x2go/backends/terminal/__init__.py @@ -19,6 +19,6 @@ from x2go.defaults import BACKEND_TERMINALSESSION_DEFAULT -from _stdout import X2goTerminalSessionSTDOUT +from _stdout import X2GoTerminalSessionSTDOUT -X2goTerminalSession = eval(BACKEND_TERMINALSESSION_DEFAULT) +X2GoTerminalSession = eval(BACKEND_TERMINALSESSION_DEFAULT) diff --git a/x2go/backends/terminal/_stdout.py b/x2go/backends/terminal/_stdout.py index 6f474c0..6044a56 100644 --- a/x2go/backends/terminal/_stdout.py +++ b/x2go/backends/terminal/_stdout.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goTerminalSession class - core functions for handling your individual X2Go sessions. +X2GoTerminalSession class - core functions for handling your individual X2Go sessions. This backend handles X2Go server implementations that respond with session infos via server-side STDOUT and use NX3 as graphical proxy. @@ -54,10 +54,10 @@ from x2go.defaults import X2GO_SESSIONS_ROOTDIR as _X2GO_SESSIONS_ROOTDIR from x2go.defaults import X2GO_GENERIC_APPLICATIONS as _X2GO_GENERIC_APPLICATIONS from x2go.defaults import X2GO_DESKTOPSESSIONS as _X2GO_DESKTOPSESSIONS -from x2go.backends.info import X2goServerSessionInfo as _X2goServerSessionInfo -from x2go.backends.info import X2goServerSessionList as _X2goServerSessionList -from x2go.backends.proxy import X2goProxy as _X2goProxy -from x2go.backends.printing import X2goClientPrinting as _X2goClientPrinting +from x2go.backends.info import X2GoServerSessionInfo as _X2GoServerSessionInfo +from x2go.backends.info import X2GoServerSessionList as _X2GoServerSessionList +from x2go.backends.proxy import X2GoProxy as _X2GoProxy +from x2go.backends.printing import X2GoClientPrinting as _X2GoClientPrinting _local_color_depth = utils.local_color_depth() @@ -69,7 +69,7 @@ def _rewrite_cmd(cmd, params=None): @param cmd: the current command for execution (as found in the session profile parameter C{cmd}) @type cmd: C{str} @param params: an session paramter object - @type params: L{X2goSessionParams} + @type params: L{X2GoSessionParams} @return: the rewritten command for server-side execution @rtype: C{str} @@ -82,7 +82,7 @@ def _rewrite_cmd(cmd, params=None): if cmd in _X2GO_DESKTOPSESSIONS.keys(): cmd = _X2GO_DESKTOPSESSIONS[cmd] - if (cmd == 'RDP') and (type(params) == X2goSessionParams): + if (cmd == 'RDP') and (type(params) == X2GoSessionParams): _depth = params.depth if int(_depth) == 17: _depth = 16 @@ -95,7 +95,7 @@ def _rewrite_cmd(cmd, params=None): if cmd: cmd = '"%s"' % cmd - if ((type(params) == X2goSessionParams) and params.published_applications and cmd == ''): + if ((type(params) == X2GoSessionParams) and params.published_applications and cmd == ''): cmd = 'PUBLISHED' return cmd @@ -118,10 +118,10 @@ def _rewrite_blanks(cmd): return cmd -class X2goSessionParams(object): +class X2GoSessionParams(object): """\ - The L{X2goSessionParams} class is used to store all parameters that - C{X2goTerminalSession} backend objects are constructed with. + The L{X2GoSessionParams} class is used to store all parameters that + C{X2GoTerminalSession} backend objects are constructed with. """ def rewrite_session_type(self): @@ -169,12 +169,12 @@ class X2goSessionParams(object): def update(self, **properties_to_be_updated): """\ - Update all properties in the object L{X2goSessionParams} object from + Update all properties in the object L{X2GoSessionParams} object from the passed on dictionary. - @param properties_to_be_updated: a dictionary with L{X2goSessionParams} + @param properties_to_be_updated: a dictionary with L{X2GoSessionParams} property names as keys und their values to be update in - L{X2goSessionParams} object. + L{X2GoSessionParams} object. @type properties_to_be_updated: C{dict} """ @@ -183,25 +183,25 @@ class X2goSessionParams(object): self.rewrite_session_type() -class X2goTerminalSessionSTDOUT(object): +class X2GoTerminalSessionSTDOUT(object): """\ Class for managing X2Go terminal sessions on a remote X2Go server via Paramiko/SSH. - With the L{X2goTerminalSessionSTDOUT} class you can start new X2Go sessions, resume suspended + With the L{X2GoTerminalSessionSTDOUT} class you can start new X2Go sessions, resume suspended sessions or suspend resp. terminate currently running sessions on a connected X2Go server. - An L{X2goTerminalSessionSTDOUT} object uses two main data structure classes: + An L{X2GoTerminalSessionSTDOUT} object uses two main data structure classes: - - L{X2goSessionParams}: stores all parameters that have been passed to the + - L{X2GoSessionParams}: stores all parameters that have been passed to the constructor method. - - C{X2goServerSessionInfo*} backend class: when starting or resuming a session, an object of this class + - C{X2GoServerSessionInfo*} backend class: when starting or resuming a session, an object of this class will be used to store all information retrieved from the X2Go server. The terminal session instance works closely together (i.e. depends on) a connected control - session instance (e.g. L{X2goControlSessionSTDOUT}). You never should use either of them as a standalone - instance. Both, control session and terminal session(s) get managed/controlled via L{X2goSession} instances. + session instance (e.g. L{X2GoControlSessionSTDOUT}). You never should use either of them as a standalone + instance. Both, control session and terminal session(s) get managed/controlled via L{X2GoSession} instances. """ def __init__(self, control_session, session_info=None, @@ -217,16 +217,16 @@ class X2goTerminalSessionSTDOUT(object): rootdir=None, profile_name='UNKNOWN', profile_id=utils._genSessionProfileId(), print_action=None, print_action_args={}, - info_backend=_X2goServerSessionInfo, - list_backend=_X2goServerSessionList, - proxy_backend=_X2goProxy, proxy_options={}, - printing_backend=_X2goClientPrinting, + info_backend=_X2GoServerSessionInfo, + list_backend=_X2GoServerSessionList, + proxy_backend=_X2GoProxy, proxy_options={}, + printing_backend=_X2GoClientPrinting, client_rootdir=os.path.join(_LOCAL_HOME, _X2GO_CLIENT_ROOTDIR), sessions_rootdir=os.path.join(_LOCAL_HOME, _X2GO_SESSIONS_ROOTDIR), session_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - Initialize an X2Go session. With the L{X2goTerminalSessionSTDOUT} class you can start + Initialize an X2Go session. With the L{X2GoTerminalSessionSTDOUT} class you can start new X2Go sessions, resume suspended sessions or suspend resp. terminate currently running sessions on a connected X2Go server. @@ -241,8 +241,8 @@ class X2goTerminalSessionSTDOUT(object): @type pack: C{str} @param dpi: dots-per-inch value for the session screen (has an impact on the font size on screen) @type dpi: C{str} - @param cache_type: a dummy parameter that is passed to the L{X2goProxyBASE}. In NX Proxy - (class C{X2goProxyNX3}) this originally is the session name. With X2Go it + @param cache_type: a dummy parameter that is passed to the L{X2GoProxyBASE}. In NX Proxy + (class C{X2GoProxyNX3}) this originally is the session name. With X2Go it defines the name of the NX cache directory. Best is to leave it untouched. @type cache_type: C{str} @param kbtype: keyboard type, e.g. C{pc105/us} (default), C{pc105/de}, ... @@ -259,7 +259,7 @@ class X2goTerminalSessionSTDOUT(object): @param snd_port: local sound port for network capable audio system @type snd_port: C{int} @param cmd: command to be run on X2Go server after session start (only used - when L{X2goTerminalSessionSTDOUT.start()} is called, ignored on resume, suspend etc. + when L{X2GoTerminalSessionSTDOUT.start()} is called, ignored on resume, suspend etc. @type cmd: C{str} @param published_applications: session is published applications provider @type published_applications: C{bool} @@ -288,30 +288,30 @@ class X2goTerminalSessionSTDOUT(object): @param profile_id: the session profile ID for this terminal session @type profile_id: C{str} @param print_action: either a print action short name (PDFVIEW, PDFSAVE, PRINT, PRINTCMD) or the - resp. C{X2goPrintActionXXX} class (where XXX equals one of the given short names) + resp. C{X2GoPrintActionXXX} class (where XXX equals one of the given short names) @type print_action: C{str} or C{class} @param print_action_args: optional arguments for a given print_action (for further info refer to - L{X2goPrintActionPDFVIEW}, L{X2goPrintActionPDFSAVE}, L{X2goPrintActionPRINT} and L{X2goPrintActionPRINTCMD}) + L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPDFSAVE}, L{X2GoPrintActionPRINT} and L{X2GoPrintActionPRINTCMD}) @type print_action_args: dict @param info_backend: backend for handling storage of server session information - @type info_backend: C{X2goServerSessionInfo*} instance + @type info_backend: C{X2GoServerSessionInfo*} instance @param list_backend: backend for handling storage of session list information - @type list_backend: C{X2goServerSessionList*} instance + @type list_backend: C{X2GoServerSessionList*} instance @param proxy_backend: backend for handling the X-proxy connections - @type proxy_backend: C{X2goProxy*} instance - @param proxy_options: a set of very C{X2goProxy*} backend specific options; any option that is not known - to the C{X2goProxy*} backend will simply be ignored + @type proxy_backend: C{X2GoProxy*} instance + @param proxy_options: a set of very C{X2GoProxy*} backend specific options; any option that is not known + to the C{X2GoProxy*} backend will simply be ignored @type proxy_options: C{dict} @param client_rootdir: client base dir (default: ~/.x2goclient) @type client_rootdir: C{str} @param sessions_rootdir: sessions base dir (default: ~/.x2go) @type sessions_rootdir: C{str} - @param session_instance: the L{X2goSession} instance that is parent to this terminal session + @param session_instance: the L{X2GoSession} instance that is parent to this terminal session @type session_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goTerminalSessionSTDOUT} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoTerminalSessionSTDOUT} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -327,7 +327,7 @@ class X2goTerminalSessionSTDOUT(object): self.mimebox_queue = None if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -338,7 +338,7 @@ class X2goTerminalSessionSTDOUT(object): self.client_rootdir = client_rootdir self.sessions_rootdir = sessions_rootdir - self.params = X2goSessionParams() + self.params = X2GoSessionParams() self.params.geometry = str(geometry) self.params.link = str(link) @@ -391,7 +391,7 @@ class X2goTerminalSessionSTDOUT(object): if self.session_info.name: self.session_info.local_container = os.path.join(self.params.rootdir, 'S-%s' % self.session_info.name) else: - raise x2go_exceptions.X2goTerminalSessionException('no valid session info availble') + raise x2go_exceptions.X2GoTerminalSessionException('no valid session info availble') else: self.session_info = info_backend() @@ -485,7 +485,7 @@ class X2goTerminalSessionSTDOUT(object): Retrieve the X2Go session's session info object. @return: the session info object - @rtype: C{X2goServerSessionInfo*} + @rtype: C{X2GoServerSessionInfo*} """ return self.session_info @@ -519,7 +519,7 @@ class X2goTerminalSessionSTDOUT(object): - PulseAudio - Esound (not tested very much) - @raise X2goControlSessionException: if the control session of this terminal session is not connected + @raise X2GoControlSessionException: if the control session of this terminal session is not connected """ _tunnel = None @@ -538,7 +538,7 @@ class X2goTerminalSessionSTDOUT(object): self.control_session._x2go_sftp_put(local_path='%s/.pulse-cookie' % _LOCAL_HOME, remote_path='%s/.pulse-cookie' % self.session_info.remote_container) # start reverse SSH tunnel for pulse stream - _tunnel = rforward.X2goRevFwTunnel(server_port=self.session_info.snd_port, + _tunnel = rforward.X2GoRevFwTunnel(server_port=self.session_info.snd_port, remote_host='127.0.0.1', remote_port=self.snd_port, ssh_transport=self.control_session.get_transport(), @@ -563,7 +563,7 @@ class X2goTerminalSessionSTDOUT(object): self.control_session._x2go_sftp_put(local_path='%s/.esd_auth' % _LOCAL_HOME, remote_path='%s/.esd_auth' % self.control_session._x2go_remote_home) # start reverse SSH tunnel for pulse stream - _tunnel = rforward.X2goRevFwTunnel(server_port=self.session_info.snd_port, + _tunnel = rforward.X2GoRevFwTunnel(server_port=self.session_info.snd_port, remote_host='127.0.0.1', remote_port=self.snd_port, ssh_transport=self.control_session.get_transport(), @@ -587,13 +587,13 @@ class X2goTerminalSessionSTDOUT(object): """ if not self.control_session.is_sshfs_available(): - raise x2go_exceptions.X2goUserException('Remote user %s is not allowed to share SSHFS resources with the server.' % self.session_info.username) + raise x2go_exceptions.X2GoUserException('Remote user %s is not allowed to share SSHFS resources with the server.' % self.session_info.username) # start reverse SSH tunnel for sshfs (folder sharing, printing) ssh_transport = self.control_session.get_transport() if self.reverse_tunnels[self.session_info.name]['sshfs'][1] is None: - _tunnel = sftpserver.X2goRevFwTunnelToSFTP(server_port=self.session_info.sshfs_port, + _tunnel = sftpserver.X2GoRevFwTunnelToSFTP(server_port=self.session_info.sshfs_port, ssh_transport=ssh_transport, auth_key=self.control_session._x2go_session_auth_rsakey, session_instance=self.session_instance, @@ -641,17 +641,17 @@ class X2goTerminalSessionSTDOUT(object): """\ Initialize X2Go print spooling. - @raise X2goUserException: if the X2Go printing feature is not available to this user + @raise X2GoUserException: if the X2Go printing feature is not available to this user """ if not self.control_session.is_sshfs_available(): - raise x2go_exceptions.X2goUserException('Remote user %s is not allowed to use client-side printing.' % self.session_info.username) + raise x2go_exceptions.X2GoUserException('Remote user %s is not allowed to use client-side printing.' % self.session_info.username) spool_dir = os.path.join(self.session_info.local_container, 'spool') if not os.path.exists(spool_dir): os.makedirs(spool_dir) self.share_local_folder(local_path=spool_dir, folder_type='spool') - self.print_queue = printqueue.X2goPrintQueue(profile_name=self.profile_name, + self.print_queue = printqueue.X2GoPrintQueue(profile_name=self.profile_name, session_name=self.session_info.name, spool_dir=spool_dir, print_action=self.print_action, @@ -667,10 +667,10 @@ class X2goTerminalSessionSTDOUT(object): """\ Set a print action for the next incoming print jobs. - This method is a wrapper for L{X2goPrintQueue}C{.set_print_action()}. + This method is a wrapper for L{X2GoPrintQueue}C{.set_print_action()}. - @param print_action: print action name or object (i.e. an instance of C{X2goPrintAction*} classes) - @type print_action: C{str} or C{X2goPrintAction*} + @param print_action: print action name or object (i.e. an instance of C{X2GoPrintAction*} classes) + @type print_action: C{str} or C{X2GoPrintAction*} @param kwargs: print action specific parameters @type kwargs: dict @@ -701,20 +701,20 @@ class X2goTerminalSessionSTDOUT(object): @param mimebox_extensions: file name extensions that are allowed for local opening/processing @type mimebox_extensions: C{list} - @param mimebox_action: MIME box action given as name or object (i.e. an instance of C{X2goMIMEboxAction*} classes). + @param mimebox_action: MIME box action given as name or object (i.e. an instance of C{X2GoMIMEboxAction*} classes). @type mimebox_action: C{str} or C{obj} - @raise X2goUserException: if the X2Go MIME box feature is not available to this user + @raise X2GoUserException: if the X2Go MIME box feature is not available to this user """ if not self.control_session.is_sshfs_available(): - raise x2go_exceptions.X2goUserException('Remote user %s is not allowed to use the MIME box.' % self.session_info.username) + raise x2go_exceptions.X2GoUserException('Remote user %s is not allowed to use the MIME box.' % self.session_info.username) mimebox_dir = os.path.join(self.session_info.local_container, 'mimebox') if not os.path.exists(mimebox_dir): os.makedirs(mimebox_dir) self.share_local_folder(local_path=mimebox_dir, folder_type='mimebox') - self.mimebox_queue = mimebox.X2goMIMEboxQueue(profile_name=self.profile_name, + self.mimebox_queue = mimebox.X2GoMIMEboxQueue(profile_name=self.profile_name, session_name=self.session_info.name, mimebox_dir=mimebox_dir, mimebox_extensions=mimebox_extensions, @@ -729,10 +729,10 @@ class X2goTerminalSessionSTDOUT(object): """\ Set a MIME box action for the next incoming MIME jobs. - This method is a wrapper for L{X2goMIMEboxQueue}C{set_mimebox_action()}. + This method is a wrapper for L{X2GoMIMEboxQueue}C{set_mimebox_action()}. - @param mimebox_action: MIME box action name or object (i.e. an instance of C{X2goMIMEboxAction*} classes) - @type mimebox_action: C{str} or C{X2goMIMEboxAction*} + @param mimebox_action: MIME box action name or object (i.e. an instance of C{X2GoMIMEboxAction*} classes) + @type mimebox_action: C{str} or C{X2GoMIMEboxAction*} @param kwargs: MIME box action specific parameters @type kwargs: dict @@ -795,12 +795,12 @@ class X2goTerminalSessionSTDOUT(object): @return: returns C{True} if the local folder has been successfully mounted within the X2Go server session @rtype: C{bool} - @raise X2goUserException: if local folder sharing is not available to this user + @raise X2GoUserException: if local folder sharing is not available to this user @raise Exception: any other exception occuring on the way is passed through by this method """ if not self.control_session.is_sshfs_available(): - raise x2go_exceptions.X2goUserException('Remote user %s is not allowed to share local folders with the server.' % self.session_info.username) + raise x2go_exceptions.X2GoUserException('Remote user %s is not allowed to share local folders with the server.' % self.session_info.username) if local_path is None: self.logger('no folder name given...', log.loglevel_WARN) @@ -1148,8 +1148,8 @@ class X2goTerminalSessionSTDOUT(object): """\ Run a command in this session. - After L{X2goTerminalSessionSTDOUT.start()} has been called - one or more commands can be executed with L{X2goTerminalSessionSTDOUT.run_command()} + After L{X2GoTerminalSessionSTDOUT.start()} has been called + one or more commands can be executed with L{X2GoTerminalSessionSTDOUT.run_command()} within the current X2Go session. @param cmd: Command to be run @@ -1358,7 +1358,7 @@ class X2goTerminalSessionSTDOUT(object): @return: C{True} if session startup has been successful and the X2Go proxy is up-and-running @rtype: C{bool} - @raise X2goTerminalSessionException: if the session startup failed + @raise X2GoTerminalSessionException: if the session startup failed """ self.params.rewrite_session_type() @@ -1413,7 +1413,7 @@ class X2goTerminalSessionSTDOUT(object): # if the first line of stdout is a "DEN(Y)" string then we will presume that # we tried to use X2Go desktop sharing and the sharing was rejected if "ACCESS DENIED" in _stderr and "XSHAD" in _stderr: - raise x2go_exceptions.X2goDesktopSharingException('X2Go desktop sharing has been denied by the remote user') + raise x2go_exceptions.X2GoDesktopSharingException('X2Go desktop sharing has been denied by the remote user') try: self.session_info.initialize(_stdout, @@ -1421,9 +1421,9 @@ class X2goTerminalSessionSTDOUT(object): hostname=self.control_session.remote_peername(), ) except ValueError: - raise x2go_exceptions.X2goTerminalSessionException("failed to start X2Go session") + raise x2go_exceptions.X2GoTerminalSessionException("failed to start X2Go session") except IndexError: - raise x2go_exceptions.X2goTerminalSessionException("failed to start X2Go session") + raise x2go_exceptions.X2GoTerminalSessionException("failed to start X2Go session") # local path may be a Windows path, so we use the path separator of the local system self.session_info.local_container = os.path.join(self.params.rootdir, 'S-%s' % self.session_info.name) @@ -1453,7 +1453,7 @@ class X2goTerminalSessionSTDOUT(object): self.control_session.get_published_applications() else: - raise x2go_exceptions.X2goTerminalSessionException("failed to start X2Go session") + raise x2go_exceptions.X2GoTerminalSessionException("failed to start X2Go session") return proxy_ok @@ -1464,7 +1464,7 @@ class X2goTerminalSessionSTDOUT(object): @return: C{True} if the session could successfully be resumed @rtype: C{bool} - @raise X2goTerminalSessionException: if the terminal session failed to update server-side reported port changes + @raise X2GoTerminalSessionException: if the terminal session failed to update server-side reported port changes """ setkbd = "0" @@ -1502,7 +1502,7 @@ class X2goTerminalSessionSTDOUT(object): self.logger('re-allocating graphics port for session %s, old server-side port is in use; new graphics port is %s' % (self.session_info, self.session_info.graphics_port), loglevel=log.loglevel_NOTICE) except TypeError: # if the re-allocation fails, this is fatal!!! - raise x2go_exceptions.X2goTerminalSessionException('Failed to retrieve new graphics port from server. X2Go Session cannot be resumed.') + raise x2go_exceptions.X2GoTerminalSessionException('Failed to retrieve new graphics port from server. X2Go Session cannot be resumed.') elif 'sound_port=' in stdout_line and _new_value != str(self.session_info.snd_port): try: self.session_info.snd_port = int(_new_value) @@ -1550,7 +1550,7 @@ class X2goTerminalSessionSTDOUT(object): self.control_session.get_published_applications() self.published_applications = True else: - raise x2go_exceptions.X2goTerminalSessionException("failed to start X2Go session") + raise x2go_exceptions.X2GoTerminalSessionException("failed to start X2Go session") return proxy_ok diff --git a/x2go/cache.py b/x2go/cache.py index 1654e08..01ca646 100644 --- a/x2go/cache.py +++ b/x2go/cache.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goListSessionCache class - caching X2Go session information. +X2GoListSessionCache class - caching X2Go session information. """ __NAME__ = 'x2gocache-pylib' @@ -31,14 +31,14 @@ import gevent import log import x2go_exceptions -class X2goListSessionsCache(object): +class X2GoListSessionsCache(object): """\ For non-blocking operations in client applications using Python X2Go, it is - recommended to enable the L{X2goListSessionsCache}. This can be done by calling - the constructor of the L{X2goClient} class. + recommended to enable the L{X2GoListSessionsCache}. This can be done by calling + the constructor of the L{X2GoClient} class. The session list and desktop cache gets updated in regular intervals by a threaded - L{X2goSessionGuardian} instance. For the session list and desktop list update, the + L{X2GoSessionGuardian} instance. For the session list and desktop list update, the X2Go server commands C{x2golistsessions} and C{x2godesktopsessions} are called and the command's stdout is cached in the session list cache. @@ -52,11 +52,11 @@ class X2goListSessionsCache(object): def __init__(self, client_instance, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the L{X2goClient} instance that uses this L{X2goListSessionsCache} + @param client_instance: the L{X2GoClient} instance that uses this L{X2GoListSessionsCache} @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the L{X2goListSessionsCache} constructor + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoListSessionsCache} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -66,7 +66,7 @@ class X2goListSessionsCache(object): self.protected = False if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -99,7 +99,7 @@ class X2goListSessionsCache(object): def update_all(self, update_sessions=True, update_desktops=False): """\ - Update L{X2goListSessionsCache} for all connected session profiles. + Update L{X2GoListSessionsCache} for all connected session profiles. @param update_sessions: cache recent session lists from all connected servers @type update_sessions: C{bool} @@ -114,7 +114,7 @@ class X2goListSessionsCache(object): def update(self, profile_name, update_sessions=True, update_desktops=False, update_mounts=False): """\ - Update L{X2goListSessionsCache} (i.e. session/desktops) for session profile C{profile_name}. + Update L{X2GoListSessionsCache} (i.e. session/desktops) for session profile C{profile_name}. @param profile_name: name of profile to update @type profile_name: C{str} @@ -141,12 +141,12 @@ class X2goListSessionsCache(object): def _update_mounts(self, profile_name, control_session): """\ - Update mounts list of L{X2goListSessionsCache} for session profile C{profile_name}. + Update mounts list of L{X2GoListSessionsCache} for session profile C{profile_name}. @param profile_name: name of profile to update @type profile_name: C{str} - @raise X2goControlSessionException: if the control session's C{list_mounts} method fails + @raise X2GoControlSessionException: if the control session's C{list_mounts} method fails """ try: self.x2go_listsessions_cache[profile_name]['mounts'] = {} @@ -154,64 +154,64 @@ class X2goListSessionsCache(object): for session_name in self.x2go_listsessions_cache[profile_name]['sessions']: if control_session is not None and not control_session.has_session_died(): self.x2go_listsessions_cache[profile_name]['mounts'].update(control_session.list_mounts(session_name)) - except (x2go_exceptions.X2goControlSessionException, AttributeError), e: + except (x2go_exceptions.X2GoControlSessionException, AttributeError), e: if profile_name in self.x2go_listsessions_cache.keys(): del self.x2go_listsessions_cache[profile_name] self.protected = False - raise x2go_exceptions.X2goControlSessionException - except x2go_exceptions.X2goTimeOutException: + raise x2go_exceptions.X2GoControlSessionException + except x2go_exceptions.X2GoTimeOutException: pass def _update_desktops(self, profile_name, control_session): """\ - Update session lists of L{X2goListSessionsCache} for session profile C{profile_name}. + Update session lists of L{X2GoListSessionsCache} for session profile C{profile_name}. @param profile_name: name of profile to update @type profile_name: C{str} @param control_session: X2Go control session instance @type control_session: C{obj} - @raise X2goControlSessionException: if the control session's C{list_desktop} method fails + @raise X2GoControlSessionException: if the control session's C{list_desktop} method fails """ try: if control_session is not None and not control_session.has_session_died(): self.x2go_listsessions_cache[profile_name]['desktops'] = control_session.list_desktops() - except (x2go_exceptions.X2goControlSessionException, AttributeError), e: + except (x2go_exceptions.X2GoControlSessionException, AttributeError), e: if profile_name in self.x2go_listsessions_cache.keys(): del self.x2go_listsessions_cache[profile_name] self.protected = False - raise x2go_exceptions.X2goControlSessionException - except x2go_exceptions.X2goTimeOutException: + raise x2go_exceptions.X2GoControlSessionException + except x2go_exceptions.X2GoTimeOutException: pass def _update_sessions(self, profile_name, control_session): """\ - Update desktop list of L{X2goListSessionsCache} for session profile C{profile_name}. + Update desktop list of L{X2GoListSessionsCache} for session profile C{profile_name}. @param profile_name: name of profile to update @type profile_name: C{str} - @raise X2goControlSessionException: if the control session's C{list_sessions} method fails + @raise X2GoControlSessionException: if the control session's C{list_sessions} method fails """ try: if control_session is not None and not control_session.has_session_died(): self.x2go_listsessions_cache[profile_name]['sessions'] = control_session.list_sessions() - except (x2go_exceptions.X2goControlSessionException, AttributeError), e: + except (x2go_exceptions.X2GoControlSessionException, AttributeError), e: if profile_name in self.x2go_listsessions_cache.keys(): del self.x2go_listsessions_cache[profile_name] self.protected = False - raise x2go_exceptions.X2goControlSessionException + raise x2go_exceptions.X2GoControlSessionException def list_sessions(self, session_uuid): """\ - Retrieve a session list from the current cache content of L{X2goListSessionsCache} - for a given L{X2goSession} instance (specified by its unique session UUID). + Retrieve a session list from the current cache content of L{X2GoListSessionsCache} + for a given L{X2GoSession} instance (specified by its unique session UUID). @param session_uuid: unique identifier of session to query cache for @type session_uuid: C{str} @return: a data object containing available session information - @rtype: C{X2goServerSessionList*} instance (or C{None}) + @rtype: C{X2GoServerSessionList*} instance (or C{None}) """ profile_name = self.client_instance.get_session_profile_name(session_uuid) @@ -223,7 +223,7 @@ class X2goListSessionsCache(object): def list_desktops(self, session_uuid): """\ Retrieve a list of available desktop sessions from the current cache content of - L{X2goListSessionsCache} for a given L{X2goSession} instance (specified by its + L{X2GoListSessionsCache} for a given L{X2GoSession} instance (specified by its unique session UUID). @param session_uuid: unique identifier of session to query cache for @@ -242,7 +242,7 @@ class X2goListSessionsCache(object): def list_mounts(self, session_uuid): """\ Retrieve a list of mounted client shares from the current cache content of - L{X2goListSessionsCache} for a given L{X2goSession} instance (specified by its + L{X2GoListSessionsCache} for a given L{X2GoSession} instance (specified by its unique session UUID). @param session_uuid: unique identifier of session to query cache for @@ -274,8 +274,8 @@ class X2goListSessionsCache(object): if profile_name is None and session_uuid and self.client_instance: try: profile_name = self.client_instance.get_session_profile_name(session_uuid) - except x2go_exceptions.X2goSessionRegistryException: - raise x2go_exceptions.X2goSessionCacheException("requested session UUID is not valid anymore") + except x2go_exceptions.X2GoSessionRegistryException: + raise x2go_exceptions.X2GoSessionCacheException("requested session UUID is not valid anymore") _is_profile_cached = self.x2go_listsessions_cache.has_key(profile_name) _is_cache_type_cached = _is_profile_cached and self.x2go_listsessions_cache[profile_name].has_key(cache_type) if cache_type is None: diff --git a/x2go/checkhosts.py b/x2go/checkhosts.py index d37b4a7..32221f8 100644 --- a/x2go/checkhosts.py +++ b/x2go/checkhosts.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -Providing mechanisms to C{X2goControlSession*} backends for checking host validity. +Providing mechanisms to C{X2GoControlSession*} backends for checking host validity. """ __NAME__ = 'x2gocheckhosts-pylib' @@ -34,7 +34,7 @@ import x2go_exceptions import random import string -class X2goMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): +class X2GoMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): """\ Skeleton class for Python X2Go's missing host key policies. @@ -44,7 +44,7 @@ class X2goMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): @param caller: calling instance @type caller: C{class} @param session_instance: an X2Go session instance - @type session_instance: L{X2goSession} instance + @type session_instance: L{X2GoSession} instance """ self.caller = caller @@ -56,7 +56,7 @@ class X2goMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): Retrieve the Paramiko SSH/Client. @return: the associated X2Go control session instance. - @rtype: C{X2goControlSession*} instance + @rtype: C{X2GoControlSession*} instance """ return self.client @@ -141,7 +141,7 @@ class X2goMissingHostKeyPolicy(paramiko.MissingHostKeyPolicy): return _colon_fingerprint.rstrip(':') -class X2goAutoAddPolicy(X2goMissingHostKeyPolicy): +class X2GoAutoAddPolicy(X2GoMissingHostKeyPolicy): def missing_host_key(self, client, hostname, key): self.client = client @@ -157,19 +157,19 @@ class X2goAutoAddPolicy(X2goMissingHostKeyPolicy): (self.key.get_name(), self.get_hostname(), binascii.hexlify(self.key.get_fingerprint()))) -class X2goInteractiveAddPolicy(X2goMissingHostKeyPolicy): +class X2GoInteractiveAddPolicy(X2GoMissingHostKeyPolicy): """\ Policy for making host key information available to Python X2Go after a Paramiko/SSH connect has been attempted. This class needs information - about the associated L{X2goSession} instance. + about the associated L{X2GoSession} instance. Once called, the L{missing_host_key} method of this class will try to call - L{X2goSession.HOOK_check_host_dialog()}. This hook method---if not re-defined - in your application---will then try to call the L{X2goClient.HOOK_check_host_dialog()}, + L{X2GoSession.HOOK_check_host_dialog()}. This hook method---if not re-defined + in your application---will then try to call the L{X2GoClient.HOOK_check_host_dialog()}, which then will return C{True} by default if not customized in your application. To accept host key checks, make sure to either customize the - L{X2goClient.HOOK_check_host_dialog()} method or the L{X2goSession.HOOK_check_host_dialog()} + L{X2GoClient.HOOK_check_host_dialog()} method or the L{X2GoSession.HOOK_check_host_dialog()} method and hook some interactive user dialog to either of them. """ @@ -178,23 +178,23 @@ class X2goInteractiveAddPolicy(X2goMissingHostKeyPolicy): Handle a missing host key situation. This method calls Once called, the L{missing_host_key} method will try to call - L{X2goSession.HOOK_check_host_dialog()}. This hook method---if not re-defined - in your application---will then try to call the L{X2goClient.HOOK_check_host_dialog()}, + L{X2GoSession.HOOK_check_host_dialog()}. This hook method---if not re-defined + in your application---will then try to call the L{X2GoClient.HOOK_check_host_dialog()}, which then will return C{True} by default if not customized in your application. To accept host key checks, make sure to either customize the - L{X2goClient.HOOK_check_host_dialog()} method or the L{X2goSession.HOOK_check_host_dialog()} + L{X2GoClient.HOOK_check_host_dialog()} method or the L{X2GoSession.HOOK_check_host_dialog()} method and hook some interactive user dialog to either of them. - @param client: SSH client (C{X2goControlSession*}) instance - @type client: C{X2goControlSession*} instance + @param client: SSH client (C{X2GoControlSession*}) instance + @type client: C{X2GoControlSession*} instance @param hostname: remote hostname @type hostname: C{str} @param key: host key to validate @type key: Paramiko/SSH key instance - @raise X2goHostKeyException: if the X2Go server host key is not in the C{known_hosts} file - @raise X2goSSHProxyHostKeyException: if the SSH proxy host key is not in the C{known_hosts} file + @raise X2GoHostKeyException: if the X2Go server host key is not in the C{known_hosts} file + @raise X2GoSSHProxyHostKeyException: if the SSH proxy host key is not in the C{known_hosts} file @raise SSHException: if this instance does not know its {self.session_instance} """ @@ -231,16 +231,16 @@ class X2goInteractiveAddPolicy(X2goMissingHostKeyPolicy): fingerprint_type=self.get_key_name(), ) if _valid: - if self.session_instance.control_session.unique_hostkey_aliases and type(self.caller) not in (sshproxy.X2goSSHProxy, ): + if self.session_instance.control_session.unique_hostkey_aliases and type(self.caller) not in (sshproxy.X2GoSSHProxy, ): paramiko.AutoAddPolicy().missing_host_key(client, self.session_instance.get_profile_id(), key) else: paramiko.AutoAddPolicy().missing_host_key(client, self.get_hostname(), key) else: - if type(self.caller) in (sshproxy.X2goSSHProxy, ): - raise x2go_exceptions.X2goSSHProxyHostKeyException('Invalid host %s is not authorized for access. Add the host to Paramiko/SSH\'s known_hosts file.' % self.get_hostname()) + if type(self.caller) in (sshproxy.X2GoSSHProxy, ): + raise x2go_exceptions.X2GoSSHProxyHostKeyException('Invalid host %s is not authorized for access. Add the host to Paramiko/SSH\'s known_hosts file.' % self.get_hostname()) else: - raise x2go_exceptions.X2goHostKeyException('Invalid host %s is not authorized for access. Add the host to Paramiko/SSH\'s known_hosts file.' % self.get_hostname()) + raise x2go_exceptions.X2GoHostKeyException('Invalid host %s is not authorized for access. Add the host to Paramiko/SSH\'s known_hosts file.' % self.get_hostname()) else: raise x2go_exceptions.SSHException('Policy has collected host key information on %s for further introspection' % self.get_hostname()) @@ -252,7 +252,7 @@ def check_ssh_host_key(x2go_sshclient_instance, hostname, port=22): connect process). @param x2go_sshclient_instance: a Paramiko/SSH client instance to be used for testing host key validity. - @type x2go_sshclient_instance: C{X2goControlSession*} instance + @type x2go_sshclient_instance: C{X2GoControlSession*} instance @param hostname: hostname of server to validate @type hostname: C{str} @param port: port of server to validate @@ -261,7 +261,7 @@ def check_ssh_host_key(x2go_sshclient_instance, hostname, port=22): @return: returns a tuple with the following components (<host_ok>, <hostname>, <port>, <fingerprint>, <fingerprint_type>) @rtype: C{tuple} - @raise SSHException: if an SSH exception occurred, that we did not provocate in L{X2goInteractiveAddPolicy.missing_host_key()} + @raise SSHException: if an SSH exception occurred, that we did not provocate in L{X2GoInteractiveAddPolicy.missing_host_key()} """ _hostname = hostname @@ -269,7 +269,7 @@ def check_ssh_host_key(x2go_sshclient_instance, hostname, port=22): _fingerprint = 'NO-FINGERPRINT' _fingerprint_type = 'SOME-KEY-TYPE' - _check_policy = X2goInteractiveAddPolicy() + _check_policy = X2GoInteractiveAddPolicy() x2go_sshclient_instance.set_missing_host_key_policy(_check_policy) host_ok = False diff --git a/x2go/cleanup.py b/x2go/cleanup.py index 399dfa4..524d5a6 100644 --- a/x2go/cleanup.py +++ b/x2go/cleanup.py @@ -46,7 +46,7 @@ def x2go_cleanup(e=None, threads=None): import x2go try: - my_x2goclient = x2go.X2goClient(...) + my_x2goclient = x2go.X2GoClient(...) [... your code ...] @@ -70,11 +70,11 @@ def x2go_cleanup(e=None, threads=None): # stop X2Go reverse forwarding tunnels for t in threads: - if type(t) == rforward.X2goRevFwTunnel: + if type(t) == rforward.X2GoRevFwTunnel: t.stop_thread() del t - # stop X2Go paramiko transports used by X2goTerminalSession objects + # stop X2Go paramiko transports used by X2GoTerminalSession objects for t in threads: if type(t) == paramiko.Transport: if hasattr(t, '_x2go_session_marker'): @@ -84,19 +84,19 @@ def x2go_cleanup(e=None, threads=None): # on Windows: stop the XServer that we evoked if _X2GOCLIENT_OS == 'Windows': for t in threads: - if type(t) == xserver.X2goXServer: + if type(t) == xserver.X2GoXServer: t.stop_thread() del t # on Windows: stop the PulseAudio daemon that we evoked if _X2GOCLIENT_OS == 'Windows': for t in threads: - if type(t) == pulseaudio.X2goPulseAudio: + if type(t) == pulseaudio.X2GoPulseAudio: t.stop_thread() del t for t in threads: - if type(t) == guardian.X2goSessionGuardian: + if type(t) == guardian.X2GoSessionGuardian: t.stop_thread() del t diff --git a/x2go/client.py b/x2go/client.py index f35961d..3f4c38c 100644 --- a/x2go/client.py +++ b/x2go/client.py @@ -19,8 +19,8 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goClient} is a public API class. Use this class in your Python X2Go based -applications. Use it as a parent class for your own object oriented L{X2goClient}'ish +L{X2GoClient} is a public API class. Use this class in your Python X2Go based +applications. Use it as a parent class for your own object oriented L{X2GoClient}'ish class implementation. Supported Features @@ -42,15 +42,15 @@ Supported Features Non-Profile Sessions ==================== - A new non-profile based X2Go session within an L{X2goClient} instance is setup in the + A new non-profile based X2Go session within an L{X2GoClient} instance is setup in the following way: - import the Python X2Go module and call the session constructor:: import x2go - x2go_client = x2go.X2goClient() + x2go_client = x2go.X2GoClient() - - register a new L{X2goClient} session; this creates an L{X2goSession} instance + - register a new L{X2GoClient} session; this creates an L{X2GoSession} instance and calls its constructor method:: x2go_sess_uuid = x2go_client.register_session(<many-options>) @@ -76,14 +76,14 @@ Non-Profile Sessions Profiled Sessions ================= A new profile based X2Go session (i.e. using pre-defined session profiles) within an - L{X2goClient} instance is setup in a much easier way: + L{X2GoClient} instance is setup in a much easier way: - import the Python X2Go module and call the session constructor:: import x2go - x2go_client = x2go.X2goClient() + x2go_client = x2go.X2GoClient() - - register an X2goClient session based on a pre-configured session profile:: + - register an X2GoClient session based on a pre-configured session profile:: x2go_sess_uuid = x2go_client.register_session(profile_name=<session_profile_name>) @@ -123,9 +123,9 @@ import types import os # Python X2Go modules -from registry import X2goSessionRegistry -from guardian import X2goSessionGuardian -from cache import X2goListSessionsCache +from registry import X2GoSessionRegistry +from guardian import X2GoSessionGuardian +from cache import X2GoListSessionsCache import x2go_exceptions import log import utils @@ -161,33 +161,33 @@ import x2go.backends.settings as settings import x2go.backends.printing as printing if _X2GOCLIENT_OS == 'Windows': - from xserver import X2goClientXConfig, X2goXServer - from pulseaudio import X2goPulseAudio + from xserver import X2GoClientXConfig, X2GoXServer + from pulseaudio import X2GoPulseAudio -class X2goClient(object): +class X2GoClient(object): """\ - The X2goClient implements _THE_ public Python X2Go API. With it you can + The X2GoClient implements _THE_ public Python X2Go API. With it you can construct your own X2Go client application in Python. Most methods in this class require that you have registered a session with a remote X2Go server (passing of session options, initialization of the session object etc.) and connected to it (authentication). For these two steps - use these methods: L{X2goClient.register_session()} and L{X2goClient.connect_session()}. + use these methods: L{X2GoClient.register_session()} and L{X2GoClient.connect_session()}. """ lang = 'en' def __init__(self, - control_backend=control.X2goControlSession, - terminal_backend=terminal.X2goTerminalSession, - info_backend=info.X2goServerSessionInfo, - list_backend=info.X2goServerSessionList, - proxy_backend=proxy.X2goProxy, - profiles_backend=profiles.X2goSessionProfiles, - settings_backend=settings.X2goClientSettings, - printing_backend=printing.X2goClientPrinting, + control_backend=control.X2GoControlSession, + terminal_backend=terminal.X2GoTerminalSession, + info_backend=info.X2GoServerSessionInfo, + list_backend=info.X2GoServerSessionList, + proxy_backend=proxy.X2GoProxy, + profiles_backend=profiles.X2GoSessionProfiles, + settings_backend=settings.X2GoClientSettings, + printing_backend=printing.X2GoClientPrinting, client_rootdir=None, sessions_rootdir=None, ssh_rootdir=None, @@ -227,19 +227,19 @@ class X2goClient(object): @type sessions_rootdir: C{str} @param ssh_rootdir: ssh base dir (default: ~/.ssh) @type ssh_rootdir: C{str} - @param start_xserver: start XServer when registering an L{X2goClient} instance + @param start_xserver: start XServer when registering an L{X2GoClient} instance @type start_xserver: C{bool} - @param start_pulseaudio: start Pulseaudio daemon when registering an L{X2goClient} instance + @param start_pulseaudio: start Pulseaudio daemon when registering an L{X2GoClient} instance @type start_pulseaudio: C{bool} @param use_cache: alias for C{use_listsessions_cache} @type use_cache: C{bool} - @param use_listsessions_cache: activate the X2Go session list cache in (L{X2goListSessionsCache}) + @param use_listsessions_cache: activate the X2Go session list cache in (L{X2GoListSessionsCache}) @type use_listsessions_cache: C{bool} - @param auto_update_listsessions_cache: activate automatic updates of the X2Go session list cache (L{X2goListSessionsCache}) + @param auto_update_listsessions_cache: activate automatic updates of the X2Go session list cache (L{X2GoListSessionsCache}) @type auto_update_listsessions_cache: C{bool} - @param auto_update_listdesktops_cache: activate automatic updates of desktop lists in (L{X2goListSessionsCache}) + @param auto_update_listdesktops_cache: activate automatic updates of desktop lists in (L{X2GoListSessionsCache}) @type auto_update_listdesktops_cache: C{bool} - @param auto_update_listmounts_cache: activate automatic updates of mount lists in (L{X2goListSessionsCache}) + @param auto_update_listmounts_cache: activate automatic updates of mount lists in (L{X2GoListSessionsCache}) @type auto_update_listmounts_cache: C{bool} @param auto_update_sessionregistry: activate automatic updates of the X2Go session registry @type auto_update_sessionregistry: C{bool} @@ -251,10 +251,10 @@ class X2goClient(object): @type refresh_interval: C{int} @param pulseaudio_installdir: install path of Pulseaudio binary @type pulseaudio_installdir: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goClient} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no X2goLogger object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoClient} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no X2GoLogger object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -262,7 +262,7 @@ class X2goClient(object): self.listsessions_cache = None if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self._logger_tag = __NAME__ @@ -307,9 +307,9 @@ class X2goClient(object): if _X2GOCLIENT_OS == 'Windows' and start_xserver: if self.client_rootdir: - self.client_xconfig = X2goClientXConfig(config_files=[_xconfig_config_file], logger=self.logger) + self.client_xconfig = X2GoClientXConfig(config_files=[_xconfig_config_file], logger=self.logger) else: - self.client_xconfig = X2goClientXConfig(logger=self.logger) + self.client_xconfig = X2GoClientXConfig(logger=self.logger) if not self.client_xconfig.known_xservers: self.HOOK_no_known_xserver_found() @@ -329,7 +329,7 @@ class X2goClient(object): if not self.client_xconfig.running_xservers: if p_xs is not None: - self.xserver = X2goXServer(p_xs[0], p_xs[1], logger=self.logger) + self.xserver = X2GoXServer(p_xs[0], p_xs[1], logger=self.logger) else: @@ -346,12 +346,12 @@ class X2goClient(object): os.environ.update({'DISPLAY': 'localhost:0'}) if _X2GOCLIENT_OS == 'Windows' and start_pulseaudio: - self.pulseaudio = X2goPulseAudio(path=self.pulseaudio_installdir, client_instance=self, logger=self.logger) + self.pulseaudio = X2GoPulseAudio(path=self.pulseaudio_installdir, client_instance=self, logger=self.logger) self.auto_register_sessions = auto_register_sessions self.no_auto_reg_pubapp_sessions = no_auto_reg_pubapp_sessions - self.session_registry = X2goSessionRegistry(self, logger=self.logger) - self.session_guardian = X2goSessionGuardian(self, auto_update_listsessions_cache=auto_update_listsessions_cache & (use_listsessions_cache|use_cache), + self.session_registry = X2GoSessionRegistry(self, logger=self.logger) + self.session_guardian = X2GoSessionGuardian(self, auto_update_listsessions_cache=auto_update_listsessions_cache & (use_listsessions_cache|use_cache), auto_update_listdesktops_cache=auto_update_listdesktops_cache & use_listsessions_cache, auto_update_listmounts_cache=auto_update_listmounts_cache & use_listsessions_cache, auto_update_sessionregistry=auto_update_sessionregistry, @@ -363,7 +363,7 @@ class X2goClient(object): self.auto_update_sessionregistry = auto_update_sessionregistry if use_listsessions_cache: - self.listsessions_cache = X2goListSessionsCache(self, logger=self.logger) + self.listsessions_cache = X2GoListSessionsCache(self, logger=self.logger) self.use_listsessions_cache = use_listsessions_cache | use_cache self.auto_update_listsessions_cache = auto_update_listsessions_cache @@ -394,7 +394,7 @@ class X2goClient(object): def HOOK_open_print_dialog(self, profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK method: called if an incoming print job has been detected by L{X2goPrintQueue} and a print dialog box is + HOOK method: called if an incoming print job has been detected by L{X2GoPrintQueue} and a print dialog box is requested. @param profile_name: profile name of session that called this hook method @@ -403,7 +403,7 @@ class X2goClient(object): @type session_name: C{str} """ - self.logger('HOOK_open_print_dialog: incoming print job detected by X2goClient hook method', loglevel=log.loglevel_WARN) + self.logger('HOOK_open_print_dialog: incoming print job detected by X2GoClient hook method', loglevel=log.loglevel_WARN) def HOOK_no_such_command(self, cmd, profile_name='UNKNOWN', session_name='UNKNOWN'): """\ @@ -431,7 +431,7 @@ class X2goClient(object): @type session_name: C{str} """ - self.logger('HOOK_open_mimebox_saveas_dialog: incoming MIME box job ,, %s'' detected by X2goClient hook method' % filename, loglevel=log.loglevel_WARN) + self.logger('HOOK_open_mimebox_saveas_dialog: incoming MIME box job ,, %s'' detected by X2GoClient hook method' % filename, loglevel=log.loglevel_WARN) def HOOK_printaction_error(self, filename, profile_name='UNKNOWN', session_name='UNKNOWN', err_msg='GENERIC_ERROR', printer=None): """\ @@ -540,11 +540,11 @@ class X2goClient(object): @type chain_port: C{str} """ - self.logger('Forwarding tunnel request to [%s]:%s for session %s (%s) was denied by remote X2go/SSH server. Session startup failed.' % (chain_host, chain_port, session_name, profile_name), loglevel=log.loglevel_ERROR) + self.logger('Forwarding tunnel request to [%s]:%s for session %s (%s) was denied by remote X2Go/SSH server. Session startup failed.' % (chain_host, chain_port, session_name, profile_name), loglevel=log.loglevel_ERROR) def HOOK_on_session_has_started_by_me(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK method: called if a session has been started by this instance of L{X2goClient}. + HOOK method: called if a session has been started by this instance of L{X2GoClient}. @param session_uuid: unique session identifier of the calling session @type session_uuid: C{str} @@ -572,7 +572,7 @@ class X2goClient(object): def HOOK_on_session_has_resumed_by_me(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK method: called if a session has been resumed by this instance of L{X2goClient}. + HOOK method: called if a session has been resumed by this instance of L{X2GoClient}. @param session_uuid: unique session identifier of the calling session @type session_uuid: C{str} @@ -614,7 +614,7 @@ class X2goClient(object): def HOOK_on_session_has_been_suspended(self, session_uuid='UNKNOWN', profile_name='UNKNOWN', session_name='UNKNOWN'): """\ - HOOK method: called if a session has been suspended by this instance of L{X2goClient}. + HOOK method: called if a session has been suspended by this instance of L{X2GoClient}. @param session_uuid: unique session identifier of the calling session @type session_uuid: C{str} @@ -692,7 +692,7 @@ class X2goClient(object): """\ Detect backend classes from the command line - @raise X2goBackendException: if a given backend name is unknown." + @raise X2GoBackendException: if a given backend name is unknown." """ # CONTROL session backend @@ -703,7 +703,7 @@ class X2goClient(object): if self.control_backend in _BACKENDS_CONTROLSESSION.values(): _classname = self.control_backend else: - raise x2go_exceptions.X2goBackendException('unknown control session backend name %s' % self.control_backend) + raise x2go_exceptions.X2GoBackendException('unknown control session backend name %s' % self.control_backend) self.control_backend = eval('control.%s' % _classname) # TERMINAL session backend @@ -714,7 +714,7 @@ class X2goClient(object): if self.terminal_backend in _BACKENDS_TERMINALSESSION.values(): _classname = self.terminal_backend else: - raise x2go_exceptions.X2goBackendException('unknown terminal session backend name %s' % self.terminal_backend) + raise x2go_exceptions.X2GoBackendException('unknown terminal session backend name %s' % self.terminal_backend) self.terminal_backend = eval('terminal.%s' % _classname) # PROXY session backend @@ -725,7 +725,7 @@ class X2goClient(object): if self.proxy_backend in _BACKENDS_PROXY.values(): _classname = self.proxy_backend else: - raise x2go_exceptions.X2goBackendException('unknown proxy backend name %s' % self.proxy_backend) + raise x2go_exceptions.X2GoBackendException('unknown proxy backend name %s' % self.proxy_backend) self.proxy_backend = eval('proxy.%s' % _classname) # server session info backend @@ -736,7 +736,7 @@ class X2goClient(object): if self.info_backend in _BACKENDS_SERVERSESSIONINFO.values(): _classname = self.info_backend else: - raise x2go_exceptions.X2goBackendException('unknown server session info backend name %s' % self.info_backend) + raise x2go_exceptions.X2GoBackendException('unknown server session info backend name %s' % self.info_backend) self.info_backend = eval('info.%s' % _classname) # server session list backend @@ -747,7 +747,7 @@ class X2goClient(object): if self.list_backend in _BACKENDS_SERVERSESSIONLIST.values(): _classname = self.list_backend else: - raise x2go_exceptions.X2goBackendException('unknown server session info backend name %s' % self.list_backend) + raise x2go_exceptions.X2GoBackendException('unknown server session info backend name %s' % self.list_backend) self.list_backend = eval('info.%s' % _classname) # session profiles backend @@ -758,7 +758,7 @@ class X2goClient(object): if self.profiles_backend in _BACKENDS_SESSIONPROFILES.values(): _classname = self.profiles_backend else: - raise x2go_exceptions.X2goBackendException('unknown session profiles backend name %s' % self.profiles_backend) + raise x2go_exceptions.X2GoBackendException('unknown session profiles backend name %s' % self.profiles_backend) self.profiles_backend = eval('profiles.%s' % _classname) # client settings backend @@ -769,7 +769,7 @@ class X2goClient(object): if self.settings_backend in _BACKENDS_CLIENTSETTINGS.values(): _classname = self.settings_backend else: - raise x2go_exceptions.X2goBackendException('unknown client settings backend name %s' % self.settings_backend) + raise x2go_exceptions.X2GoBackendException('unknown client settings backend name %s' % self.settings_backend) self.settings_backend = eval('settings.%s' % _classname) # client printing backend @@ -780,12 +780,12 @@ class X2goClient(object): if self.printing_backend in _BACKENDS_CLIENTPRINTING.values(): _classname = self.printing_backend else: - raise x2go_exceptions.X2goBackendException('unknown client printing backend name %s' % self.printing_backend) + raise x2go_exceptions.X2GoBackendException('unknown client printing backend name %s' % self.printing_backend) self.printing_backend = eval('printing.%s' % _classname) def get_client_rootdir(self): """\ - Retrieve the settings root directory of this L{X2goClient} instance. + Retrieve the settings root directory of this L{X2GoClient} instance. @return: X2Go client root directory @rtype: C{str} @@ -796,7 +796,7 @@ class X2goClient(object): @property def has_custom_client_rootdir(self): """\ - Does this L{X2goClient} instance have a customized root dir path? + Does this L{X2GoClient} instance have a customized root dir path? Equals C{True} in case it has. """ @@ -805,7 +805,7 @@ class X2goClient(object): def get_sessions_rootdir(self): """\ - Retrieve the sessions root directory of this L{X2goClient} instance. + Retrieve the sessions root directory of this L{X2GoClient} instance. @return: X2Go sessions root directory @rtype: C{str} @@ -815,7 +815,7 @@ class X2goClient(object): def get_ssh_rootdir(self): """\ - Retrieve the SSH client root dir used with this L{X2goClient} instance. + Retrieve the SSH client root dir used with this L{X2GoClient} instance. @return: SSH client root directory @rtype: C{str} @@ -827,7 +827,7 @@ class X2goClient(object): """\ Query the local user's username (i.e. the user running the X2Go client). - @return: the local username this L{X2goClient} instance runs as + @return: the local username this L{X2GoClient} instance runs as @rtype: C{str} """ @@ -839,20 +839,20 @@ class X2goClient(object): Register all session profiles found in the C{sessions} configuration node as potential X2Go sessions. - @param return_objects: if set to C{True} this methods returns a list of L{X2goSession} + @param return_objects: if set to C{True} this methods returns a list of L{X2GoSession} instances, otherwise a list of session UUIDs representing the corresponding registered sessions is returned @type return_objects: C{bool} @return: a Python dictionary containing one registered session for each available session profile - configuration, whereas the profile names are used as dictionary keys and L{X2goSession} + configuration, whereas the profile names are used as dictionary keys and L{X2GoSession} instances as their values @rtype: C{list} """ sessions = {} for profile_name in self.session_profiles.profile_names: - _obj = self._X2goClient__register_session(profile_name=profile_name, return_object=True) + _obj = self._X2GoClient__register_session(profile_name=profile_name, return_object=True) sessions[_obj.get_profile_name()] = _obj return sessions __register_all_session_profiles = register_all_session_profiles @@ -865,13 +865,13 @@ class X2goClient(object): proxy_options={}, return_object=False, **kwargs): """\ - Register a new L{X2goSession}. Within one L{X2goClient} - instance you can manage several L{X2goSession} instances on serveral + Register a new L{X2GoSession}. Within one L{X2GoClient} + instance you can manage several L{X2GoSession} instances on serveral remote X2Go servers under different user names. - These sessions can be instantiated by passing direct L{X2goSession} + These sessions can be instantiated by passing direct L{X2GoSession} parameters to this method or by specifying the name of an existing session profile - (as found in the L{X2goClient}'s C{sessions} configuration node. + (as found in the L{X2GoClient}'s C{sessions} configuration node. A session profile is a pre-defined set of session options stored in a sessions profile node (e.g. a configuration file). With the FILE backend such session @@ -881,14 +881,14 @@ class X2goClient(object): Python X2Go also supports starting multiple X2Go sessions for the same session profile simultaneously. - This method (L{X2goClient.register_session()}) accepts a similar set of parameters - as the L{X2goSession} constructor itself. For a complete set of session options refer + This method (L{X2GoClient.register_session()}) accepts a similar set of parameters + as the L{X2GoSession} constructor itself. For a complete set of session options refer there. Alternatively, you can also pass a profile name or a profile id to this method. If you do this, Python X2Go tries to find the specified session in the C{sessions} configuration node and then derives the necessary session parameters - from the session profile configuration. Additional L{X2goSession} parameters can + from the session profile configuration. Additional L{X2GoSession} parameters can also be passed to this method---they will override the option values retrieved from the session profile. @@ -920,18 +920,18 @@ class X2goClient(object): @type known_hosts: C{str} @param forward_sshagent: forward SSH agent authentication requests to the X2Go client-side @type forward_sshagent: C{bool} - @param proxy_options: a set of very C{X2goProxy*} backend specific options; any option that is not known - to the C{X2goProxy*} backend will simply be ignored + @param proxy_options: a set of very C{X2GoProxy*} backend specific options; any option that is not known + to the C{X2GoProxy*} backend will simply be ignored @type proxy_options: C{dict} @param return_object: normally this method returns a unique session UUID. If - C{return_object} is set to C{True} an X2goSession object will be returned + C{return_object} is set to C{True} an X2GoSession object will be returned instead @type return_object: C{bool} - @param kwargs: any option that is also valid for the L{X2goSession} constructor + @param kwargs: any option that is also valid for the L{X2GoSession} constructor @type kwargs: C{dict} @return: a unique identifier (UUID) for the newly registered X2Go session (or an - X2goSession object if C{return_object} is set to True + X2GoSession object if C{return_object} is set to True @rtype: C{str} """ @@ -1014,7 +1014,7 @@ class X2goClient(object): __register_session = register_session ### - ### WRAPPER METHODS FOR X2goSessionRegistry objects + ### WRAPPER METHODS FOR X2GoSessionRegistry objects ### def get_session_summary(self, session_uuid): @@ -1029,12 +1029,12 @@ class X2goClient(object): __get_session_summary = get_session_summary ### - ### WRAPPER METHODS FOR X2goSession objects + ### WRAPPER METHODS FOR X2GoSession objects ### def get_session_username(self, session_uuid): """\ - After an L{X2goSession} has been set up you can query the + After an L{X2GoSession} has been set up you can query the username that the remote sessions runs as. @param session_uuid: the X2Go session's UUID registry hash @@ -1083,13 +1083,13 @@ class X2goClient(object): def get_session(self, session_uuid): """\ - Retrieve the complete L{X2goSession} object that has been + Retrieve the complete L{X2GoSession} object that has been registered under the given session registry hash. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} - @return: the L{X2goSession} instance + @return: the L{X2GoSession} instance @rtype: obj """ @@ -1100,23 +1100,23 @@ class X2goClient(object): def get_session_of_session_name(self, session_name, return_object=False, match_profile_name=None): """\ - Retrieve session UUID or L{X2goSession} for session name + Retrieve session UUID or L{X2GoSession} for session name <session_name> from the session registry. @param session_name: the X2Go session's UUID registry hash @type session_name: C{str} - @param return_object: session UUID hash or L{X2goSession} instance wanted? + @param return_object: session UUID hash or L{X2GoSession} instance wanted? @type return_object: C{bool} @param match_profile_name: only return sessions that match this profile name @type match_profile_name: C{str} - @return: the X2Go session's UUID registry hash or L{X2goSession} instance - @rtype: C{str} or L{X2goSession} instance + @return: the X2Go session's UUID registry hash or L{X2GoSession} instance + @rtype: C{str} or L{X2GoSession} instance """ try: return self.session_registry.get_session_of_session_name(session_name=session_name, return_object=return_object, match_profile_name=match_profile_name) - except x2go_exceptions.X2goSessionRegistryException: + except x2go_exceptions.X2GoSessionRegistryException: return None __get_session_of_session_name = get_session_of_session_name @@ -1165,13 +1165,13 @@ class X2goClient(object): """ if session_uuid is None and profile_name: - _session_uuids = self._X2goClient__client_pubapp_sessions_of_profile_name(profile_name, return_objects=False) + _session_uuids = self._X2GoClient__client_pubapp_sessions_of_profile_name(profile_name, return_objects=False) if len(_session_uuids): session_uuid = _session_uuids[0] if session_uuid: try: if self.session_registry(session_uuid).is_published_applications_provider(): return self.session_registry(session_uuid).get_published_applications(lang=lang, refresh=refresh, raw=raw, very_raw=False, max_no_submenus=max_no_submenus) - except x2go_exceptions.X2goSessionRegistryException: + except x2go_exceptions.X2GoSessionRegistryException: pass else: self.logger('Cannot find a terminal session for profile ,,%s\'\' that can be used to query a published applications menu tree' % profile_name, loglevel=log.loglevel_INFO) @@ -1182,7 +1182,7 @@ class X2goClient(object): def set_session_username(self, session_uuid, username): """\ - Set the session username for the L{X2goSession} that has been registered under C{session_uuid}. + Set the session username for the L{X2GoSession} that has been registered under C{session_uuid}. This can be helpful for modifying user credentials during an authentication phase. @param session_uuid: the X2Go session's UUID registry hash @@ -1309,7 +1309,7 @@ class X2goClient(object): @param sshproxy_password: the SSH proxy user's password @type sshproxy_password: C{str} @param add_to_known_hosts: non-Paramiko option, if C{True} paramiko.AutoAddPolicy() - is used as missing-host-key-policy. If set to C{False} L{checkhosts.X2goInteractiveAddPolicy()} + is used as missing-host-key-policy. If set to C{False} L{checkhosts.X2GoInteractiveAddPolicy()} is used @type add_to_known_hosts: C{bool} @param force_password_auth: disable SSH pub/priv key authentication mechanisms @@ -1338,7 +1338,7 @@ class X2goClient(object): def disconnect_session(self, session_uuid): """\ - Disconnect an L{X2goSession} by closing down its Paramiko/SSH Transport thread. + Disconnect an L{X2GoSession} by closing down its Paramiko/SSH Transport thread. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -1356,16 +1356,16 @@ class X2goClient(object): Currently, there are five different print actions available, each defined as an individual print action class: - - B{PDFVIEW} (L{X2goPrintActionPDFVIEW}): view an incoming spool job (a PDF file) + - B{PDFVIEW} (L{X2GoPrintActionPDFVIEW}): view an incoming spool job (a PDF file) locally in a PDF viewer - - B{PDFSAVE} (L{X2goPrintActionPDFSAVE}): save an incoming spool job (a PDF file) + - B{PDFSAVE} (L{X2GoPrintActionPDFSAVE}): save an incoming spool job (a PDF file) under a nice name in a designated folder - - B{PRINT} (L{X2goPrintActionPRINT}): really print the incoming spool job on a real printing device - - B{PRINTCMD} L{X2goPrintActionPRINTCMD}: on each incoming spool job execute an + - B{PRINT} (L{X2GoPrintActionPRINT}): really print the incoming spool job on a real printing device + - B{PRINTCMD} L{X2GoPrintActionPRINTCMD}: on each incoming spool job execute an external command that lets the client user handle the further processing of the print job (PDF) file - - B{DIALOG} (L{X2goPrintActionDIALOG}): on each incoming spool job this print action - will call L{X2goClient.HOOK_open_print_dialog()} + - B{DIALOG} (L{X2GoPrintActionDIALOG}): on each incoming spool job this print action + will call L{X2GoClient.HOOK_open_print_dialog()} Each of the print action classes accepts different print action arguments. For detail information on these print action arguments please refer to the constructor methods of @@ -1444,7 +1444,7 @@ class X2goClient(object): @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} - @param sessionopts: pass-through of options directly to the session instance's L{X2goSession.start()} method + @param sessionopts: pass-through of options directly to the session instance's L{X2GoSession.start()} method @type sessionopts: C{dict} @return: returns True if this method has been successful @@ -1469,7 +1469,7 @@ class X2goClient(object): """\ Share another already running desktop session. Desktop sharing can be run in two different modes: view-only and full-access mode. Like new sessions - a to-be-shared session has be registered first with the L{X2goClient} + a to-be-shared session has be registered first with the L{X2GoClient} instance. @param desktop: desktop ID of a sharable desktop in format <user>@<display> @@ -1482,17 +1482,17 @@ class X2goClient(object): @type display: C{str} @param share_mode: desktop sharing mode, 0 is VIEW-ONLY, 1 is FULL-ACCESS. @type share_mode: C{int} - @param sessionopts: pass-through of options directly to the session instance's L{X2goSession.share_desktop()} method + @param sessionopts: pass-through of options directly to the session instance's L{X2GoSession.share_desktop()} method @type sessionopts: C{dict} @return: True if the session could be successfully shared. @rtype: C{bool} - @raise X2goDesktopSharingException: if a given desktop ID does not specify an available desktop session + @raise X2GoDesktopSharingException: if a given desktop ID does not specify an available desktop session """ - # X2goClient.list_desktops() uses caching (if enabled, so we prefer lookups here... + # X2GoClient.list_desktops() uses caching (if enabled, so we prefer lookups here... if desktop: _desktop = desktop user = None @@ -1500,11 +1500,11 @@ class X2goClient(object): else: _desktop = '%s@%s' % (user, display) - if not _desktop in self._X2goClient__list_desktops(session_uuid): + if not _desktop in self._X2GoClient__list_desktops(session_uuid): _orig_desktop = _desktop _desktop = '%s.0' % _desktop - if not _desktop in self._X2goClient__list_desktops(session_uuid): - raise x2go_exceptions.X2goDesktopSharingException('No such desktop ID: %s' % _orig_desktop) + if not _desktop in self._X2GoClient__list_desktops(session_uuid): + raise x2go_exceptions.X2GoDesktopSharingException('No such desktop ID: %s' % _orig_desktop) return self.session_registry(session_uuid).share_desktop(desktop=_desktop, share_mode=share_mode, check_desktop_list=False, **sessionopts) __share_desktop_session = share_desktop_session @@ -1521,26 +1521,26 @@ class X2goClient(object): @type session_name: C{str} @param match_profile_name: only resume a session if this profile name matches @type match_profile_name: C{str} - @param sessionopts: pass-through of options directly to the session instance's L{X2goSession.resume()} method + @param sessionopts: pass-through of options directly to the session instance's L{X2GoSession.resume()} method @type sessionopts: C{dict} @return: returns True if this method has been successful @rtype: C{bool} - @raise X2goClientException: if the method does not know what session to resume + @raise X2GoClientException: if the method does not know what session to resume """ try: if session_uuid is None and session_name is None: - raise x2go_exceptions.X2goClientException('can\'t resume a session without either session_uuid or session_name') + raise x2go_exceptions.X2GoClientException('can\'t resume a session without either session_uuid or session_name') if session_name is None and self.session_registry(session_uuid).session_name is None: - raise x2go_exceptions.X2goClientException('don\'t know which session to resume') + raise x2go_exceptions.X2GoClientException('don\'t know which session to resume') if session_uuid is None: session_uuid = self.session_registry.get_session_of_session_name(session_name=session_name, return_object=False, match_profile_name=match_profile_name) - return self.session_registry(session_uuid).resume(session_list=self._X2goClient__list_sessions(session_uuid=session_uuid), **sessionopts) + return self.session_registry(session_uuid).resume(session_list=self._X2GoClient__list_sessions(session_uuid=session_uuid), **sessionopts) else: - return self.session_registry(session_uuid).resume(session_name=session_name, session_list=self._X2goClient__list_sessions(session_uuid=session_uuid), **sessionopts) - except x2go_exceptions.X2goControlSessionException: + return self.session_registry(session_uuid).resume(session_name=session_name, session_list=self._X2GoClient__list_sessions(session_uuid=session_uuid), **sessionopts) + except x2go_exceptions.X2GoControlSessionException: profile_name = self.get_session_profile_name(session_uuid) self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) @@ -1552,7 +1552,7 @@ class X2goClient(object): Normally, you will use this method to suspend a registered session that you have formerly started/resumed from within your recent - L{X2goClient} instance. For this you simply call this method + L{X2GoClient} instance. For this you simply call this method using the session's C{session_uuid}, leave the C{session_name} empty. @@ -1570,7 +1570,7 @@ class X2goClient(object): @type session_name: C{str} @param match_profile_name: only suspend a session if this profile name matches @type match_profile_name: C{str} - @param sessionopts: pass-through of options directly to the session instance's L{X2goSession.suspend()} method + @param sessionopts: pass-through of options directly to the session instance's L{X2GoSession.suspend()} method @type sessionopts: C{dict} @return: returns True if this method has been successful @@ -1593,7 +1593,7 @@ class X2goClient(object): if session_name == session.get_session_name(): return session.suspend() return self.session_registry(session_uuid).control_session.suspend(session_name=session_name, **sessionopts) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: profile_name = self.get_session_profile_name(session_uuid) self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) @@ -1605,7 +1605,7 @@ class X2goClient(object): Normally you will use this method to terminate a registered session that you have formerly started/resumed from within your recent - L{X2goClient} instance. For this you simply call this method + L{X2GoClient} instance. For this you simply call this method using the session's C{session_uuid}, leave the C{session_name} empty. @@ -1622,7 +1622,7 @@ class X2goClient(object): @type session_name: C{str} @param match_profile_name: only terminate a session if this profile name matches @type match_profile_name: C{str} - @param sessionopts: pass-through of options directly to the session instance's L{X2goSession.terminate()} method + @param sessionopts: pass-through of options directly to the session instance's L{X2GoSession.terminate()} method @type sessionopts: C{dict} @return: returns True if this method has been successful @@ -1645,7 +1645,7 @@ class X2goClient(object): if session_name == session.get_session_name(): return session.terminate() return self.session_registry(session_uuid).control_session.terminate(session_name=session_name, **sessionopts) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: profile_name = self.get_session_profile_name(session_uuid) self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) @@ -1661,7 +1661,7 @@ class X2goClient(object): For non-profile based session this will either be a C{profile_name} that was passed to L{register_session} or it will be the application that - instantiated this L{X2goClient} instance. + instantiated this L{X2GoClient} instance. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -1830,11 +1830,11 @@ class X2goClient(object): """ if session_uuid is None and profile_name: - session_uuid = self._X2goClient__get_master_session(profile_name, return_object=False) + session_uuid = self._X2GoClient__get_master_session(profile_name, return_object=False) if session_uuid: try: return self.session_registry(session_uuid).is_folder_sharing_available() - except x2go_exceptions.X2goSessionRegistryException: + except x2go_exceptions.X2GoSessionRegistryException: return False else: self.logger('Cannot find a terminal session for profile ,,%s\'\' that can be used to query folder sharing capabilities' % profile_name, loglevel=log.loglevel_INFO) @@ -1869,11 +1869,11 @@ class X2goClient(object): if folder_name: local_path = folder_name if session_uuid is None and profile_name: - session_uuid = self._X2goClient__get_master_session(profile_name, return_object=False) + session_uuid = self._X2GoClient__get_master_session(profile_name, return_object=False) if session_uuid: try: return self.session_registry(session_uuid).share_local_folder(local_path=local_path) - except x2go_exceptions.X2goSessionException: + except x2go_exceptions.X2GoSessionException: return False else: self.logger('Cannot find a terminal session for profile ,,%s\'\' to share a local folder with' % profile_name, loglevel=log.loglevel_WARN) @@ -1902,7 +1902,7 @@ class X2goClient(object): """ if session_uuid is None and profile_name: - session_uuid = self._X2goClient__get_master_session(profile_name, return_object=False) + session_uuid = self._X2GoClient__get_master_session(profile_name, return_object=False) if session_uuid: return self.session_registry(session_uuid).unshare_all_local_folders() else: @@ -1927,7 +1927,7 @@ class X2goClient(object): @param profile_name: alternatively, the profile name can be used to unshare mounted folders @type profile_name: C{str} - @param local_path: the full path of a local folder that is mounted within X2go + @param local_path: the full path of a local folder that is mounted within X2Go session with session ID <session_uuid> (or recognized via profile name) and that shall be unmounted from that session. @type local_path: C{str} @@ -1937,7 +1937,7 @@ class X2goClient(object): """ if session_uuid is None and profile_name: - session_uuid = self._X2goClient__get_master_session(profile_name, return_object=False) + session_uuid = self._X2GoClient__get_master_session(profile_name, return_object=False) if session_uuid: return self.session_registry(session_uuid).unshare_local_folder(local_path=local_path) else: @@ -1965,7 +1965,7 @@ class X2goClient(object): """ if session_uuid is None and profile_name: - session_uuid = self._X2goClient__get_master_session(profile_name, return_object=False) + session_uuid = self._X2GoClient__get_master_session(profile_name, return_object=False) if session_uuid and profile_name is None: profile_name = self.session_registry(session_uuid).get_profile_name() @@ -1992,7 +1992,7 @@ class X2goClient(object): @param profile_name: the profile name that we query the master session of @type profile_name: C{str} - @param return_object: return L{X2goSession} instance + @param return_object: return L{X2GoSession} instance @type return_object: C{bool} @param return_session_name: return X2Go session name @type return_session_name: C{bool} @@ -2007,12 +2007,12 @@ class X2goClient(object): __profile_master_session = profile_master_session ### - ### Provide access to the X2goClient's session registry + ### Provide access to the X2GoClient's session registry ### def client_connected_sessions(self, return_objects=False, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - Retrieve a list of X2Go sessions that this L{X2goClient} instance is connected to. + Retrieve a list of X2Go sessions that this L{X2GoClient} instance is connected to. @param return_objects: return as list of X2Go session objects @type return_objects: C{bool} @@ -2032,7 +2032,7 @@ class X2goClient(object): @property def client_has_connected_sessions(self): """\ - Equals C{True} if there are any connected sessions with this L{X2goClient} instance. + Equals C{True} if there are any connected sessions with this L{X2GoClient} instance. """ return self.session_registry.has_connected_sessions @@ -2040,7 +2040,7 @@ class X2goClient(object): def client_associated_sessions(self, return_objects=False, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - Retrieve a list of X2Go sessions associated to this L{X2goClient} instance. + Retrieve a list of X2Go sessions associated to this L{X2GoClient} instance. @param return_objects: return as list of X2Go session objects @type return_objects: C{bool} @@ -2060,7 +2060,7 @@ class X2goClient(object): @property def client_has_associated_sessions(self): """\ - Equals C{True} if there are any associated sessions with this L{X2goClient} instance. + Equals C{True} if there are any associated sessions with this L{X2GoClient} instance. """ return self.session_registry.has_associated_sessions @@ -2088,7 +2088,7 @@ class X2goClient(object): @property def client_has_running_sessions(self): """\ - Equals C{True} if there are any running sessions with this L{X2goClient} instance. + Equals C{True} if there are any running sessions with this L{X2GoClient} instance. """ return self.session_registry.has_running_sessions @@ -2116,7 +2116,7 @@ class X2goClient(object): @property def client_has_suspended_sessions(self): """\ - Equals C{True} if there are any suspended sessions with this L{X2goClient} instance. + Equals C{True} if there are any suspended sessions with this L{X2GoClient} instance. """ return self.session_registry.has_suspended_sessions @@ -2158,7 +2158,7 @@ class X2goClient(object): @type profile_name: C{str} @return: control session instance - @rtype: C{X2goControlSession} instance + @rtype: C{X2GoControlSession} instance """ return self.session_registry.control_session_of_profile_name(profile_name) @@ -2172,7 +2172,7 @@ class X2goClient(object): @type session_name: C{str} @return: session instance of the given name - @rtype: C{X2goSession} or C{str} + @rtype: C{X2GoSession} or C{str} """ return self.session_registry.get_session_of_session_name(session_name, return_object=return_object) @@ -2309,20 +2309,20 @@ class X2goClient(object): """\ Test if server that corresponds to the terminal session C{session_uuid} is alive. - If the session is not connected anymore the L{X2goClient.HOOK_on_control_session_death()} gets called. + If the session is not connected anymore the L{X2GoClient.HOOK_on_control_session_death()} gets called. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} - @return: C{True} if X2Go server connection for L{X2goSession} instance with <session_uuid> is alive. + @return: C{True} if X2Go server connection for L{X2GoSession} instance with <session_uuid> is alive. @rtype: C{bool} - @raise X2goControlSessionException: if the session is not connected anymore; in that case the L{HOOK_on_control_session_death} gets called. + @raise X2GoControlSessionException: if the session is not connected anymore; in that case the L{HOOK_on_control_session_death} gets called. """ try: return self.session_registry(session_uuid).is_alive() - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: profile_name = self.get_session_profile_name(session_uuid) self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) @@ -2362,7 +2362,7 @@ class X2goClient(object): def server_running_sessions(self, session_uuid): """\ Retrieve a list of session names of all server-side running sessions (including those not - instantiated by our L{X2goClient} instance). + instantiated by our L{X2GoClient} instance). @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -2370,14 +2370,14 @@ class X2goClient(object): @return: list of session names @rtype: C{list} - @raise X2goClientException: if the session with UUID C{session_uuid} is not connected + @raise X2GoClientException: if the session with UUID C{session_uuid} is not connected """ - if self._X2goClient__is_session_connected(session_uuid): - session_list = self._X2goClient__list_sessions(session_uuid) + if self._X2GoClient__is_session_connected(session_uuid): + session_list = self._X2GoClient__list_sessions(session_uuid) return [ key for key in session_list.keys() if session_list[key].status == 'R' ] else: - raise x2go_exceptions.X2goClientException('X2Go session with UUID %s is not connected' % session_uuid) + raise x2go_exceptions.X2GoClientException('X2Go session with UUID %s is not connected' % session_uuid) __server_running_sessions = server_running_sessions def server_has_running_sessions(self, session_uuid): @@ -2390,7 +2390,7 @@ class X2goClient(object): @rtype: C{bool} """ - return len(self._X2goClient__server_running_sessions(session_uuid)) > 0 + return len(self._X2GoClient__server_running_sessions(session_uuid)) > 0 __server_has_running_sessions = server_has_running_sessions def server_has_running_session_of_name(self, session_uuid, session_name): @@ -2403,13 +2403,13 @@ class X2goClient(object): @type session_name: C{str} """ - return session_name in self._X2goClient__server_running_sessions(session_uuid) + return session_name in self._X2GoClient__server_running_sessions(session_uuid) __server_has_running_session_of_name = server_has_running_session_of_name def server_suspended_sessions(self, session_uuid): """\ Retrieve a list of session names of all server-side suspended sessions (including those not - instantiated by our L{X2goClient} instance). + instantiated by our L{X2GoClient} instance). @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -2417,14 +2417,14 @@ class X2goClient(object): @return: list of session names @rtype: C{list} - @raise X2goClientException: if the session with UUID C{session_uuid} is not connected + @raise X2GoClientException: if the session with UUID C{session_uuid} is not connected """ - if self._X2goClient__is_session_connected(session_uuid): - session_list = self._X2goClient__list_sessions(session_uuid) + if self._X2GoClient__is_session_connected(session_uuid): + session_list = self._X2GoClient__list_sessions(session_uuid) return [ key for key in session_list.keys() if session_list[key].status == 'S' ] else: - raise x2go_exceptions.X2goClientException('X2Go session with UUID %s is not connected' % session_uuid) + raise x2go_exceptions.X2GoClientException('X2Go session with UUID %s is not connected' % session_uuid) __server_suspended_sessions = server_suspended_sessions def server_has_suspended_sessions(self, session_uuid): @@ -2435,7 +2435,7 @@ class X2goClient(object): @type session_uuid: C{str} """ - return len(self._X2goClient__server_suspended_sessions(session_uuid)) > 0 + return len(self._X2GoClient__server_suspended_sessions(session_uuid)) > 0 __server_has_suspended_sessions = server_has_suspended_sessions def server_has_suspended_session_of_name(self, session_uuid, session_name): @@ -2450,7 +2450,7 @@ class X2goClient(object): @rtype: C{bool} """ - return session_name in self._X2goClient__server_suspended_sessions(session_uuid) + return session_name in self._X2GoClient__server_suspended_sessions(session_uuid) __server_has_suspended_session_of_name = server_has_suspended_session_of_name ### @@ -2463,9 +2463,9 @@ class X2goClient(object): connected user on the remote X2Go server and terminate them. Before calling this method you have to setup a pro forma remote X2Go session - with L{X2goClient.register_session()} (even if you do not intend to open + with L{X2GoClient.register_session()} (even if you do not intend to open a real X2Go session window on the remote server) and connect to this session (with - L{X2goClient.connect_session()}. + L{X2GoClient.connect_session()}. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -2491,9 +2491,9 @@ class X2goClient(object): connected X2Go server (for the authenticated user). Before calling this method you have to setup a pro forma remote X2Go session - with L{X2goClient.register_session()} (even if you do not intend to open + with L{X2GoClient.register_session()} (even if you do not intend to open a real X2Go session window on the remote server) and connect to this session (with - L{X2goClient.connect_session()}. + L{X2GoClient.connect_session()}. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -2510,12 +2510,12 @@ class X2goClient(object): session registry according to the obtained information @type update_sessionregistry: C{bool} @param register_sessions: query the X2Go server directly and register newly found X2Go session - as L{X2goSession} instances associated to this L{X2goClient} instance + as L{X2GoSession} instances associated to this L{X2GoClient} instance @type register_sessions: C{bool} - @param raw: output the session list in X2go's raw C{x2golistsessions} format + @param raw: output the session list in X2Go's raw C{x2golistsessions} format @type raw: C{bool} - @raise X2goClientException: if the session profile specified by C{session_uuid}, C{profile_name} or C{profile_id} is not connected + @raise X2GoClientException: if the session profile specified by C{session_uuid}, C{profile_name} or C{profile_id} is not connected or if none of the named parameters has been specified """ @@ -2530,12 +2530,12 @@ class X2goClient(object): # thus, we simply grab the first that comes in... session_uuid = _connected_sessions[0].get_uuid() else: - raise x2go_exceptions.X2goClientException('profile ,,%s\'\' is not connected' % profile_name) + raise x2go_exceptions.X2GoClientException('profile ,,%s\'\' is not connected' % profile_name) elif session_uuid is not None: pass else: - raise x2go_exceptions.X2goClientException('must either specify session UUID or profile name') + raise x2go_exceptions.X2GoClientException('must either specify session UUID or profile name') if raw: return self.session_registry(session_uuid).list_sessions(raw=raw) @@ -2572,9 +2572,9 @@ class X2goClient(object): for desktop sharing. Before calling this method you have to setup a pro forma remote X2Go session - with L{X2goClient.register_session()} (even if you do not intend to open + with L{X2GoClient.register_session()} (even if you do not intend to open a real X2Go session window on the remote server) and connect to this session (with - L{X2goClient.connect_session()}. + L{X2GoClient.connect_session()}. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} @@ -2584,13 +2584,13 @@ class X2goClient(object): @type profile_id: C{str} @param no_cache: do not get the session list from cache, query the X2Go server directly @type no_cache: C{bool} - @param raw: output the session list in X2go's raw C{x2golistdesktops} format + @param raw: output the session list in X2Go's raw C{x2golistdesktops} format @type raw: C{bool} @return: a list of available desktops to be shared @rtype: C{list} - @raise X2goClientException: if the session profile specified by C{session_uuid}, C{profile_name} or C{profile_id} is not connected + @raise X2GoClientException: if the session profile specified by C{session_uuid}, C{profile_name} or C{profile_id} is not connected or if none of the named parameters has been specified """ @@ -2605,12 +2605,12 @@ class X2goClient(object): # thus, we simply grab the first that comes in... session_uuid = _connected_sessions[0].get_uuid() else: - raise x2go_exceptions.X2goClientException('profile ,,%s\'\' is not connected' % profile_name) + raise x2go_exceptions.X2GoClientException('profile ,,%s\'\' is not connected' % profile_name) elif session_uuid is not None: pass else: - raise x2go_exceptions.X2goClientException('must either specify session UUID or profile name') + raise x2go_exceptions.X2GoClientException('must either specify session UUID or profile name') if raw: return self.session_registry(session_uuid).list_desktops(raw=raw) @@ -2636,7 +2636,7 @@ class X2goClient(object): @type profile_name: C{str} @param no_cache: do not get the session list from cache, query the X2Go server directly @type no_cache: C{bool} - @param raw: output the session list in X2go's raw C{x2golistmounts} format + @param raw: output the session list in X2Go's raw C{x2golistmounts} format @type raw: C{bool} @return: list of server-side mounted shares for a given profile name @@ -2667,7 +2667,7 @@ class X2goClient(object): @type session_uuid: C{str} @param no_cache: do not get the session list from cache, query the X2Go server directly @type no_cache: C{bool} - @param raw: output the session list in X2go's raw C{x2golistmounts} format + @param raw: output the session list in X2Go's raw C{x2golistmounts} format @type raw: C{bool} @return: list of server-side mounted shares for a given session UUID @@ -2693,14 +2693,14 @@ class X2goClient(object): def get_profiles(self): """\ - Returns the L{X2goClient} instance's C{X2goSessionProfiles*} object. + Returns the L{X2GoClient} instance's C{X2GoSessionProfiles*} object. Use this method for object retrieval if you want to modify the »sessions« configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your Python X2Go based application. return: returns the client's session profiles instance - rtype: C{X2goSessionProfiles*} instance + rtype: C{X2GoSessionProfiles*} instance """ return self.session_profiles @@ -2711,7 +2711,7 @@ class X2goClient(object): @property def profile_names(self): """\ - Equals a list of all profile names that are known to this L{X2goClient} instance. + Equals a list of all profile names that are known to this L{X2GoClient} instance. """ return self.session_profiles.profile_names @@ -2719,7 +2719,7 @@ class X2goClient(object): def get_client_settings(self): """\ - Returns the L{X2goClient} instance's C{X2goClientSettings*} object. + Returns the L{X2GoClient} instance's C{X2GoClientSettings*} object. Use this method for object retrieval if you want to modify the »settings« configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your @@ -2734,7 +2734,7 @@ class X2goClient(object): def get_client_printing(self): """\ - Returns the L{X2goClient} instance's C{X2goClientPrinting*} object. + Returns the L{X2GoClient} instance's C{X2GoClientPrinting*} object. Use this method for object retrieval if you want to modify the printing configuration node (e.g. in ~/.x2goclient with the FILE backend) from within your @@ -2854,7 +2854,7 @@ class X2goClient(object): def disconnect_profile(self, profile_name): """\ - Disconnect all L{X2goSession} instances that relate to C{profile_name} by closing down their + Disconnect all L{X2GoSession} instances that relate to C{profile_name} by closing down their Paramiko/SSH Transport thread. @param profile_name: the X2Go session profile name @@ -2887,33 +2887,33 @@ class X2goClient(object): @param profile_name: the X2Go session profile name @type profile_name: C{str} @param session_list: a manually passed on list of X2Go sessions - @type session_list: C{X2goServerList*} instances + @type session_list: C{X2GoServerList*} instances """ session_uuids = self.client_registered_sessions_of_profile_name(profile_name, return_objects=False) if session_uuids: if session_list is None: - session_list = self._X2goClient__list_sessions(session_uuids[0], + session_list = self._X2GoClient__list_sessions(session_uuids[0], update_sessionregistry=False, register_sessions=False, ) try: self.session_registry.update_status(profile_name=profile_name, session_list=session_list) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) __update_sessionregistry_status_by_profile_name = update_sessionregistry_status_by_profile_name def update_sessionregistry_status_by_session_uuid(self, session_uuid): """\ - Update the session registry status of a specific L{X2goSession} instance with + Update the session registry status of a specific L{X2GoSession} instance with session identifier <session_uuid>. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} """ - session_list = self._X2goClient__list_sessions(session_uuid, update_sessionregistry=False, register_sessions=False) + session_list = self._X2GoClient__list_sessions(session_uuid, update_sessionregistry=False, register_sessions=False) if session_list: self.session_registry.update_status(session_uuid=session_uuid, session_list=session_list) __update_sessionregistry_status_by_session_uuid = update_sessionregistry_status_by_session_uuid @@ -2953,14 +2953,14 @@ class X2goClient(object): _update_mounts = ('mounts' in cache_types) or update_mounts try: self.listsessions_cache.update(profile_name, update_sessions=_update_sessions, update_desktops=_update_desktops, update_mounts=_update_mounts, ) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) __update_cache_by_profile_name = update_cache_by_profile_name def update_cache_by_session_uuid(self, session_uuid, cache_types=('sessions'), update_sessions=None, update_desktops=None, update_mounts=None): """\ - Update the session list cache of a specific L{X2goSession} instance with + Update the session list cache of a specific L{X2GoSession} instance with session identifier <session_uuid>. @param session_uuid: the X2Go session's UUID registry hash @@ -3033,13 +3033,13 @@ class X2goClient(object): """ if profile_name not in self.client_connected_profiles(return_profile_names=True): return - session_list = self._X2goClient__list_sessions(profile_name=profile_name, + session_list = self._X2GoClient__list_sessions(profile_name=profile_name, update_sessionregistry=False, register_sessions=False, ) try: self.session_registry.register_available_server_sessions(profile_name, session_list=session_list, re_register=re_register, skip_pubapp_sessions=skip_pubapp_sessions) - except x2go_exceptions.X2goControlSessionException, e: + except x2go_exceptions.X2GoControlSessionException, e: self.HOOK_on_control_session_death(profile_name) self.disconnect_profile(profile_name) raise e @@ -3047,7 +3047,7 @@ class X2goClient(object): def register_available_server_sessions_by_session_uuid(self, session_uuid, skip_pubapp_sessions=False): """\ - Register available sessions that are found on the X2Go server that the L{X2goSession} instance + Register available sessions that are found on the X2Go server that the L{X2GoSession} instance with session identifier <session_uuid> is connected to. @param session_uuid: the X2Go session's UUID registry hash @@ -3071,6 +3071,6 @@ class X2goClient(object): for profile_name in self.client_connected_profiles(return_profile_names=True): try: self.__register_available_server_sessions_by_profile_name(profile_name, skip_pubapp_sessions=skip_pubapp_sessions) - except x2go_exceptions.X2goSessionRegistryException: + except x2go_exceptions.X2GoSessionRegistryException: pass __register_available_server_sessions_all_profiles = register_available_server_sessions_all_profiles diff --git a/x2go/defaults.py b/x2go/defaults.py index 193ef90..f65bc86 100644 --- a/x2go/defaults.py +++ b/x2go/defaults.py @@ -96,56 +96,56 @@ else: ## BACKENDS_CONTROLSESSION = { - 'STDOUT': 'X2goControlSessionSTDOUT', + 'STDOUT': 'X2GoControlSessionSTDOUT', } BACKENDS_TERMINALSESSION = { - 'STDOUT': 'X2goTerminalSessionSTDOUT', + 'STDOUT': 'X2GoTerminalSessionSTDOUT', } BACKENDS_SERVERSESSIONINFO = { - 'STDOUT': 'X2goServerSessionInfoSTDOUT', + 'STDOUT': 'X2GoServerSessionInfoSTDOUT', } BACKENDS_SERVERSESSIONLIST = { - 'STDOUT': 'X2goServerSessionListSTDOUT', + 'STDOUT': 'X2GoServerSessionListSTDOUT', } BACKENDS_PROXY = { - 'NX3': 'X2goProxyNX3', + 'NX3': 'X2GoProxyNX3', } -BACKEND_CONTROLSESSION_DEFAULT = 'X2goControlSessionSTDOUT' -BACKEND_TERMINALSESSION_DEFAULT = 'X2goTerminalSessionSTDOUT' -BACKEND_SERVERSESSIONINFO_DEFAULT = 'X2goServerSessionInfoSTDOUT' -BACKEND_SERVERSESSIONLIST_DEFAULT = 'X2goServerSessionListSTDOUT' -BACKEND_PROXY_DEFAULT = 'X2goProxyNX3' +BACKEND_CONTROLSESSION_DEFAULT = 'X2GoControlSessionSTDOUT' +BACKEND_TERMINALSESSION_DEFAULT = 'X2GoTerminalSessionSTDOUT' +BACKEND_SERVERSESSIONINFO_DEFAULT = 'X2GoServerSessionInfoSTDOUT' +BACKEND_SERVERSESSIONLIST_DEFAULT = 'X2GoServerSessionListSTDOUT' +BACKEND_PROXY_DEFAULT = 'X2GoProxyNX3' ## ## profile backend defaults ## BACKENDS_SESSIONPROFILES = { - 'FILE': 'X2goSessionProfilesFILE', - 'GCONF': 'X2goSessionProfilesGCONF', - 'HTTPSBROKER': 'X2goSessionProfilesHTTPSBROKER', - 'WINREG': 'X2goSessionProfilesWINREG', + 'FILE': 'X2GoSessionProfilesFILE', + 'GCONF': 'X2GoSessionProfilesGCONF', + 'HTTPSBROKER': 'X2GoSessionProfilesHTTPSBROKER', + 'WINREG': 'X2GoSessionProfilesWINREG', } """Python X2Go backends for storing session profiles.""" BACKENDS_CLIENTSETTINGS = { - 'FILE': 'X2goClientSettingsFILE', - 'GCONF': 'X2goClientSettingsGCONF', - 'HTTPSBROKER': 'X2goClientSettingsHTTPSBROKER', - 'WINREG': 'X2goClientSettingsWINREG', + 'FILE': 'X2GoClientSettingsFILE', + 'GCONF': 'X2GoClientSettingsGCONF', + 'HTTPSBROKER': 'X2GoClientSettingsHTTPSBROKER', + 'WINREG': 'X2GoClientSettingsWINREG', } """Python X2Go backends for storing client settings.""" BACKENDS_CLIENTPRINTING = { - 'FILE': 'X2goClientPrintingFILE', - 'GCONF': 'X2goClientPrintingGCONF', - 'HTTPSBROKER': 'X2goClientPrintingHTTPSBROKER', - 'WINREG': 'X2goClientPrintingWINREG', + 'FILE': 'X2GoClientPrintingFILE', + 'GCONF': 'X2GoClientPrintingGCONF', + 'HTTPSBROKER': 'X2GoClientPrintingHTTPSBROKER', + 'WINREG': 'X2GoClientPrintingWINREG', } """Python X2Go backends for storing print settings.""" -BACKEND_SESSIONPROFILES_DEFAULT = 'X2goSessionProfilesFILE' -BACKEND_CLIENTSETTINGS_DEFAULT = 'X2goClientSettingsFILE' -BACKEND_CLIENTPRINTING_DEFAULT = 'X2goClientPrintingFILE' +BACKEND_SESSIONPROFILES_DEFAULT = 'X2GoSessionProfilesFILE' +BACKEND_CLIENTSETTINGS_DEFAULT = 'X2GoClientSettingsFILE' +BACKEND_CLIENTPRINTING_DEFAULT = 'X2GoClientPrintingFILE' ## ## X2Go Printing @@ -181,7 +181,7 @@ X2GO_CLIENTSETTINGS_DEFAULTS = { 'port2': 0, }, 'General': { - # clientport is not needed for Python X2go + # clientport is not needed for Python X2Go 'clientport': 22, 'autoresume': True, }, @@ -211,9 +211,9 @@ X2GO_CLIENTPRINTING_DEFAULTS = { 'startcmd': False, # print command for non-CUPS printing 'command': 'lpr', - # ignored in Python X2go + # ignored in Python X2Go 'stdin': False, - # ignored in Python X2go + # ignored in Python X2Go 'ps': False, }, 'save': { @@ -289,7 +289,7 @@ else: X2GO_CLIENTXCONFIG_DEFAULTS = {} X2GO_GENERIC_APPLICATIONS = [ 'WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL', ] -"""X2go's generic applications.""" +"""X2Go's generic applications.""" X2GO_SESSIONPROFILE_DEFAULTS = { 'autologin': True, 'autoconnect': False, 'autostart': False, 'setsessiontitle': False, 'sessiontitle': "", @@ -312,7 +312,7 @@ X2GO_SESSIONPROFILE_DEFAULTS = { 'print': False, 'xdmcpserver': 'localhost', } -"""L{X2goSessionProfiles} default values to fill a new session profile with.""" +"""L{X2GoSessionProfiles} default values to fill a new session profile with.""" ## ## X2Go Proxy defaults ## @@ -382,7 +382,7 @@ X2GO_DESKTOPSESSIONS={ 'TRINITY': 'starttrinity', 'UNITY': 'unity', } -"""A dictionary with meta-commands for X2go's window manager sessions.""" +"""A dictionary with meta-commands for X2Go's window manager sessions.""" ## ## X2Go SFTP server defaults @@ -398,11 +398,11 @@ application instance. """ X2GO_PRINT_ACTIONS = { - 'PDFVIEW': 'X2goPrintActionPDFVIEW', - 'PDFSAVE': 'X2goPrintActionPDFSAVE', - 'PRINT': 'X2goPrintActionPRINT', - 'PRINTCMD': 'X2goPrintActionPRINTCMD', - 'DIALOG': 'X2goPrintActionDIALOG', + 'PDFVIEW': 'X2GoPrintActionPDFVIEW', + 'PDFSAVE': 'X2GoPrintActionPDFSAVE', + 'PRINT': 'X2GoPrintActionPRINT', + 'PRINTCMD': 'X2GoPrintActionPRINTCMD', + 'DIALOG': 'X2GoPrintActionDIALOG', } """Relating print action names and classes.""" @@ -414,9 +414,9 @@ DEFAULT_PRINTCMD_CMD = 'lpr' """Default command for the PRINTCMD print action.""" X2GO_MIMEBOX_ACTIONS = { - 'OPEN': 'X2goMIMEboxActionOPEN', - 'OPENWITH': 'X2goMIMEboxActionOPENWITH', - 'SAVEAS': 'X2goMIMEboxActionSAVEAS', + 'OPEN': 'X2GoMIMEboxActionOPEN', + 'OPENWITH': 'X2GoMIMEboxActionOPENWITH', + 'SAVEAS': 'X2GoMIMEboxActionSAVEAS', } """Relating MIME box action names and classes.""" diff --git a/x2go/forward.py b/x2go/forward.py index f626efc..ecf4d34 100644 --- a/x2go/forward.py +++ b/x2go/forward.py @@ -36,13 +36,13 @@ from gevent.server import StreamServer import log from defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS -class X2goFwServer(StreamServer): +class X2GoFwServer(StreamServer): """\ - L{X2goFwServer} implements a gevent's StreamServer based Paramiko/SSH port + L{X2GoFwServer} implements a gevent's StreamServer based Paramiko/SSH port forwarding server. - An L{X2goFwServer} class object is used to tunnel graphical trafic - through an external proxy command launched by a C{X2goProxy*} backend. + An L{X2GoFwServer} class object is used to tunnel graphical trafic + through an external proxy command launched by a C{X2GoProxy*} backend. """ def __init__ (self, listener, remote_host, remote_port, ssh_transport, session_instance=None, session_name=None, logger=None, loglevel=log.loglevel_DEFAULT,): @@ -55,21 +55,21 @@ class X2goFwServer(StreamServer): @type remote_port: C{int} @param ssh_transport: a valid Paramiko/SSH transport object @type ssh_transport: C{obj} - @param session_instance: the complete L{X2goSession} instance of the X2Go session this port forwarding server belongs to. - Note: for new L{X2goSession} instances the object has the session name not yet set(!!!) + @param session_instance: the complete L{X2GoSession} instance of the X2Go session this port forwarding server belongs to. + Note: for new L{X2GoSession} instances the object has the session name not yet set(!!!) @type session_instance: C{obj} @param session_name: the session name of the X2Go session this port forwarding server belongs to @type session_name: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goFwServer} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoFwServer} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -240,18 +240,18 @@ def start_forward_tunnel(local_host='127.0.0.1', local_port=22022, @type remote_port: C{int} @param ssh_transport: the Paramiko/SSH transport (i.e. the X2Go session's Paramiko/SSH transport object) @type ssh_transport: C{obj} - @param session_instance: the L{X2goSession} instance that initiates this tunnel + @param session_instance: the L{X2GoSession} instance that initiates this tunnel @type session_instance: C{obj} @param session_name: the session name of the X2Go session this port forwarding server belongs to @type session_name: C{str} - @param logger: an X2goLogger object + @param logger: an X2GoLogger object @type logger: C{obj} - @return: returns an L{X2goFwServer} instance + @return: returns an L{X2GoFwServer} instance @rtype: C{obj} """ - fw_server = X2goFwServer(listener=(local_host, local_port), + fw_server = X2GoFwServer(listener=(local_host, local_port), remote_host=remote_host, remote_port=remote_port, ssh_transport=ssh_transport, session_instance=session_instance, session_name=session_name, @@ -270,7 +270,7 @@ def stop_forward_tunnel(fw_server): """\ Tear down a given Paramiko/SSH port forwarding tunnel. - @param fw_server: an L{X2goFwServer} instance as returned by the L{start_forward_tunnel()} function + @param fw_server: an L{X2GoFwServer} instance as returned by the L{start_forward_tunnel()} function @type fw_server: C{obj} """ diff --git a/x2go/guardian.py b/x2go/guardian.py index 5e035ff..873f3f8 100644 --- a/x2go/guardian.py +++ b/x2go/guardian.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goSessionGuardian class - a guardian thread that controls X2Go session threads +X2GoSessionGuardian class - a guardian thread that controls X2Go session threads and their sub-threads (like reverse forwarding tunnels, Paramiko transport threads, etc.). @@ -34,14 +34,14 @@ import copy from cleanup import x2go_cleanup import log -class X2goSessionGuardian(threading.Thread): +class X2GoSessionGuardian(threading.Thread): """\ - L{X2goSessionGuardian} thread controls X2Go session threads and their sub-threads (like + L{X2GoSessionGuardian} thread controls X2Go session threads and their sub-threads (like reverse forwarding tunnels, Paramiko transport threads, etc.). Its main function is to tidy up once a session gets interrupted (SIGTERM, SIGINT). - There is one L{X2goSessionGuardian} for each L{X2goClient} instance (thus: for normal - setups there should be _one_ L{X2goClient} and _one_ L{X2goSessionGuardian} in use). + There is one L{X2GoSessionGuardian} for each L{X2GoClient} instance (thus: for normal + setups there should be _one_ L{X2GoClient} and _one_ L{X2GoSessionGuardian} in use). """ def __init__(self, client_instance, @@ -54,11 +54,11 @@ class X2goSessionGuardian(threading.Thread): refresh_interval=5, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param auto_update_listsessions_cache: let L{X2goSessionGuardian} refresh the session list cache for all L{X2goSession} objects + @param auto_update_listsessions_cache: let L{X2GoSessionGuardian} refresh the session list cache for all L{X2GoSession} objects @type auto_update_listsessions_cache: C{bool} - @param auto_update_listdesktops_cache: let L{X2goSessionGuardian} refresh desktop lists in the session list cache for all L{X2goSession} objects + @param auto_update_listdesktops_cache: let L{X2GoSessionGuardian} refresh desktop lists in the session list cache for all L{X2GoSession} objects @type auto_update_listdesktops_cache: C{bool} - @param auto_update_listmounts_cache: let L{X2goSessionGuardian} refresh mount lists in the session list cache for all L{X2goSession} objects + @param auto_update_listmounts_cache: let L{X2GoSessionGuardian} refresh mount lists in the session list cache for all L{X2GoSession} objects @type auto_update_listmounts_cache: C{bool} @param auto_update_sessionregistry: if set to C{True} the session status will be updated in regular intervals @type auto_update_sessionregistry: C{bool} @@ -69,15 +69,15 @@ class X2goSessionGuardian(threading.Thread): @type no_auto_reg_pubapp_sessions: C{bool} @param refresh_interval: refresh cache and session registry every <refresh_interval> seconds @type refresh_interval: C{int} - @param logger: you can pass an L{X2goLogger} object to the L{X2goSessionGuardian} constructor + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoSessionGuardian} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -97,7 +97,7 @@ class X2goSessionGuardian(threading.Thread): def guardian(self): """\ - The handler of this L{X2goSessionGuardian} thread. + The handler of this L{X2GoSessionGuardian} thread. """ seconds = 0 @@ -132,7 +132,7 @@ class X2goSessionGuardian(threading.Thread): def stop_thread(self): """\ - Stop this L{X2goSessionGuardian} thread. + Stop this L{X2GoSessionGuardian} thread. """ self._keepalive = False diff --git a/x2go/inifiles.py b/x2go/inifiles.py index bb27c72..d659f09 100644 --- a/x2go/inifiles.py +++ b/x2go/inifiles.py @@ -24,7 +24,7 @@ # none so far """\ -X2goProcessIniFile - helper class for parsing .ini files +X2GoProcessIniFile - helper class for parsing .ini files """ __NAME__ = 'x2goinifiles-pylib' @@ -41,14 +41,14 @@ from defaults import LOCAL_HOME as _current_home import log import utils -class X2goIniFile(object): +class X2GoIniFile(object): """ - Base class for processing the different ini files used by X2go + Base class for processing the different ini files used by X2Go clients. Primarily used to standardize the content of the different X2Go client ini file (settings, printing, sessions, xconfig). If entries are omitted in an ini file, they are filled with - default values (as hard coded in Python X2go), so the resulting objects + default values (as hard coded in Python X2Go), so the resulting objects always contain the same fields. """ @@ -66,12 +66,12 @@ class X2goIniFile(object): directory filename) @type config_files: C{list} @param defaults: a cascaded Python dicitionary structure with ini file defaults (to override - Python X2go's hard coded defaults in L{defaults} + Python X2Go's hard coded defaults in L{defaults} @type defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goIniFile} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoIniFile} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -81,7 +81,7 @@ class X2goIniFile(object): config_files = [] if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -131,7 +131,7 @@ class X2goIniFile(object): self._fill_defaults() def __repr__(self): - result = 'X2goIniFile(' + result = 'X2GoIniFile(' for p in dir(self): if '__' in p or not p in self.__dict__ or type(p) is types.InstanceType: continue result += p + '=' + str(self.__dict__[p]) + ',' diff --git a/x2go/log.py b/x2go/log.py index 7454f8b..8b5ece3 100644 --- a/x2go/log.py +++ b/x2go/log.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goLogger class - flexible handling of log and debug output. +X2GoLogger class - flexible handling of log and debug output. """ __NAME__ = 'x2gologger-pylib' @@ -38,13 +38,13 @@ loglevel_DEBUG_SFTPXFER = 1024 loglevel_DEFAULT = loglevel_ERROR | loglevel_WARN | loglevel_NOTICE """\ -Default loglevel of X2goLogger objects is: NOTICE & WARN & ERROR +Default loglevel of X2GoLogger objects is: NOTICE & WARN & ERROR """ # Python X2Go modules import utils -class X2goLogger(object): +class X2GoLogger(object): """\ A simple logger class, that is used by all Python X2Go classes. @@ -65,9 +65,9 @@ class X2goLogger(object): def __init__(self, name=sys.argv[0], loglevel=loglevel_DEFAULT, tag=None): """\ - @param name: name of the programme that uses Python X2go + @param name: name of the programme that uses Python X2Go @type name: C{str} - @param loglevel: log level for Python X2go + @param loglevel: log level for Python X2Go @type loglevel: C{int} @param tag: additional tag for all log entries @type tag: C{str} diff --git a/x2go/mimebox.py b/x2go/mimebox.py index c424047..52ba558 100644 --- a/x2go/mimebox.py +++ b/x2go/mimebox.py @@ -19,11 +19,11 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goMIMEboxQueue} sets up a thread that listens for incoming files that +L{X2GoMIMEboxQueue} sets up a thread that listens for incoming files that shall be opened locally on the client. For each file that gets dropped in the MIME box an individual -thread is started (L{X2goMIMEboxJob}) that handles the processing +thread is started (L{X2GoMIMEboxJob}) that handles the processing of the incoming file. """ @@ -43,12 +43,12 @@ import log import mimeboxactions -class X2goMIMEboxQueue(threading.Thread): +class X2GoMIMEboxQueue(threading.Thread): """\ - If the X2Go MIME box is supported in a particaluar L{X2goSession} instance + If the X2Go MIME box is supported in a particaluar L{X2GoSession} instance this class provides a sub-thread for handling incoming files in the MIME box directory. The actual handling of a dropped file is handled by the classes - L{X2goMIMEboxActionOPEN}, L{X2goMIMEboxActionOPENWITH} and L{X2goMIMEboxActionSAVEAS}. + L{X2GoMIMEboxActionOPEN}, L{X2GoMIMEboxActionOPENWITH} and L{X2GoMIMEboxActionSAVEAS}. """ mimebox_action = None @@ -67,18 +67,18 @@ class X2goMIMEboxQueue(threading.Thread): @type mimebox_dir: C{str} @param mimebox_action: name or instance of either of the possible X2Go print action classes @type mimebox_action: C{str} or instance - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintQueue} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintQueue} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -95,7 +95,7 @@ class X2goMIMEboxQueue(threading.Thread): self._accept_jobs = False if mimebox_action is None: - mimebox_action = mimeboxactions.X2goMIMEboxActionOPEN(client_instance=self.client_instance, logger=self.logger) + mimebox_action = mimeboxactions.X2GoMIMEboxActionOPEN(client_instance=self.client_instance, logger=self.logger) elif type(mimebox_action) in (types.StringType, types.UnicodeType): mimebox_action = self.set_mimebox_action(mimebox_action, client_instance=self.client_instance, logger=self.logger) else: @@ -136,7 +136,7 @@ class X2goMIMEboxQueue(threading.Thread): def stop_thread(self): """\ - Stops this L{X2goMIMEboxQueue} thread completely. + Stops this L{X2GoMIMEboxQueue} thread completely. """ self.pause() @@ -158,7 +158,7 @@ class X2goMIMEboxQueue(threading.Thread): def set_mimebox_action(self, mimebox_action, **kwargs): """\ - Modify the MIME box action of this L{X2goMIMEboxQueue} thread during runtime. The + Modify the MIME box action of this L{X2GoMIMEboxQueue} thread during runtime. The change of the MIME box action will be valid for the next incoming file in the MIME box directory. @@ -176,7 +176,7 @@ class X2goMIMEboxQueue(threading.Thread): def run(self): """\ - This method gets called once the L{X2goMIMEboxQueue} thread is started by the C{X2goMIMEboxQueue.start()} method. + This method gets called once the L{X2GoMIMEboxQueue} thread is started by the C{X2GoMIMEboxQueue.start()} method. """ self.logger('starting MIME box queue thread: %s' % repr(self), loglevel=log.loglevel_DEBUG) @@ -190,7 +190,7 @@ class X2goMIMEboxQueue(threading.Thread): for _job in self._incoming_mimebox_jobs: self.logger('processing incoming X2Go MIME box job: %s' % _job, loglevel=log.loglevel_NOTICE) - _new_mimeboxjob_thread = X2goMIMEboxJob(target=x2go_mimeboxjob_handler, + _new_mimeboxjob_thread = X2GoMIMEboxJob(target=x2go_mimeboxjob_handler, kwargs={ 'mimebox_file': _job, 'mimebox_extensions': self.mimebox_extensions, @@ -213,15 +213,15 @@ def x2go_mimeboxjob_handler(mimebox_file=None, parent_thread=None, logger=None, ): """\ This function is called as a handler function for each incoming X2Go MIME box file - represented by the class L{X2goMIMEboxJob}. + represented by the class L{X2GoMIMEboxJob}. @param mimebox_file: MIME box file name as placed in to the X2Go MIME box spool directory @type mimebox_file: C{str} - @param mimebox_action: an instance of either of the possible C{X2goMIMEboxActionXXX} classes - @type mimebox_action: C{X2goMIMEboxActionXXX} nstance - @param parent_thread: the L{X2goMIMEboxQueue} thread that actually created this handler's L{X2goMIMEboxJob} instance + @param mimebox_action: an instance of either of the possible C{X2GoMIMEboxActionXXX} classes + @type mimebox_action: C{X2GoMIMEboxActionXXX} nstance + @param parent_thread: the L{X2GoMIMEboxQueue} thread that actually created this handler's L{X2GoMIMEboxJob} instance @type parent_thread: C{obj} - @param logger: the L{X2goMIMEboxQueue}'s logging instance + @param logger: the L{X2GoMIMEboxQueue}'s logging instance @type logger: C{obj} """ @@ -242,7 +242,7 @@ def x2go_mimeboxjob_handler(mimebox_file=None, elif _dotfile: logger('placing files starting with a dot (.<file>) into the X2Go MIME box is prohibited, ignoring the file ,,%s\'\'' % mimebox_file, loglevel=log.loglevel_WARN) else: - logger('file extension of MIME box file %s has been found in Python X2go\' hardcoded MIME box extenstions blacklist' % mimebox_file, loglevel=log.loglevel_WARN) + logger('file extension of MIME box file %s has been found in Python X2Go\' hardcoded MIME box extenstions blacklist' % mimebox_file, loglevel=log.loglevel_WARN) logger('removing MIME box file %s' % mimebox_file, loglevel=log.loglevel_DEBUG) @@ -257,7 +257,7 @@ def x2go_mimeboxjob_handler(mimebox_file=None, parent_thread.mimebox_history = parent_thread.mimebox_history[-100:] -class X2goMIMEboxJob(threading.Thread): +class X2GoMIMEboxJob(threading.Thread): """\ For each X2Go MIME box job we create a sub-thread that let's the MIME box job be processed in the background. diff --git a/x2go/mimeboxactions.py b/x2go/mimeboxactions.py index a2749f4..74bf44e 100644 --- a/x2go/mimeboxactions.py +++ b/x2go/mimeboxactions.py @@ -20,7 +20,7 @@ """\ For MIME box jobs there are currently three handling actions available: -L{X2goMIMEboxActionOPEN}, L{X2goMIMEboxActionOPENWITH} and L{X2goMIMEboxActionSAVEAS}. +L{X2GoMIMEboxActionOPEN}, L{X2GoMIMEboxActionOPENWITH} and L{X2GoMIMEboxActionSAVEAS}. """ __NAME__ = 'x2gomimeboxactions-pylib' @@ -46,7 +46,7 @@ import x2go_exceptions _MIMEBOX_ENV = os.environ.copy() -class X2goMIMEboxAction(object): +class X2GoMIMEboxAction(object): __name__ = 'NAME' __description__ = 'DESCRIPTION' @@ -56,23 +56,23 @@ class X2goMIMEboxAction(object): This is a meta class and has no functionality as such. It is used as parent class by »real« X2Go MIME box actions. - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goMIMEboxAction} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoMIMEboxAction} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ - # these get set from within the X2goMIMEboxQueue class + # these get set from within the X2GoMIMEboxQueue class self.profile_name = 'UNKNOWN' self.session_name = 'UNKNOWN' @@ -96,7 +96,7 @@ class X2goMIMEboxAction(object): def _do_process(self, mimebox_file, mimebox_dir, ): """\ - Perform the defined MIME box action (doing nothing in L{X2goMIMEboxAction} parent class). + Perform the defined MIME box action (doing nothing in L{X2GoMIMEboxAction} parent class). @param mimebox_file: file name as placed in to the X2Go MIME box directory @type mimebox_file: C{str} @@ -123,7 +123,7 @@ class X2goMIMEboxAction(object): self._do_process(mimebox_file, mimebox_dir) -class X2goMIMEboxActionOPEN(X2goMIMEboxAction): +class X2GoMIMEboxActionOPEN(X2GoMIMEboxAction): """\ MIME box action that opens incoming files in the system's default application. @@ -133,18 +133,18 @@ class X2goMIMEboxActionOPEN(X2goMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goMIMEboxActionOPEN} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoMIMEboxActionOPEN} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ self.client_instance = client_instance - X2goMIMEboxAction.__init__(self, logger=logger, loglevel=loglevel) + X2GoMIMEboxAction.__init__(self, logger=logger, loglevel=loglevel) def _do_process(self, mimebox_file, mimebox_dir, ): """\ @@ -180,7 +180,7 @@ class X2goMIMEboxActionOPEN(X2goMIMEboxAction): time.sleep(20) -class X2goMIMEboxActionOPENWITH(X2goMIMEboxAction): +class X2GoMIMEboxActionOPENWITH(X2GoMIMEboxAction): """\ MIME box action that calls the system's ,,Open with...'' dialog on incoming files. Currently only properly implementable on Windows platforms. @@ -191,18 +191,18 @@ class X2goMIMEboxActionOPENWITH(X2goMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goMIMEboxActionOPENWITH} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoMIMEboxActionOPENWITH} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ self.client_instance = client_instance - X2goMIMEboxAction.__init__(self, logger=logger, loglevel=loglevel) + X2GoMIMEboxAction.__init__(self, logger=logger, loglevel=loglevel) def _do_process(self, mimebox_file, mimebox_dir, ): """\ @@ -236,10 +236,10 @@ class X2goMIMEboxActionOPENWITH(X2goMIMEboxAction): time.sleep(20) -class X2goMIMEboxActionSAVEAS(X2goMIMEboxAction): +class X2GoMIMEboxActionSAVEAS(X2GoMIMEboxAction): """\ MIME box action that allows saving incoming MIME box files to a local folder. What this - MIME box actually does is calling a hook method in the L{X2goClient} instance that + MIME box actually does is calling a hook method in the L{X2GoClient} instance that can be hi-jacked by one of your application's methods which then can handle the ,,Save as...'' request. @@ -249,27 +249,27 @@ class X2goMIMEboxActionSAVEAS(X2goMIMEboxAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: an L{X2goClient} instance, within your customized L{X2goClient} make sure + @param client_instance: an L{X2GoClient} instance, within your customized L{X2GoClient} make sure you have a C{HOOK_open_mimebox_saveas_dialog(filename=<str>)} method defined that will actually handle the incoming mimebox file. @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goMIMEboxActionSAVEAS} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoMIMEboxActionSAVEAS} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} - @raise X2goMIMEboxActionException: if the client_instance has not been passed to the SAVEAS MIME box action + @raise X2GoMIMEboxActionException: if the client_instance has not been passed to the SAVEAS MIME box action """ if client_instance is None: - raise x2go_exceptions.X2goMIMEboxActionException('the SAVEAS MIME box action needs to know the X2goClient instance (client=<instance>)') - X2goMIMEboxAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) + raise x2go_exceptions.X2GoMIMEboxActionException('the SAVEAS MIME box action needs to know the X2GoClient instance (client=<instance>)') + X2GoMIMEboxAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) def _do_process(self, mimebox_file, mimebox_dir): """\ - Call an L{X2goClient} hook method (C{HOOK_open_mimebox_saveas_dialog}) that + Call an L{X2GoClient} hook method (C{HOOK_open_mimebox_saveas_dialog}) that can handle the MIME box's SAVEAS action. @param mimebox_file: file name as placed in to the MIME box directory @@ -282,7 +282,7 @@ class X2goMIMEboxActionSAVEAS(X2goMIMEboxAction): mimebox_file = os.path.normpath(mimebox_file) mimebox_dir = os.path.normpath(mimebox_dir) - self.logger('Session %s (%s) is calling X2goClient class hook method <client_instance>.HOOK_open_mimebox_saveas_dialog(%s)' % (self.session_name, self.profile_name, mimebox_file), loglevel=log.loglevel_NOTICE) + self.logger('Session %s (%s) is calling X2GoClient class hook method <client_instance>.HOOK_open_mimebox_saveas_dialog(%s)' % (self.session_name, self.profile_name, mimebox_file), loglevel=log.loglevel_NOTICE) self.client_instance.HOOK_open_mimebox_saveas_dialog(os.path.join(mimebox_dir, mimebox_file), profile_name=self.profile_name, session_name=self.session_name) time.sleep(60) diff --git a/x2go/printactions.py b/x2go/printactions.py index 1def760..9128a51 100644 --- a/x2go/printactions.py +++ b/x2go/printactions.py @@ -22,8 +22,8 @@ Print jobs can either be sent to any of the local print queues (CUPS, Win32API), be opened in an external PDF viewer, be saved to a local folder or be handed over to a custom (print) command. This is defined by four print action classes -(L{X2goPrintActionDIALOG}, L{X2goPrintActionPDFVIEW}, L{X2goPrintActionPDFSAVE}, L{X2goPrintActionPRINT} and -L{X2goPrintActionPRINTCMD}). +(L{X2GoPrintActionDIALOG}, L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPDFSAVE}, L{X2GoPrintActionPRINT} and +L{X2GoPrintActionPRINTCMD}). """ __NAME__ = 'x2goprintactions-pylib' @@ -55,7 +55,7 @@ import x2go_exceptions _PRINT_ENV = os.environ.copy() -class X2goPrintAction(object): +class X2GoPrintAction(object): __name__ = 'NAME' __description__ = 'DESCRIPTION' @@ -65,23 +65,23 @@ class X2goPrintAction(object): This is a meta class and has no functionality as such. It is used as parent class by »real« X2Go print actions. - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintAction} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintAction} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ - # these get set from within the X2goPrintQueue class + # these get set from within the X2GoPrintQueue class self.profile_name = 'UNKNOWN' self.session_name = 'UNKNOWN' @@ -105,7 +105,7 @@ class X2goPrintAction(object): def _do_print(self, pdf_file, job_title, spool_dir, ): """ - Perform the defined print action (doing nothing in L{X2goPrintAction} parent class). + Perform the defined print action (doing nothing in L{X2GoPrintAction} parent class). @param pdf_file: PDF file name as placed in to the X2Go spool directory @type pdf_file: C{str} @@ -159,7 +159,7 @@ class X2goPrintAction(object): return _hr_path -class X2goPrintActionPDFVIEW(X2goPrintAction): +class X2GoPrintActionPDFVIEW(X2GoPrintAction): """\ Print action that views incoming print job in an external PDF viewer application. @@ -171,14 +171,14 @@ class X2goPrintActionPDFVIEW(X2goPrintAction): def __init__(self, client_instance=None, pdfview_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} @param pdfview_cmd: command that starts the external PDF viewer application @type pdfview_cmd: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintActionPDFVIEW} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintActionPDFVIEW} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -186,7 +186,7 @@ class X2goPrintActionPDFVIEW(X2goPrintAction): if pdfview_cmd is None: pdfview_cmd = defaults.DEFAULT_PDFVIEW_CMD self.pdfview_cmd = pdfview_cmd - X2goPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) + X2GoPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) def _do_print(self, pdf_file, job_title, spool_dir, ): """\ @@ -237,7 +237,7 @@ class X2goPrintActionPDFVIEW(X2goPrintAction): os.remove(_hr_filename) -class X2goPrintActionPDFSAVE(X2goPrintAction): +class X2GoPrintActionPDFSAVE(X2GoPrintAction): """\ Print action that saves incoming print jobs to a local folder. @@ -249,14 +249,14 @@ class X2goPrintActionPDFSAVE(X2goPrintAction): def __init__(self, client_instance=None, save_to_folder=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} @param save_to_folder: saving location for incoming print jobs (PDF files) @type save_to_folder: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintActionPDFSAVE} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintActionPDFSAVE} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -269,7 +269,7 @@ class X2goPrintActionPDFSAVE(X2goPrintAction): save_to_folder = os.path.expanduser(save_to_folder) self.save_to_folder = save_to_folder - X2goPrintAction.__init__(self, client_instance=client_instance, logger=None, loglevel=loglevel) + X2GoPrintAction.__init__(self, client_instance=client_instance, logger=None, loglevel=loglevel) self.logger('Save location for incoming PDFs is: %s' % self.save_to_folder, loglevel=log.loglevel_DEBUG) if not os.path.exists(self.save_to_folder): @@ -294,7 +294,7 @@ class X2goPrintActionPDFSAVE(X2goPrintAction): shutil.copy2(pdf_file, dest_file) -class X2goPrintActionPRINT(X2goPrintAction): +class X2GoPrintActionPRINT(X2GoPrintAction): """\ Print action that actually prints an incoming print job file. @@ -304,20 +304,20 @@ class X2goPrintActionPRINT(X2goPrintAction): def __init__(self, client_instance=None, printer=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} @param printer: name of the preferred printer, if C{None} the system's/user's default printer will be used @type printer: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintActionPRINT} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintActionPRINT} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ self.printer = printer - X2goPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) + X2GoPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) def _do_print(self, pdf_file, job_title, spool_dir, ): """\ @@ -420,12 +420,12 @@ class X2goPrintActionPRINT(X2goPrintAction): except OSError: pass -class X2goPrintActionPRINTCMD(X2goPrintAction): +class X2GoPrintActionPRINTCMD(X2GoPrintAction): """\ Print action that calls an external command for further processing of incoming print jobs. The print job's PDF filename will be prepended as last argument to the print command - used in L{X2goPrintActionPRINTCMD} instances. + used in L{X2GoPrintActionPRINTCMD} instances. """ __name__ = 'PRINTCMD' @@ -433,14 +433,14 @@ class X2goPrintActionPRINTCMD(X2goPrintAction): def __init__(self, client_instance=None, print_cmd=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the underlying L{X2goClient} instance + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} @param print_cmd: external command to be called on incoming print jobs @type print_cmd: C{str} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintActionPRINTCMD} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintActionPRINTCMD} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -448,12 +448,12 @@ class X2goPrintActionPRINTCMD(X2goPrintAction): if print_cmd is None: print_cmd = defaults.DEFAULT_PRINTCMD_CMD self.print_cmd = print_cmd - X2goPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) + X2GoPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) def _do_print(self, pdf_file, job_title, spool_dir): """\ Execute an external command that has been defined on construction - of this L{X2goPrintActionPRINTCMD} instance. + of this L{X2GoPrintActionPRINTCMD} instance. @param pdf_file: PDF file name as placed in to the X2Go spool directory @type pdf_file: C{str} @@ -481,11 +481,11 @@ class X2goPrintActionPRINTCMD(X2goPrintAction): except OSError: pass -class X2goPrintActionDIALOG(X2goPrintAction): +class X2GoPrintActionDIALOG(X2GoPrintAction): """\ Print action that mediates opening a print dialog window. This class is rather empty, the actual print dialog box must be implemented in our GUI application (with the application's - L{X2goClient} instance. + L{X2GoClient} instance. """ __name__ = 'DIALOG' @@ -493,28 +493,28 @@ class X2goPrintActionDIALOG(X2goPrintAction): def __init__(self, client_instance=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: an L{X2goClient} instance, within your customized L{X2goClient} make sure + @param client_instance: an L{X2GoClient} instance, within your customized L{X2GoClient} make sure you have a C{HOOK_open_print_dialog(filename=<str>)} method defined that will actually open the print dialog. @type client_instance: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintActionDIALOG} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintActionDIALOG} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} - @raise X2goPrintActionException: if the client_instance has not been passed to the DIALOG print action + @raise X2GoPrintActionException: if the client_instance has not been passed to the DIALOG print action """ if client_instance is None: - raise x2go_exceptions.X2goPrintActionException('the DIALOG print action needs to know the X2goClient instance (client=<instance>)') - X2goPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) + raise x2go_exceptions.X2GoPrintActionException('the DIALOG print action needs to know the X2GoClient instance (client=<instance>)') + X2GoPrintAction.__init__(self, client_instance=client_instance, logger=logger, loglevel=loglevel) def _do_print(self, pdf_file, job_title, spool_dir): """\ Execute an external command that has been defined on construction - of this L{X2goPrintActionPRINTCMD} instance. + of this L{X2GoPrintActionPRINTCMD} instance. @param pdf_file: PDF file name as placed in to the X2Go spool directory @type pdf_file: C{str} @@ -527,7 +527,7 @@ class X2goPrintActionDIALOG(X2goPrintAction): pdf_file = os.path.normpath(pdf_file) spool_dir = os.path.normpath(spool_dir) - self.logger('Session %s (%s) is calling X2goClient class hook method <client_instance>.HOOK_open_print_dialog' % (self.session_name, self.profile_name), loglevel=log.loglevel_NOTICE) + self.logger('Session %s (%s) is calling X2GoClient class hook method <client_instance>.HOOK_open_print_dialog' % (self.session_name, self.profile_name), loglevel=log.loglevel_NOTICE) _new_print_action = self.client_instance.HOOK_open_print_dialog(profile_name=self.profile_name, session_name=self.session_name) if type(_new_print_action) != type(self): _new_print_action._do_print(pdf_file, job_title, spool_dir) diff --git a/x2go/printqueue.py b/x2go/printqueue.py index cbf7403..44cb0b8 100644 --- a/x2go/printqueue.py +++ b/x2go/printqueue.py @@ -18,10 +18,10 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goPrintQueue} sets up a thread that listens for incoming print jobs. +L{X2GoPrintQueue} sets up a thread that listens for incoming print jobs. For each incoming print job in an X2Go session's spool directory an -individual thread is started (L{X2goPrintJob}) that handles the processing +individual thread is started (L{X2GoPrintJob}) that handles the processing of the incoming print job. """ @@ -39,14 +39,14 @@ import utils import log # we hide the default values from epydoc (that's why we transform them to _UNDERSCORE variables) -from backends.printing import X2goClientPrinting as _X2goClientPrinting +from backends.printing import X2GoClientPrinting as _X2GoClientPrinting from defaults import X2GO_PRINTING_FILENAME as _X2GO_PRINTING_FILENAME -class X2goPrintQueue(threading.Thread): +class X2GoPrintQueue(threading.Thread): """\ - If X2Go printing is supported in a particular L{X2goSession} instance + If X2Go printing is supported in a particular L{X2GoSession} instance this class provides a sub-thread for handling incoming X2Go print jobs. """ @@ -63,7 +63,7 @@ class X2goPrintQueue(threading.Thread): print_action=None, print_action_args={}, client_instance=None, - printing_backend=_X2goClientPrinting, + printing_backend=_X2GoClientPrinting, logger=None, loglevel=log.loglevel_DEFAULT): """\ @@ -75,21 +75,21 @@ class X2goPrintQueue(threading.Thread): @type print_action: C{str} or instance @param print_action_args: depending of the chosen C{print_action} this dictionary may contain different values; the C{print_action_args} will be passed on to the X2Go print action instance constructor, so - refer to either of these: L{X2goPrintActionPDFVIEW}, L{X2goPrintActionPRINT} et al. - @param client_instance: the underlying L{X2goClient} instance + refer to either of these: L{X2GoPrintActionPDFVIEW}, L{X2GoPrintActionPRINT} et al. + @param client_instance: the underlying L{X2GoClient} instance @type client_instance: C{obj} @param printing_backend: the client printing configuration backend class @type printing_backend: C{obj} - @param logger: you can pass an L{X2goLogger} object to the - L{X2goPrintQueue} constructor + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoPrintQueue} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -136,7 +136,7 @@ class X2goPrintQueue(threading.Thread): def stop_thread(self): """\ - Stops this L{X2goPrintQueue} thread completely. + Stops this L{X2GoPrintQueue} thread completely. """ self.pause() @@ -166,12 +166,12 @@ class X2goPrintQueue(threading.Thread): def set_print_action(self, print_action, **kwargs): """\ - Modify the print action of this L{X2goPrintQueue} thread during runtime. The + Modify the print action of this L{X2GoPrintQueue} thread during runtime. The change of print action will be valid for the next incoming print job. As kwargs you can pass arguments for the print action class to be set. Refer - to the class descriptions of L{X2goPrintActionDIALOG}, L{X2goPrintActionPDFVIEW}, - L{X2goPrintActionPRINT}, etc. + to the class descriptions of L{X2GoPrintActionDIALOG}, L{X2GoPrintActionPDFVIEW}, + L{X2GoPrintActionPRINT}, etc. @param print_action: new print action to be valid for incoming print jobs @type print_action: C{str} or C{class} @@ -187,7 +187,7 @@ class X2goPrintQueue(threading.Thread): def run(self): """\ - Start this L{X2goPrintQueue} thread... + Start this L{X2GoPrintQueue} thread... """ self.logger('starting print queue thread: %s' % repr(self), loglevel=log.loglevel_DEBUG) @@ -201,7 +201,7 @@ class X2goPrintQueue(threading.Thread): for _job in self._incoming_print_jobs: self.logger('processing incoming X2Go print job: %s' % _job[1], loglevel=log.loglevel_NOTICE) - _new_printjob_thread = X2goPrintJob(target=x2go_printjob_handler, + _new_printjob_thread = X2GoPrintJob(target=x2go_printjob_handler, kwargs={ 'job_file': _job[0], 'pdf_file': _job[1], @@ -222,7 +222,7 @@ class X2goPrintQueue(threading.Thread): def x2go_printjob_handler(job_file=None, pdf_file=None, job_title=None, print_action=None, parent_thread=None, logger=None, ): """\ This function is called as a handler function for each incoming X2Go print job - represented by the class L{X2goPrintJob}. + represented by the class L{X2GoPrintJob}. The handler function will (re-)read the »printing« configuration file (if no explicit C{print_action} is passed to this function...). It then will @@ -232,11 +232,11 @@ def x2go_printjob_handler(job_file=None, pdf_file=None, job_title=None, print_ac @type pdf_file: C{str} @param job_title: human readable print job title @type job_title: C{str} - @param print_action: an instance of either of the possible C{X2goPrintActionXXX} classes - @type print_action: C{X2goPrintActionXXX} nstance - @param parent_thread: the L{X2goPrintQueue} thread that actually created this handler's L{X2goPrintJob} instance + @param print_action: an instance of either of the possible C{X2GoPrintActionXXX} classes + @type print_action: C{X2GoPrintActionXXX} nstance + @param parent_thread: the L{X2GoPrintQueue} thread that actually created this handler's L{X2GoPrintJob} instance @type parent_thread: C{obj} - @param logger: the L{X2goPrintQueue}'s logging instance + @param logger: the L{X2GoPrintQueue}'s logging instance @type logger: C{obj} """ @@ -277,7 +277,7 @@ def x2go_printjob_handler(job_file=None, pdf_file=None, job_title=None, print_ac parent_thread.job_history = parent_thread.job_history[-100:] -class X2goPrintJob(threading.Thread): +class X2GoPrintJob(threading.Thread): """\ For each X2Go print job we create a sub-thread that let's the print job be processed in the background. diff --git a/x2go/pulseaudio.py b/x2go/pulseaudio.py index 08b599e..24cde80 100644 --- a/x2go/pulseaudio.py +++ b/x2go/pulseaudio.py @@ -21,7 +21,7 @@ # none so far """\ -X2goPulseAudio class - a Pulseaudio daemon guardian thread. +X2GoPulseAudio class - a Pulseaudio daemon guardian thread. """ @@ -49,7 +49,7 @@ import exceptions class OSNotSupportedException(exceptions.StandardError): pass """ Exception denoting that this operating system is not supported. """ -class X2goPulseAudio(threading.Thread): +class X2GoPulseAudio(threading.Thread): """ This class controls the Pulse Audio daemon. """ @@ -60,11 +60,11 @@ class X2goPulseAudio(threading.Thread): @param path: full path to pulseaudio.exe @type path: C{str} - @param client_instance: the calling L{X2goClient} instance - @type client_instance: L{X2goClient} instance - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param client_instance: the calling L{X2GoClient} instance + @type client_instance: L{X2GoClient} instance + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -75,7 +75,7 @@ class X2goPulseAudio(threading.Thread): raise OSNotSupportedException('classes of x2go.pulseaudio module are for Windows only') if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -90,8 +90,8 @@ class X2goPulseAudio(threading.Thread): def run(self): """\ - This method is called once the C{X2goPulseAudio.start()} method has been called. To tear - down the Pulseaudio daemon call the L{X2goPulseAudio.stop_thread()} method. + This method is called once the C{X2GoPulseAudio.start()} method has been called. To tear + down the Pulseaudio daemon call the L{X2GoPulseAudio.stop_thread()} method. """ self._keepalive = True diff --git a/x2go/registry.py b/x2go/registry.py index 4669ea2..6e4da18 100644 --- a/x2go/registry.py +++ b/x2go/registry.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goSessionRegistry class - the X2goClient's session registry backend +X2GoSessionRegistry class - the X2GoClient's session registry backend """ __NAME__ = 'x2gosessregistry-pylib' @@ -37,13 +37,13 @@ import session import x2go_exceptions # import the default terminal session backend -from x2go.backends.control import X2goControlSession as _X2goControlSession -from x2go.backends.terminal import X2goTerminalSession as _X2goTerminalSession -from x2go.backends.info import X2goServerSessionInfo as _X2goServerSessionInfo -from x2go.backends.info import X2goServerSessionList as _X2goServerSessionList -from x2go.backends.proxy import X2goProxy as _X2goProxy -from x2go.backends.settings import X2goClientSettings as _X2goClientSettings -from x2go.backends.printing import X2goClientPrinting as _X2goClientPrinting +from x2go.backends.control import X2GoControlSession as _X2GoControlSession +from x2go.backends.terminal import X2GoTerminalSession as _X2GoTerminalSession +from x2go.backends.info import X2GoServerSessionInfo as _X2GoServerSessionInfo +from x2go.backends.info import X2GoServerSessionList as _X2GoServerSessionList +from x2go.backends.proxy import X2GoProxy as _X2GoProxy +from x2go.backends.settings import X2GoClientSettings as _X2GoClientSettings +from x2go.backends.printing import X2GoClientPrinting as _X2GoClientPrinting from defaults import LOCAL_HOME as _LOCAL_HOME from defaults import X2GO_CLIENT_ROOTDIR as _X2GO_CLIENT_ROOTDIR @@ -51,26 +51,26 @@ from defaults import X2GO_SESSIONS_ROOTDIR as _X2GO_SESSIONS_ROOTDIR from defaults import X2GO_SESSIONPROFILE_DEFAULTS as _X2GO_SESSIONPROFILE_DEFAULTS from defaults import X2GO_SSH_ROOTDIR as _X2GO_SSH_ROOTDIR -class X2goSessionRegistry(object): +class X2GoSessionRegistry(object): """\ - This class is utilized by L{X2goClient} instances to maintain a good overview on - session status of all associated L{X2goSession} instances. + This class is utilized by L{X2GoClient} instances to maintain a good overview on + session status of all associated L{X2GoSession} instances. """ def __init__(self, client_instance, logger=None, loglevel=log.loglevel_DEFAULT): """\ - @param client_instance: the L{X2goClient} instance that instantiated this L{X2goSessionRegistry} instance. - @type client_instance: L{X2goClient} instance - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param client_instance: the L{X2GoClient} instance that instantiated this L{X2GoSessionRegistry} instance. + @type client_instance: L{X2GoClient} instance + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -96,7 +96,7 @@ class X2goSessionRegistry(object): return self.registry.keys() def __repr__(self): - result = 'X2goSessionRegistry(' + result = 'X2GoSessionRegistry(' for p in dir(self): if '__' in p or not p in self.__dict__ or type(p) is types.InstanceType: continue result += p + '=' + str(self.__dict__[p]) + ',' @@ -105,21 +105,21 @@ class X2goSessionRegistry(object): def __call__(self, session_uuid): """\ - Returns the L{X2goSession} instance for a given session UUID hash. + Returns the L{X2GoSession} instance for a given session UUID hash. @param session_uuid: the X2Go session's UUID registry hash @type session_uuid: C{str} - @return: the corresponding L{X2goSession} instance - @rtype: L{X2goSession} instance + @return: the corresponding L{X2GoSession} instance + @rtype: L{X2GoSession} instance - @raise X2goSessionRegistryException: if the given session UUID could not be found + @raise X2GoSessionRegistryException: if the given session UUID could not be found """ try: return self.registry[session_uuid] except KeyError: - raise x2go_exceptions.X2goSessionRegistryException('No session found for UUID %s' % session_uuid) + raise x2go_exceptions.X2GoSessionRegistryException('No session found for UUID %s' % session_uuid) def disable_session_auto_registration(self): """\ @@ -229,7 +229,7 @@ class X2goSessionRegistry(object): def update_status(self, session_uuid=None, profile_name=None, profile_id=None, session_list=None, force_update=False, newly_connected=False): """\ - Update the session status for L{X2goSession} that is represented by a given session UUID hash, + Update the session status for L{X2GoSession} that is represented by a given session UUID hash, profile name or profile ID. @param session_uuid: the X2Go session's UUID registry hash @@ -240,23 +240,23 @@ class X2goSessionRegistry(object): @param profile_id: alternatively, a profile ID can be given (the stati of all registered sessions for this session profile will be updated) @type profile_id: C{str} - @param session_list: an optional C{X2goServerSessionList*} instance (as returned by the L{X2goClient.list_sessions()} command can + @param session_list: an optional C{X2GoServerSessionList*} instance (as returned by the L{X2GoClient.list_sessions()} command can be passed to this method. - @type session_list: C{X2goServerSessionList*} instance + @type session_list: C{X2GoServerSessionList*} instance @param force_update: make sure the session status gets really updated @type force_update: C{bool} @return: C{True} if this method has been successful @rtype: C{bool} - @raise X2goSessionRegistryException: if the combination of C{session_uuid}, C{profile_name} and C{profile_id} does not match the requirement: + @raise X2GoSessionRegistryException: if the combination of C{session_uuid}, C{profile_name} and C{profile_id} does not match the requirement: only one of them """ if session_uuid and profile_name or session_uuid and profile_id or profile_name and profile_id: - raise x2go_exceptions.X2goSessionRegistryException('only one of the possible method parameters is allowed (session_uuid, profile_name or profile_id)') + raise x2go_exceptions.X2GoSessionRegistryException('only one of the possible method parameters is allowed (session_uuid, profile_name or profile_id)') elif session_uuid is None and profile_name is None and profile_id is None: - raise x2go_exceptions.X2goSessionRegistryException('at least one of the method parameters session_uuid, profile_name or profile_id must be given') + raise x2go_exceptions.X2GoSessionRegistryException('at least one of the method parameters session_uuid, profile_name or profile_id must be given') if session_uuid: session_uuids = [ session_uuid ] @@ -267,8 +267,8 @@ class X2goSessionRegistry(object): for _session_uuid in session_uuids: - # only operate on instantiated X2goSession objects - if type(self(_session_uuid)) != session.X2goSession: + # only operate on instantiated X2GoSession objects + if type(self(_session_uuid)) != session.X2GoSession: continue if not self(_session_uuid).update_status(session_list=session_list, force_update=force_update): @@ -278,7 +278,7 @@ class X2goSessionRegistry(object): _last_status = copy.deepcopy(self(_session_uuid)._last_status) _current_status = copy.deepcopy(self(_session_uuid)._current_status) - # at this point we hook into the X2goClient instance and call notification methods + # at this point we hook into the X2GoClient instance and call notification methods # that can be used to inform an application that something has happened _profile_name = self(_session_uuid).get_profile_name() @@ -360,9 +360,9 @@ class X2goSessionRegistry(object): # session has terminated self.client_instance.HOOK_on_session_has_terminated(session_uuid=_session_uuid, profile_name=_profile_name, session_name=_session_name) try: self(_session_uuid).session_cleanup() - except x2go_exceptions.X2goSessionException: pass + except x2go_exceptions.X2GoSessionException: pass try: self(_session_uuid).__del__() - except x2go_exceptions.X2goSessionException: pass + except x2go_exceptions.X2GoSessionException: pass if len(self.virgin_sessions_of_profile_name(profile_name)) > 1: self.forget(_session_uuid) @@ -388,13 +388,13 @@ class X2goSessionRegistry(object): def register_available_server_sessions(self, profile_name, session_list=None, newly_connected=False, re_register=False, skip_pubapp_sessions=False): """\ - Register server-side available X2Go sessions with this L{X2goSessionRegistry} instance for a given profile name. + Register server-side available X2Go sessions with this L{X2GoSessionRegistry} instance for a given profile name. @param profile_name: session profile name to register available X2Go sessions for @type profile_name: C{str} - @param session_list: an optional C{X2goServerSessionList*} instance (as returned by the L{X2goClient.list_sessions()} command can + @param session_list: an optional C{X2GoServerSessionList*} instance (as returned by the L{X2GoClient.list_sessions()} command can be passed to this method. - @type session_list: C{X2goServerSessionList*} instance + @type session_list: C{X2GoServerSessionList*} instance @param newly_connected: give a hint that the session profile got newly connected @type newly_connected: C{bool} @param re_register: re-register available sessions, needs to be done after changes to the session profile @@ -424,7 +424,7 @@ class X2goSessionRegistry(object): session_list = _ctrl_session.list_sessions() # make sure the session registry gets updated before registering new session - # (if the server name has changed, this will kick out obsolete X2goSessions) + # (if the server name has changed, this will kick out obsolete X2GoSessions) self.update_status(profile_name=profile_name, session_list=session_list, force_update=True) for session_name in session_list.keys(): if (session_name not in _session_names and not self._skip_auto_registration) or re_register: @@ -467,13 +467,13 @@ class X2goSessionRegistry(object): def register(self, server, profile_id, profile_name, session_name=None, - control_backend=_X2goControlSession, - terminal_backend=_X2goTerminalSession, - info_backend=_X2goServerSessionInfo, - list_backend=_X2goServerSessionList, - proxy_backend=_X2goProxy, - settings_backend=_X2goClientSettings, - printing_backend=_X2goClientPrinting, + control_backend=_X2GoControlSession, + terminal_backend=_X2GoTerminalSession, + info_backend=_X2GoServerSessionInfo, + list_backend=_X2GoServerSessionList, + proxy_backend=_X2GoProxy, + settings_backend=_X2GoClientSettings, + printing_backend=_X2GoClientPrinting, client_rootdir=os.path.join(_LOCAL_HOME,_X2GO_CLIENT_ROOTDIR), sessions_rootdir=os.path.join(_LOCAL_HOME,_X2GO_SESSIONS_ROOTDIR), ssh_rootdir=os.path.join(_LOCAL_HOME,_X2GO_SSH_ROOTDIR), @@ -482,7 +482,7 @@ class X2goSessionRegistry(object): known_hosts=None, **kwargs): """\ - Register a new L{X2goSession} instance with this L{X2goSessionRegistry}. + Register a new L{X2GoSession} instance with this L{X2GoSessionRegistry}. @param server: hostname of X2Go server @type server: C{str} @@ -512,13 +512,13 @@ class X2goSessionRegistry(object): @type sessions_rootdir: C{str} @param ssh_rootdir: ssh base dir (default: ~/.ssh) @type ssh_rootdir: C{str} - @param keep_controlsession_alive: On last L{X2goSession.disconnect()} keep the associated C{X2goControlSession*} instance alive? + @param keep_controlsession_alive: On last L{X2GoSession.disconnect()} keep the associated C{X2GoControlSession*} instance alive? @ŧype keep_controlsession_alive: C{bool} @param add_to_known_hosts: Auto-accept server host validity? @type add_to_known_hosts: C{bool} @param known_hosts: the underlying Paramiko/SSH systems C{known_hosts} file @type known_hosts: C{str} - @param kwargs: all other options will be passed on to the constructor of the to-be-instantiated L{X2goSession} instance + @param kwargs: all other options will be passed on to the constructor of the to-be-instantiated L{X2GoSession} instance @type C{dict} @return: the session UUID of the newly registered (or re-registered) session @@ -537,7 +537,7 @@ class X2goSessionRegistry(object): try: _params = self.client_instance.session_profiles.to_session_params(profile_id) - except x2go_exceptions.X2goProfileException: + except x2go_exceptions.X2GoProfileException: _params = utils._convert_SessionProfileOptions_2_SessionParams(_X2GO_SESSIONPROFILE_DEFAULTS) for _k in _params.keys(): @@ -571,7 +571,7 @@ class X2goSessionRegistry(object): try: del _params['profile_id'] except: pass - s = session.X2goSession(server=server, control_session=control_session, + s = session.X2GoSession(server=server, control_session=control_session, profile_id=profile_id, profile_name=profile_name, session_name=session_name, control_backend=control_backend, @@ -590,7 +590,7 @@ class X2goSessionRegistry(object): client_instance=self.client_instance, logger=self.logger, **_params) - session_uuid = s._X2goSession__get_uuid() + session_uuid = s._X2GoSession__get_uuid() self.logger('registering X2Go session %s...' % profile_name, log.loglevel_NOTICE) self.logger('registering X2Go session with UUID %s' % session_uuid, log.loglevel_DEBUG) @@ -608,7 +608,7 @@ class X2goSessionRegistry(object): def has_session_of_session_name(self, session_name, match_profile_name=None): """\ - Detect if we know about an L{X2goSession} of name C{<session_name>}. + Detect if we know about an L{X2GoSession} of name C{<session_name>}. @param session_name: name of session to be searched for @type session_name: C{str} @@ -623,20 +623,20 @@ class X2goSessionRegistry(object): def get_session_of_session_name(self, session_name, return_object=False, match_profile_name=None): """\ - Retrieve the L{X2goSession} instance with session name C{<session_name>}. + Retrieve the L{X2GoSession} instance with session name C{<session_name>}. @param session_name: name of session to be retrieved @type session_name: C{str} - @param return_object: if C{False} the session UUID hash will be returned, if C{True} the L{X2goSession} instance will be returned + @param return_object: if C{False} the session UUID hash will be returned, if C{True} the L{X2GoSession} instance will be returned @type return_object: C{bool} @param match_profile_name: returned sessions must match this profile name @type match_profile_name: C{str} - @return: L{X2goSession} object or its representing session UUID hash - @rtype: L{X2goSession} instance or C{str} + @return: L{X2GoSession} object or its representing session UUID hash + @rtype: L{X2GoSession} instance or C{str} - @raise X2goSessionRegistryException: if there is more than one L{X2goSession} registered for C{<session_name>} within - the same L{X2goClient} instance. This should never happen! + @raise X2GoSessionRegistryException: if there is more than one L{X2GoSession} registered for C{<session_name>} within + the same L{X2GoClient} instance. This should never happen! """ if match_profile_name is None: @@ -651,7 +651,7 @@ class X2goSessionRegistry(object): else: return session.get_uuid() elif len(found_sessions) > 1: - raise x2go_exceptions.X2goSessionRegistryException('there should only be one registered session of name ,,%s\'\'' % session_name) + raise x2go_exceptions.X2GoSessionRegistryException('there should only be one registered session of name ,,%s\'\'' % session_name) else: return None @@ -687,10 +687,10 @@ class X2goSessionRegistry(object): def connected_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - Retrieve a list of sessions that the underlying L{X2goClient} instances is currently connected to. + Retrieve a list of sessions that the underlying L{X2GoClient} instances is currently connected to. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -707,10 +707,10 @@ class X2goSessionRegistry(object): def associated_sessions(self, return_objects=True, return_profile_names=False, return_profile_ids=False, return_session_names=False): """\ - Retrieve a list of sessions that are currently associated by an C{X2goTerminalSession*} to the underlying L{X2goClient} instance. + Retrieve a list of sessions that are currently associated by an C{X2GoTerminalSession*} to the underlying L{X2GoClient} instance. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -730,7 +730,7 @@ class X2goSessionRegistry(object): Retrieve a list of sessions that are currently still in virgin state (not yet connected, associated etc.). If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -750,7 +750,7 @@ class X2goSessionRegistry(object): Retrieve a list of sessions that are currently in running state. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -770,7 +770,7 @@ class X2goSessionRegistry(object): Retrieve a list of sessions that are currently in suspended state. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -790,7 +790,7 @@ class X2goSessionRegistry(object): Retrieve a list of sessions that have terminated recently. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -808,7 +808,7 @@ class X2goSessionRegistry(object): @property def has_running_sessions(self): """\ - Equals C{True} if the underlying L{X2goClient} instance has any running sessions at hand. + Equals C{True} if the underlying L{X2GoClient} instance has any running sessions at hand. """ return self.running_sessions() and len(self.running_sessions()) > 0 @@ -816,7 +816,7 @@ class X2goSessionRegistry(object): @property def has_suspended_sessions(self): """\ - Equals C{True} if the underlying L{X2goClient} instance has any suspended sessions at hand. + Equals C{True} if the underlying L{X2GoClient} instance has any suspended sessions at hand. """ return self.suspended_sessions and len(self.suspended_sessions) > 0 @@ -826,7 +826,7 @@ class X2goSessionRegistry(object): Retrieve a list of all registered sessions. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -846,7 +846,7 @@ class X2goSessionRegistry(object): Retrieve a list of sessions that are currently _NOT_ in running state. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_profile_names: return as list of profile names @type return_profile_names: C{bool} @@ -868,7 +868,7 @@ class X2goSessionRegistry(object): @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -886,12 +886,12 @@ class X2goSessionRegistry(object): def associated_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ - For a given session profile name retrieve a list of sessions that are currently associated by an C{X2goTerminalSession*} to this L{X2goClient} instance. + For a given session profile name retrieve a list of sessions that are currently associated by an C{X2GoTerminalSession*} to this L{X2GoClient} instance. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -914,7 +914,7 @@ class X2goSessionRegistry(object): @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -932,12 +932,12 @@ class X2goSessionRegistry(object): def registered_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ - For a given session profile name retrieve a list of sessions that are currently registered with this L{X2goClient} instance. + For a given session profile name retrieve a list of sessions that are currently registered with this L{X2GoClient} instance. If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -955,13 +955,13 @@ class X2goSessionRegistry(object): def virgin_sessions_of_profile_name(self, profile_name, return_objects=True, return_session_names=False): """\ - For a given session profile name retrieve a list of sessions that are registered with this L{X2goClient} instance but have not + For a given session profile name retrieve a list of sessions that are registered with this L{X2GoClient} instance but have not yet been started (i.e. sessions that are in virgin state). If none of the C{return_*} options is specified a list of session UUID hashes will be returned. @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -984,7 +984,7 @@ class X2goSessionRegistry(object): @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -1007,7 +1007,7 @@ class X2goSessionRegistry(object): @param profile_name: session profile name @type profile_name: C{str} - @param return_objects: return as list of L{X2goSession} instances + @param return_objects: return as list of L{X2GoSession} instances @type return_objects: C{bool} @param return_session_names: return as list of X2Go session names @type return_session_names: C{bool} @@ -1025,13 +1025,13 @@ class X2goSessionRegistry(object): def control_session_of_profile_name(self, profile_name): """\ - For a given session profile name retrieve a the corresponding C{X2goControlSession*} instance. + For a given session profile name retrieve a the corresponding C{X2GoControlSession*} instance. @param profile_name: session profile name @type profile_name: C{str} @return: contol session instance - @rtype: C{X2goControlSession*} instance + @rtype: C{X2GoControlSession*} instance """ _sessions = self.registered_sessions_of_profile_name(profile_name, return_objects=True) @@ -1070,7 +1070,7 @@ class X2goSessionRegistry(object): @param profile_name: the profile name that we query the master session of @type profile_name: C{str} - @param return_object: return L{X2goSession} instance + @param return_object: return L{X2GoSession} instance @type return_object: C{bool} @param return_session_name: return X2Go session name @type return_session_name: C{bool} diff --git a/x2go/rforward.py b/x2go/rforward.py index a138870..ca8c95b 100644 --- a/x2go/rforward.py +++ b/x2go/rforward.py @@ -47,12 +47,12 @@ def x2go_transport_tcp_handler(chan, (origin_addr, origin_port), (server_addr, s However, additionally this handler function checks the server port of the incoming channel and detects if there are Paramiko/SSH reverse forwarding tunnels waiting for the incoming - channels. The Paramiko/SSH reverse forwarding tunnels are initiated by an L{X2goSession} instance + channels. The Paramiko/SSH reverse forwarding tunnels are initiated by an L{X2GoSession} instance (currently supported: reverse tunneling auf audio data, reverse tunneling of SSH requests). - If the server port of an incoming Paramiko/SSH channel matches the configured port of an L{X2goRevFwTunnel} - instance, this instance gets notified of the incoming channel and a new L{X2goRevFwChannelThread} is - started. This L{X2goRevFwChannelThread} then takes care of the new channel's incoming data stream. + If the server port of an incoming Paramiko/SSH channel matches the configured port of an L{X2GoRevFwTunnel} + instance, this instance gets notified of the incoming channel and a new L{X2GoRevFwChannelThread} is + started. This L{X2GoRevFwChannelThread} then takes care of the new channel's incoming data stream. """ transport = chan.get_transport() @@ -70,9 +70,9 @@ def x2go_transport_tcp_handler(chan, (origin_addr, origin_port), (server_addr, s rev_tuns[session_name]['sshfs'][1].notify() -class X2goRevFwTunnel(threading.Thread): +class X2GoRevFwTunnel(threading.Thread): """\ - L{X2goRevFwTunnel} class objects are used to reversely tunnel + L{X2GoRevFwTunnel} class objects are used to reversely tunnel X2Go audio, X2Go printing and X2Go folder sharing / device mounting through Paramiko/SSH. @@ -81,10 +81,10 @@ class X2goRevFwTunnel(threading.Thread): """\ Setup a reverse tunnel through Paramiko/SSH. - After the reverse tunnel has been setup up with L{X2goRevFwTunnel.start()} it waits - for notification from L{X2goRevFwTunnel.notify()} to accept incoming channels. This - notification (L{X2goRevFwTunnel.notify()} gets called from within the transport's - TCP handler function L{x2go_transport_tcp_handler} of the L{X2goSession} instance. + After the reverse tunnel has been setup up with L{X2GoRevFwTunnel.start()} it waits + for notification from L{X2GoRevFwTunnel.notify()} to accept incoming channels. This + notification (L{X2GoRevFwTunnel.notify()} gets called from within the transport's + TCP handler function L{x2go_transport_tcp_handler} of the L{X2GoSession} instance. @param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), normally some number above 30000 @@ -95,18 +95,18 @@ class X2goRevFwTunnel(threading.Thread): @param remote_port: the TCP/IP port on the X2Go client (end point of the tunnel), normally an application's standard port (22 for SSH, 4713 for pulse audio, etc.) @type remote_port: int - @param ssh_transport: the L{X2goSession}'s Paramiko/SSH transport instance + @param ssh_transport: the L{X2GoSession}'s Paramiko/SSH transport instance @type ssh_transport: C{paramiko.Transport} instance - @param logger: you can pass an L{X2goLogger} object to the - L{X2goRevFwTunnel} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoRevFwTunnel} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: int """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -155,7 +155,7 @@ class X2goRevFwTunnel(threading.Thread): def pause(self): """\ Prevent acceptance of new incoming connections through the Paramiko/SSH - reverse forwarding tunnel. Also, any active connection on this L{X2goRevFwTunnel} + reverse forwarding tunnel. Also, any active connection on this L{X2GoRevFwTunnel} instance will be closed immediately, if this method is called. """ @@ -177,14 +177,14 @@ class X2goRevFwTunnel(threading.Thread): def notify(self): """\ - Notify an L{X2goRevFwTunnel} instance of an incoming Paramiko/SSH channel. + Notify an L{X2GoRevFwTunnel} instance of an incoming Paramiko/SSH channel. If an incoming reverse tunnel channel appropriate for this instance has - been detected, this method gets called from the L{X2goSession}'s transport + been detected, this method gets called from the L{X2GoSession}'s transport TCP handler. The sent notification will trigger a C{thread.Condition()} waiting for notification - in L{X2goRevFwTunnel.run()}. + in L{X2GoRevFwTunnel.run()}. """ self.incoming_channel.acquire() @@ -194,7 +194,7 @@ class X2goRevFwTunnel(threading.Thread): def stop_thread(self): """\ - Stops this L{X2goRevFwTunnel} thread completely. + Stops this L{X2GoRevFwTunnel} thread completely. """ self.pause() @@ -220,23 +220,23 @@ class X2goRevFwTunnel(threading.Thread): def run(self): """\ - This method gets run once an L{X2goRevFwTunnel} has been started with its - L{start()} method. Use L{X2goRevFwTunnel}.stop_thread() to stop the + This method gets run once an L{X2GoRevFwTunnel} has been started with its + L{start()} method. Use L{X2GoRevFwTunnel}.stop_thread() to stop the reverse forwarding tunnel again. You can also temporarily lock the tunnel - down with L{X2goRevFwTunnel.pause()} and L{X2goRevFwTunnel.resume()}). + down with L{X2GoRevFwTunnel.pause()} and L{X2GoRevFwTunnel.resume()}). - L{X2goRevFwTunnel.run()} waits for notifications of an appropriate incoming - Paramiko/SSH channel (issued by L{X2goRevFwTunnel.notify()}). Appropriate in + L{X2GoRevFwTunnel.run()} waits for notifications of an appropriate incoming + Paramiko/SSH channel (issued by L{X2GoRevFwTunnel.notify()}). Appropriate in this context means, that its start point on the X2Go server matches the class's property C{server_port}. Once a new incoming channel gets announced by the L{notify()} method, a new - L{X2goRevFwChannelThread} instance will be initialized. As a data stream handler, + L{X2GoRevFwChannelThread} instance will be initialized. As a data stream handler, the function L{x2go_rev_forward_channel_handler()} will be used. The channel will last till the connection gets dropped on the X2Go server side or - until the tunnel gets paused by an L{X2goRevFwTunnel.pause()} call or stopped via the - L{X2goRevFwTunnel.stop_thread()} method. + until the tunnel gets paused by an L{X2GoRevFwTunnel.pause()} call or stopped via the + L{X2GoRevFwTunnel.stop_thread()} method. """ self._request_port_forwarding() @@ -257,7 +257,7 @@ class X2goRevFwTunnel(threading.Thread): self.incoming_channel.release() if self._accept_channels and self._keepalive: - _new_chan_thread = X2goRevFwChannelThread(_chan, (self.remote_host, self.remote_port), + _new_chan_thread = X2GoRevFwChannelThread(_chan, (self.remote_host, self.remote_port), target=x2go_rev_forward_channel_handler, kwargs={ 'chan': _chan, @@ -273,16 +273,16 @@ class X2goRevFwTunnel(threading.Thread): def x2go_rev_forward_channel_handler(chan=None, addr='', port=0, parent_thread=None, logger=None, ): """\ - Handle the data stream of a requested channel that got set up by a L{X2goRevFwTunnel} (Paramiko/SSH + Handle the data stream of a requested channel that got set up by a L{X2GoRevFwTunnel} (Paramiko/SSH reverse forwarding tunnel). The channel (and the corresponding connections) close either ... - ... if the connecting application closes the connection and thus, drops the channel, or - - ... if the L{X2goRevFwTunnel} parent thread gets paused. The call - of L{X2goRevFwTunnel.pause()} on the instance can be used to shut down all incoming - tunneled SSH connections associated to this L{X2goRevFwTunnel} instance + - ... if the L{X2GoRevFwTunnel} parent thread gets paused. The call + of L{X2GoRevFwTunnel.pause()} on the instance can be used to shut down all incoming + tunneled SSH connections associated to this L{X2GoRevFwTunnel} instance from within a Python X2Go application. @param chan: channel @@ -291,11 +291,11 @@ def x2go_rev_forward_channel_handler(chan=None, addr='', port=0, parent_thread=N @type addr: C{str} @param port: bind port @type port: C{int} - @param parent_thread: the calling L{X2goRevFwTunnel} instance - @type parent_thread: L{X2goRevFwTunnel} instance - @param logger: you can pass an L{X2goLogger} object to the - L{X2goRevFwTunnel} constructor - @type logger: L{X2goLogger} instance + @param parent_thread: the calling L{X2GoRevFwTunnel} instance + @type parent_thread: L{X2GoRevFwTunnel} instance + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoRevFwTunnel} constructor + @type logger: L{X2GoLogger} instance """ fw_socket = socket.socket() @@ -332,7 +332,7 @@ def x2go_rev_forward_channel_handler(chan=None, addr='', port=0, parent_thread=N logger('Reverse tunnel %s closed from %r' % (chan, chan.origin_addr,), loglevel=log.loglevel_INFO) -class X2goRevFwChannelThread(threading.Thread): +class X2GoRevFwChannelThread(threading.Thread): """\ Starts a thread for each incoming Paramiko/SSH data channel trough the reverse forwarding tunnel. @@ -342,7 +342,7 @@ class X2goRevFwChannelThread(threading.Thread): """\ Initializes a reverse forwarding channel thread. - @param channel: incoming Paramiko/SSH channel from the L{X2goSession}'s transport + @param channel: incoming Paramiko/SSH channel from the L{X2GoSession}'s transport accept queue @type channel: class @param remote: tuple (addr, port) that specifies the data endpoint of the channel diff --git a/x2go/session.py b/x2go/session.py index 43c9256..cf9a2ea 100644 --- a/x2go/session.py +++ b/x2go/session.py @@ -18,11 +18,11 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -X2goSession class - a public API of Python X2Go, handling standalone X2Go +X2GoSession class - a public API of Python X2Go, handling standalone X2Go sessions. -This class is normally embedded into the context of an L{X2goClient} -instance, but it is also possible to address L{X2goSession}s directly via this +This class is normally embedded into the context of an L{X2GoClient} +instance, but it is also possible to address L{X2GoSession}s directly via this class. To launch a session manually from the Python interactive shell, perform these @@ -35,7 +35,7 @@ simple steps::

...

...

import x2go import gevent Xlib.protocol.request.QueryExtension

• ...

  ...

  ...

  s = x2go.session.X2goSession()

+ >>> s = x2go.session.X2GoSession()

...

...

s.set_server('<my.x2go.server>') s.set_port(<ssh-port>) s.connect('<my-login>', '<my-password>') @@ -70,13 +70,13 @@ import utils import session import x2go_exceptions

-from x2go.backends.control import X2goControlSession as _X2goControlSession -from x2go.backends.terminal import X2goTerminalSession as _X2goTerminalSession -from x2go.backends.info import X2goServerSessionInfo as _X2goServerSessionInfo -from x2go.backends.info import X2goServerSessionList as _X2goServerSessionList -from x2go.backends.proxy import X2goProxy as _X2goProxy -from x2go.backends.settings import X2goClientSettings as _X2goClientSettings -from x2go.backends.printing import X2goClientPrinting as _X2goClientPrinting +from x2go.backends.control import X2GoControlSession as _X2GoControlSession +from x2go.backends.terminal import X2GoTerminalSession as _X2GoTerminalSession +from x2go.backends.info import X2GoServerSessionInfo as _X2GoServerSessionInfo +from x2go.backends.info import X2GoServerSessionList as _X2GoServerSessionList +from x2go.backends.proxy import X2GoProxy as _X2GoProxy +from x2go.backends.settings import X2GoClientSettings as _X2GoClientSettings +from x2go.backends.printing import X2GoClientPrinting as _X2GoClientPrinting from defaults import X2GOCLIENT_OS as _X2GOCLIENT_OS from defaults import LOCAL_HOME as _LOCAL_HOME @@ -98,7 +98,7 @@ _X2GO_SESSION_PARAMS = ('use_sshproxy', 'sshproxy_reuse_authinfo', 'connected', 'virgin', 'running', 'suspended', 'terminated', 'faulty' 'client_instance', ) -"""A list of allowed X2Go pure session parameters (i.e. parameters that are passed on neither to an X2goControlSession, X2goSSHProxy nor an X2goControlSession object.""" +"""A list of allowed X2Go pure session parameters (i.e. parameters that are passed on neither to an X2GoControlSession, X2GoSSHProxy nor an X2GoControlSession object.""" # options of the paramiko.SSHClient().connect() method, any option that is allowed for a terminal session instance _X2GO_TERMINAL_PARAMS = ('geometry', 'depth', 'link', 'pack', 'dpi', 'cache_type', 'kbtype', 'kblayout', 'kbvariant', @@ -123,14 +123,14 @@ _X2GO_SSHPROXY_PARAMS = ('sshproxy_host', 'sshproxy_port', 'sshproxy_user', 'ssh """A list of allowed X2Go SSH proxy parameters.""" -class X2goSession(object): +class X2GoSession(object): """\ Public API class for launching X2Go sessions. Recommended is to manage X2Go sessions from - within an L{X2goClient} instance. However, Python X2Go is designed in a way that it also - allows the management of singel L{X2goSession} instance. + within an L{X2GoClient} instance. However, Python X2Go is designed in a way that it also + allows the management of singel L{X2GoSession} instance. - Thus, you can use the L{X2goSession} class to manually set up X2Go sessions without - L{X2goClient} context (session registry, session list cache, auto-registration of new + Thus, you can use the L{X2GoSession} class to manually set up X2Go sessions without + L{X2GoClient} context (session registry, session list cache, auto-registration of new sessions etc.). """ @@ -148,13 +148,13 @@ class X2goSession(object): allow_share_local_folders=False, share_local_folders=[], restore_shared_local_folders=False, - control_backend=_X2goControlSession, - terminal_backend=_X2goTerminalSession, - info_backend=_X2goServerSessionInfo, - list_backend=_X2goServerSessionList, - proxy_backend=_X2goProxy, - settings_backend=_X2goClientSettings, - printing_backend=_X2goClientPrinting, + control_backend=_X2GoControlSession, + terminal_backend=_X2GoTerminalSession, + info_backend=_X2GoServerSessionInfo, + list_backend=_X2GoServerSessionList, + proxy_backend=_X2GoProxy, + settings_backend=_X2GoClientSettings, + printing_backend=_X2GoClientPrinting, client_rootdir=os.path.join(_LOCAL_HOME, _X2GO_CLIENT_ROOTDIR), sessions_rootdir=os.path.join(_LOCAL_HOME, _X2GO_SESSIONS_ROOTDIR), ssh_rootdir=os.path.join(_LOCAL_HOME, _X2GO_SSH_ROOTDIR), @@ -169,8 +169,8 @@ class X2goSession(object): """\ @param server: hostname of X2Go server @type server: C{str} - @param control_session: an already initialized C{X2goControlSession*} instance - @type control_session: C{X2goControlSession*} instance + @param control_session: an already initialized C{X2GoControlSession*} instance + @type control_session: C{X2GoControlSession*} instance @param use_sshproxy: for communication with X2Go server use an SSH proxy host @type use_sshproxy: C{bool} @param sshproxy_reuse_authinfo: for proxy authentication re-use the X2Go session's password / key file @@ -192,7 +192,7 @@ class X2goSession(object): @param mimebox_extensions: whitelist of allowed X2Go MIME box extensions @type mimebox_extensions: C{list} @param mimebox_action: action for incoming X2Go MIME box files - @type mimebox_action: C{X2goMimeBoxAction*} or C{str} + @type mimebox_action: C{X2GoMimeBoxAction*} or C{str} @param allow_share_local_folders: enable local folder sharing support @type allow_share_local_folders: C{bool} @param share_local_folders: list of local folders to share with the remote X2Go session @@ -219,7 +219,7 @@ class X2goSession(object): @type sessions_rootdir: C{str} @param ssh_rootdir: ssh base dir (default: ~/.ssh) @type ssh_rootdir: C{str} - @param keep_controlsession_alive: On last L{X2goSession.disconnect()} keep the associated C{X2goControlSession*} instance alive? + @param keep_controlsession_alive: On last L{X2GoSession.disconnect()} keep the associated C{X2GoControlSession*} instance alive? @ŧype keep_controlsession_alive: C{bool} @param add_to_known_hosts: Auto-accept server host validity? @type add_to_known_hosts: C{bool} @@ -241,14 +241,14 @@ class X2goSession(object): @type terminated: C{bool} @param faulty: manipulate session state »faulty« by giving a pre-set value @type faulty: C{bool} - @param client_instance: if available, the underlying L{X2goClient} instance - @type client_instance: C{X2goClient} instance + @param client_instance: if available, the underlying L{X2GoClient} instance + @type client_instance: C{X2GoClient} instance @param params: further control session, terminal session and SSH proxy class options @type params: C{dict} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -377,7 +377,7 @@ class X2goSession(object): return self.__get_uuid() def __repr__(self): - result = 'X2goSession(' + result = 'X2GoSession(' for p in dir(self): if '__' in p or not p in self.__dict__ or type(p) is types.InstanceType: continue result += p + '=' + str(self.__dict__[p]) + ',' @@ -428,9 +428,9 @@ class X2goSession(object): def get_client_instance(self): """\ - Return parent L{X2goClient} instance if avaiable. + Return parent L{X2GoClient} instance if avaiable. - return: L{X2goClient} instance this session is associated with + return: L{X2GoClient} instance this session is associated with rtype: C{obj} """ @@ -496,12 +496,12 @@ class X2goSession(object): if self.client_instance: self.client_instance.HOOK_forwarding_tunnel_setup_failed(profile_name=self.profile_name, session_name=self.session_name, chain_host=chain_host, chain_port=chain_port) else: - self.logger('HOOK_forwarding_tunnel_setup_failed: Forwarding tunnel request to [%s]:%s for session %s (%s) was denied by remote X2go/SSH server. Session startup failed.' % (chain_host, chain_port, self.session_name, self.profile_name), loglevel=log.loglevel_WARN) + self.logger('HOOK_forwarding_tunnel_setup_failed: Forwarding tunnel request to [%s]:%s for session %s (%s) was denied by remote X2Go/SSH server. Session startup failed.' % (chain_host, chain_port, self.session_name, self.profile_name), loglevel=log.loglevel_WARN) # get rid of the faulty session... try: self._terminate() - except x2go_exceptions.X2goSessionException: + except x2go_exceptions.X2GoSessionException: pass def HOOK_printing_not_available(self): @@ -568,11 +568,11 @@ class X2goSession(object): def init_control_session(self): """\ - Initialize a new control session (C{X2goControlSession*}). + Initialize a new control session (C{X2GoControlSession*}). """ if self.control_session is None: - self.logger('initializing X2goControlSession', loglevel=log.loglevel_DEBUG) + self.logger('initializing X2GoControlSession', loglevel=log.loglevel_DEBUG) self.control_session = self.control_backend(profile_name=self.profile_name, add_to_known_hosts=self.add_to_known_hosts, known_hosts=self.known_hosts, @@ -594,7 +594,7 @@ class X2goSession(object): The master session is the session has been launched first for a specific connection, it also is _the_ session that controls the client-side shared folders. - If this L{X2goSession} instance is a standalone instance (without parent L{X2goClient}) + If this L{X2GoSession} instance is a standalone instance (without parent L{X2GoClient}) this method will always return C{True}. @return: returns C{True} if this session is a master session @@ -610,7 +610,7 @@ class X2goSession(object): """\ Declare this as a master session of a connection channel. - This method gets called by the L{X2goSessionRegistry} while sessions are starting or resuming and it relies on + This method gets called by the L{X2GoSessionRegistry} while sessions are starting or resuming and it relies on an already set-up terminal session. @param wait: wait for <wait> seconds before sharing local folders via the new master session @@ -654,7 +654,7 @@ class X2goSession(object): def set_server(self, server): """\ - Modify server name after L{X2goSession} has already been initialized. + Modify server name after L{X2GoSession} has already been initialized. @param server: new server name @type server: C{str} @@ -665,7 +665,7 @@ class X2goSession(object): def set_port(self, port): """\ - Modify server port after L{X2goSession} has already been initialized. + Modify server port after L{X2GoSession} has already been initialized. @param port: socket port of server to connect to @type port: C{int} @@ -676,7 +676,7 @@ class X2goSession(object): def set_profile_name(self, profile_name): """\ - Modify session profile name after L{X2goSession} has already been initialized. + Modify session profile name after L{X2GoSession} has already been initialized. @param profile_name: new session profile name @type profile_name: C{str} @@ -696,21 +696,21 @@ class X2goSession(object): @return: value for profile option C{<option>} @rtype: C{bool,str,int} - @raise X2goProfileException: if the session profile option is unknown + @raise X2GoProfileException: if the session profile option is unknown """ if option in _X2GO_SESSION_PARAMS + _X2GO_TERMINAL_PARAMS + _X2GO_SSHPROXY_PARAMS and hasattr(self, option): return eval("self.%s" % option) else: - raise x2go_exceptions.X2goProfileException('Unknown session profile option: %s.' % option) + raise x2go_exceptions.X2GoProfileException('Unknown session profile option: %s.' % option) __get_session_profile_option = get_session_profile_option def update_params(self, params): """\ - This method can be used to modify L{X2goSession} parameters after the - L{X2goSession} instance has already been initialized. + This method can be used to modify L{X2GoSession} parameters after the + L{X2GoSession} instance has already been initialized. - @param params: a Python dictionary with L{X2goSession} parameters + @param params: a Python dictionary with L{X2GoSession} parameters @type params: C{dict} """ @@ -797,7 +797,7 @@ class X2goSession(object): def get_uuid(self): """\ - Retrieve session UUID hash for this L{X2goSession}. + Retrieve session UUID hash for this L{X2GoSession}. @return: the session's UUID hash @rtype: C{str} @@ -980,10 +980,10 @@ class X2goSession(object): def get_control_session(self): """\ - Retrieve the control session (C{X2goControlSession*} backend) of this L{X2goSession}. + Retrieve the control session (C{X2GoControlSession*} backend) of this L{X2GoSession}. - @return: the L{X2goSession}'s control session - @rtype: C{X2goControlSession*} instance + @return: the L{X2GoSession}'s control session + @rtype: C{X2GoControlSession*} instance """ return self.control_session @@ -991,9 +991,9 @@ class X2goSession(object): def has_control_session(self): """\ - Check if this L{X2goSession} instance has an associated control session. + Check if this L{X2GoSession} instance has an associated control session. - @return: returns C{True} if this L{X2goSession} has a control session associated to itself + @return: returns C{True} if this L{X2GoSession} has a control session associated to itself @rtype: C{bool} """ @@ -1002,10 +1002,10 @@ class X2goSession(object): def get_terminal_session(self): """\ - Retrieve the terminal session (C{X2goTerminalSession*} backend) of this L{X2goSession}. + Retrieve the terminal session (C{X2GoTerminalSession*} backend) of this L{X2GoSession}. - @return: the L{X2goSession}'s terminal session - @rtype: C{X2goControlTerminal*} instance + @return: the L{X2GoSession}'s terminal session + @rtype: C{X2GoControlTerminal*} instance """ if self.terminal_session == 'PENDING': @@ -1015,9 +1015,9 @@ class X2goSession(object): def has_terminal_session(self): """\ - Check if this L{X2goSession} instance has an associated terminal session. + Check if this L{X2GoSession} instance has an associated terminal session. - @return: returns C{True} if this L{X2goSession} has a terminal session associated to itself + @return: returns C{True} if this L{X2GoSession} has a terminal session associated to itself @rtype: C{bool} """ @@ -1029,7 +1029,7 @@ class X2goSession(object): def check_host(self): """\ Provide a host check mechanism. This method basically calls the L{HOOK_check_host_dialog()} method - which by itself calls the L{X2goClient.HOOK_check_host_dialog()} method. Make sure you + which by itself calls the L{X2GoClient.HOOK_check_host_dialog()} method. Make sure you override any of these to enable user interaction on X2Go server validity checks. @return: returns C{True} if an X2Go server host is valid for authentication @@ -1098,7 +1098,7 @@ class X2goSession(object): def can_auto_connect(self): """\ - Check if a session is configured adequately to be able to auto-connect to the X2go + Check if a session is configured adequately to be able to auto-connect to the X2Go server (e.g. public key authentication). @return: returns C{True} if the session can auto-connect, C{False} otherwise, C{None} @@ -1153,8 +1153,8 @@ class X2goSession(object): look_for_keys=None, allow_agent=None, use_sshproxy=None, sshproxy_reuse_authinfo=False, sshproxy_user='', sshproxy_password='', sshproxy_force_password_auth=False): """\ - Connects to the L{X2goSession}'s server host. This method basically wraps around - the C{X2goControlSession*.connect()} method. + Connects to the L{X2GoSession}'s server host. This method basically wraps around + the C{X2GoControlSession*.connect()} method. @param username: the username for the X2Go server that is going to be connected to (as a last minute way of changing the session username) @@ -1189,8 +1189,8 @@ class X2goSession(object): @return: returns C{True} is the connection to the X2Go server has been successful @rtype C{bool} - @raise X2goSessionException: on control session exceptions - @raise X2goRemoteHomeException: if the remote home directory does not exist + @raise X2GoSessionException: on control session exceptions + @raise X2GoRemoteHomeException: if the remote home directory does not exist @raise Exception: any other exception during connecting is passed through """ @@ -1246,9 +1246,9 @@ class X2goSession(object): session_instance=self, forward_sshagent=self.forward_sshagent, **_params) - except x2go_exceptions.X2goControlSessionException, e: - raise x2go_exceptions.X2goSessionException(str(e)) - except x2go_exceptions.X2goRemoteHomeException, e: + except x2go_exceptions.X2GoControlSessionException, e: + raise x2go_exceptions.X2GoSessionException(str(e)) + except x2go_exceptions.X2GoRemoteHomeException, e: self.disconnect() raise e except: @@ -1280,7 +1280,7 @@ class X2goSession(object): def disconnect(self): """\ - Disconnect this L{X2goSession} instance. + Disconnect this L{X2GoSession} instance. @return: returns C{True} if the disconnect operation has been successful @rtype: C{bool} @@ -1296,7 +1296,7 @@ class X2goSession(object): self.unset_master_session() try: self.update_status(force_update=True) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: pass retval = self.control_session.disconnect() return retval @@ -1364,7 +1364,7 @@ class X2goSession(object): If X2Go client-side printing is enable within this X2Go session you can use this method to alter the way how incoming print spool jobs are handled/processed. - For further information, please refer to the documentation of the L{X2goClient.set_session_print_action()} + For further information, please refer to the documentation of the L{X2GoClient.set_session_print_action()} method. @param print_action: one of the named above print actions, either as string or class instance @@ -1392,7 +1392,7 @@ class X2goSession(object): if self.control_session.has_session_died(): self.HOOK_on_control_session_death() if not self.connected: - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return self.connected __is_alive = is_alive @@ -1414,7 +1414,7 @@ class X2goSession(object): self.control_session.clean_sessions(destroy_terminals=destroy_terminals, published_applications=published_applications) else: - self._X2goSession__disconnect() + self._X2GoSession__disconnect() __clean_sessions = clean_sessions def list_sessions(self, raw=False): @@ -1426,14 +1426,14 @@ class X2goSession(object): @type raw: C{bool} @return: a session list (as data object or list of strings when called with C{raw=True} option) - @rtype: C{X2goServerSessionList*} instance or C{list} + @rtype: C{X2GoServerSessionList*} instance or C{list} """ try: return self.control_session.list_sessions(raw=raw) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.HOOK_on_control_session_death() - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return None __list_sessions = list_sessions @@ -1451,9 +1451,9 @@ class X2goSession(object): """ try: return self.control_session.list_desktops(raw=raw) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.HOOK_on_control_session_death() - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return None __list_desktops = list_desktops @@ -1462,7 +1462,7 @@ class X2goSession(object): Use the X2Go session registered under C{session_uuid} to retrieve its list of mounted client shares for that session. - @param raw: output the list of mounted client shares in X2go's + @param raw: output the list of mounted client shares in X2Go's raw C{x2golistmounts} format @type raw: C{bool} @@ -1472,29 +1472,29 @@ class X2goSession(object): """ try: return self.control_session.list_mounts(self.session_name, raw=raw) - except x2go_exceptions.X2goControlSessionException: + except x2go_exceptions.X2GoControlSessionException: self.HOOK_on_control_session_death() - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return None __list_mounts = list_mounts def update_status(self, session_list=None, force_update=False): """\ - Update the current session status. The L{X2goSession} instance uses an internal + Update the current session status. The L{X2GoSession} instance uses an internal session status cache that allows to query the session status without the need of retrieving data from the remote X2Go server for each query. - The session status (if initialized properly with the L{X2goClient} constructor gets + The session status (if initialized properly with the L{X2GoClient} constructor gets updated in regularly intervals. - In case you use the L{X2goSession} class in standalone instances (that is: without - being embedded into an L{X2goSession} context) then run this method in regular - intervals to make sure the L{X2goSession}'s internal status cache information + In case you use the L{X2GoSession} class in standalone instances (that is: without + being embedded into an L{X2GoSession} context) then run this method in regular + intervals to make sure the L{X2GoSession}'s internal status cache information is always up-to-date. - @param session_list: provide an C{X2goServerSessionList*} that refers to X2Go sessions we want to update. + @param session_list: provide an C{X2GoServerSessionList*} that refers to X2Go sessions we want to update. This option is mainly for reducing server/client traffic. - @type session_list: C{X2goServerSessionList*} instance + @type session_list: C{X2GoServerSessionList*} instance @param force_update: force a session status update, if if the last update is less then 1 second ago @type force_update: C{bool} @@ -1516,7 +1516,7 @@ class X2goSession(object): try: session_list = self.control_session.list_sessions() self.connected = True - except x2go_exceptions.X2goControlSessionException, e: + except x2go_exceptions.X2GoControlSessionException, e: self.connected = False self.running = None self.suspended = None @@ -1637,7 +1637,7 @@ class X2goSession(object): @type all_suspended: C{bool} @param start: is no session is to be resumed, start a new session @type start: C{bool} - @param redirect_to_client: redirect this call to the L{X2goClient} instance (if available) to allow frontend interaction + @param redirect_to_client: redirect this call to the L{X2GoClient} instance (if available) to allow frontend interaction @type redirect_to_client: C{bool} @return: returns success (or failure) of starting/resuming this sessions @@ -1785,7 +1785,7 @@ class X2goSession(object): self._progress_status = 15 progress_event.set() - except x2go_exceptions.X2goSessionException: + except x2go_exceptions.X2GoSessionException: pass self._progress_status = 20 @@ -1851,7 +1851,7 @@ class X2goSession(object): (self._SUPPORTED_MIMEBOX and self.allow_mimebox) or \ (self._SUPPORTED_FOLDERSHARING and self.allow_share_local_folders): self.has_terminal_session() and not self.faulty and self.terminal_session.start_sshfs() - except x2go_exceptions.X2goUserException, e: + except x2go_exceptions.X2GoUserException, e: self.logger('%s' % str(e), loglevel=log.loglevel_WARN) self.HOOK_sshfs_not_available() self._SUPPORTED_PRINTING = False @@ -1865,7 +1865,7 @@ class X2goSession(object): try: self.has_terminal_session() and not self.faulty and self.terminal_session.start_printing() self.has_terminal_session() and not self.faulty and self.session_environment.update({'X2GO_SPOOLDIR': self.terminal_session.get_printing_spooldir(), }) - except x2go_exceptions.X2goUserException, e: + except x2go_exceptions.X2GoUserException, e: self.logger('%s' % str(e), loglevel=log.loglevel_WARN) self.HOOK_printing_not_available() self._SUPPORTED_PRINTING = False @@ -1877,7 +1877,7 @@ class X2goSession(object): try: self.has_terminal_session() and not self.faulty and self.terminal_session.start_mimebox(mimebox_extensions=self.mimebox_extensions, mimebox_action=self.mimebox_action) self.has_terminal_session() and self.session_environment.update({'X2GO_MIMEBOX': self.terminal_session.get_mimebox_spooldir(), }) - except x2go_exceptions.X2goUserException, e: + except x2go_exceptions.X2GoUserException, e: self.logger('%s' % str(e), loglevel=log.loglevel_WARN) self.HOOK_mimebox_not_available() self._SUPPORTED_MIMEBOX = False @@ -1923,7 +1923,7 @@ class X2goSession(object): self._progress_status = -1 progress_event.set() - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return False __resume = resume @@ -1971,8 +1971,8 @@ class X2goSession(object): @return: returns C{True} if starting the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goDesktopSharingException: if the given desktop ID is not an available desktop session on the remote server - @raise X2goSessionException: if the available desktop session appears to be dead, in fact + @raise X2GoDesktopSharingException: if the given desktop ID is not an available desktop session on the remote server + @raise X2GoSessionException: if the available desktop session appears to be dead, in fact """ self._lock.acquire() @@ -2009,8 +2009,8 @@ class X2goSession(object): @return: returns C{True} if starting the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goDesktopSharingException: if the given desktop ID is not an available desktop session on the remote server - @raise X2goSessionException: if the available desktop session appears to be dead, in fact + @raise X2GoDesktopSharingException: if the given desktop ID is not an available desktop session on the remote server + @raise X2GoSessionException: if the available desktop session appears to be dead, in fact """ self.terminal_session = 'PENDING' @@ -2026,11 +2026,11 @@ class X2goSession(object): _desktop = desktop or '%s@%s' % (user, display) if check_desktop_list: - if not _desktop in self._X2goSession__list_desktops(): + if not _desktop in self._X2GoSession__list_desktops(): _orig_desktop = _desktop _desktop = '%s.0' % _desktop - if not _desktop in self._X2goSession__list_desktops(): - raise x2go_exceptions.X2goDesktopSharingException('No such desktop ID: %s' % _orig_desktop) + if not _desktop in self._X2GoSession__list_desktops(): + raise x2go_exceptions.X2GoDesktopSharingException('No such desktop ID: %s' % _orig_desktop) self._progress_status = 33 progress_event.set() @@ -2055,12 +2055,12 @@ class X2goSession(object): except ValueError: # x2gostartagent output parsing will result in a ValueError. This one we will catch - # here and change it into an X2goSessionException + # here and change it into an X2GoSessionException self._progress_status = -1 progress_event.set() - raise x2go_exceptions.X2goSessionException('the session on desktop %s is seemingly dead' % _desktop) + raise x2go_exceptions.X2GoSessionException('the session on desktop %s is seemingly dead' % _desktop) self._progress_status = 90 progress_event.set() @@ -2093,7 +2093,7 @@ class X2goSession(object): self._progress_status = -1 progress_event.set() - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return False __share_desktop = share_desktop @@ -2105,7 +2105,7 @@ class X2goSession(object): @return: returns C{True} if suspending the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goSessionException: if the session could not be suspended + @raise X2GoSessionException: if the session could not be suspended """ self._lock.acquire() @@ -2125,7 +2125,7 @@ class X2goSession(object): @return: returns C{True} if suspending the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goSessionException: if the session could not be suspended + @raise X2GoSessionException: if the session could not be suspended """ if self.is_alive(): @@ -2161,10 +2161,10 @@ class X2goSession(object): return True else: - raise x2go_exceptions.X2goSessionException('cannot suspend session') + raise x2go_exceptions.X2GoSessionException('cannot suspend session') else: - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return False __suspend = suspend @@ -2176,7 +2176,7 @@ class X2goSession(object): @return: returns C{True} if terminating the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goSessionException: if the session could not be terminated + @raise X2GoSessionException: if the session could not be terminated """ self._lock.acquire() @@ -2196,7 +2196,7 @@ class X2goSession(object): @return: returns C{True} if terminating the session has been successful, C{False} otherwise @rtype: C{bool} - @raise X2goSessionException: if the session could not be terminated + @raise X2GoSessionException: if the session could not be terminated """ if self.is_alive(): @@ -2231,17 +2231,17 @@ class X2goSession(object): self.session_cleanup() return True else: - raise x2go_exceptions.X2goSessionException('cannot terminate session') + raise x2go_exceptions.X2GoSessionException('cannot terminate session') else: - self._X2goSession__disconnect() + self._X2GoSession__disconnect() return False __terminate = terminate def get_profile_name(self): """\ - Retrieve the profile name of this L{X2goSession} instance. + Retrieve the profile name of this L{X2GoSession} instance. @return: X2Go client profile name of the session @rtype: C{str} @@ -2252,7 +2252,7 @@ class X2goSession(object): def get_profile_id(self): """\ - Retrieve the profile ID of this L{X2goSession} instance. + Retrieve the profile ID of this L{X2GoSession} instance. @return: the session profile's id @rtype: C{str} @@ -2267,7 +2267,7 @@ class X2goSession(object): def session_ok(self): """\ - Test if this C{X2goSession} is + Test if this C{X2GoSession} is in a healthy state. @return: C{True} if session is ok, C{False} otherwise @@ -2304,7 +2304,7 @@ class X2goSession(object): def is_connected(self): """\ - Test if the L{X2goSession}'s control session is connected to the + Test if the L{X2GoSession}'s control session is connected to the remote X2Go server. @return: C{True} if session is connected, C{False} otherwise @@ -2322,7 +2322,7 @@ class X2goSession(object): def is_running(self, update_status=False): """\ - Test if the L{X2goSession}'s terminal session is up and running. + Test if the L{X2GoSession}'s terminal session is up and running. @return: C{True} if session is running, C{False} otherwise @rtype: C{bool} @@ -2344,7 +2344,7 @@ class X2goSession(object): def is_suspended(self, update_status=False): """\ - Test if the L{X2goSession}'s terminal session is in suspended state. + Test if the L{X2GoSession}'s terminal session is in suspended state. @return: C{True} if session is suspended, C{False} otherwise @rtype: C{bool} @@ -2366,7 +2366,7 @@ class X2goSession(object): def has_terminated(self, update_status=False): """\ - Test if the L{X2goSession}'s terminal session has terminated. + Test if the L{X2GoSession}'s terminal session has terminated. @return: C{True} if session has terminated, C{False} otherwise @rtype: C{bool} @@ -2432,7 +2432,7 @@ class X2goSession(object): this X2Go session @rtype: C{bool} - @raise X2goSessionException: if this L{X2goSession} does not have an associated terminal session + @raise X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session """ # compat for Python-X2Go (<=0.1.1.6) @@ -2466,7 +2466,7 @@ class X2goSession(object): self._restore_exported_folders[local_path] = False else: - raise x2go_exceptions.X2goSessionException('this X2goSession object does not have any associated terminal') + raise x2go_exceptions.X2GoSessionException('this X2GoSession object does not have any associated terminal') return retval __share_local_folder = share_local_folder @@ -2491,7 +2491,7 @@ class X2goSession(object): for _folder in self.share_local_folders: try: retval = self.share_local_folder(_folder, update_exported_folders=False) and retval - except x2go_exceptions.X2goUserException, e: + except x2go_exceptions.X2GoUserException, e: retval = False self.logger('%s' % str(e), loglevel=log.loglevel_WARN) if update_exported_folders: @@ -2516,7 +2516,7 @@ class X2goSession(object): inside this X2Go session @rtype: C{bool} - @raise X2goSessionException: if this L{X2goSession} does not have an associated terminal session + @raise X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session """ retval = False @@ -2535,7 +2535,7 @@ class X2goSession(object): self.shared_folders[local_path]['status'] = 'mounted' else: - raise x2go_exceptions.X2goSessionException('this X2goSession object does not have any associated terminal') + raise x2go_exceptions.X2GoSessionException('this X2GoSession object does not have any associated terminal') return retval __unshare_local_folder = unshare_local_folder @@ -2554,7 +2554,7 @@ class X2goSession(object): inside this X2Go session @rtype: C{bool} - @raise X2goSessionException: if this L{X2goSession} does not have an associated terminal session + @raise X2GoSessionException: if this L{X2GoSession} does not have an associated terminal session """ if self.has_terminal_session(): @@ -2574,7 +2574,7 @@ class X2goSession(object): self._update_restore_exported_folders() return retval else: - raise x2go_exceptions.X2goSessionException('this X2goSession object does not have any associated terminal') + raise x2go_exceptions.X2GoSessionException('this X2GoSession object does not have any associated terminal') return False __unshare_all_local_folders = unshare_all_local_folders diff --git a/x2go/sftpserver.py b/x2go/sftpserver.py index 839f664..380b14e 100644 --- a/x2go/sftpserver.py +++ b/x2go/sftpserver.py @@ -22,7 +22,7 @@ """\ For sharing local folders via sFTP/sshfs Python X2Go implements its own sFTP -server (as end point of reverse forwarding tunnel requests). Thus, Python X2go +server (as end point of reverse forwarding tunnel requests). Thus, Python X2Go does not need a locally installed SSH daemon on the client side machine. The Python X2Go sFTP server code was originally written by Richard Murri, @@ -55,17 +55,17 @@ class _SSHServer(paramiko.ServerInterface): @param auth_key: Server key that the client has to authenticate against @type auth_key: C{paramiko.RSAKey} instance - @param session_instance: the calling L{X2goSession} instance - @type session_instance: L{X2goSession} instance - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param session_instance: the calling L{X2GoSession} instance + @type session_instance: L{X2GoSession} instance + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -162,9 +162,9 @@ class _SFTPServerInterface(paramiko.SFTPServerInterface): @type server: C{paramiko.ServerInterface} instance @param chroot: chroot environment for this SFTP interface @type chroot: C{str} - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @param server_event: a C{threading.Event} instance that can signal SFTP session termination @@ -172,7 +172,7 @@ class _SFTPServerInterface(paramiko.SFTPServerInterface): """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -490,7 +490,7 @@ class _SFTPServerInterface(paramiko.SFTPServerInterface): self.server_event.set() -class X2goRevFwTunnelToSFTP(rforward.X2goRevFwTunnel): +class X2GoRevFwTunnelToSFTP(rforward.X2GoRevFwTunnel): """\ A reverse fowarding tunnel with an sFTP server at its endpoint. This blend of a Paramiko/SSH reverse forwarding tunnel is used to provide access to local X2Go client folders @@ -505,22 +505,22 @@ class X2goRevFwTunnelToSFTP(rforward.X2goRevFwTunnel): @param server_port: the TCP/IP port on the X2Go server (starting point of the tunnel), normally some number above 30000 @type server_port: C{int} - @param ssh_transport: the L{X2goSession}'s Paramiko/SSH transport instance + @param ssh_transport: the L{X2GoSession}'s Paramiko/SSH transport instance @type ssh_transport: C{paramiko.Transport} instance @param auth_key: Paramiko/SSH RSAkey object that has to be authenticated against by the remote sFTP client @type auth_key: C{paramiko.RSAKey} instance - @param logger: you can pass an L{X2goLogger} object to the - L{X2goRevFwTunnelToSFTP} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoRevFwTunnelToSFTP} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} """ self.ready = False if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -541,22 +541,22 @@ class X2goRevFwTunnelToSFTP(rforward.X2goRevFwTunnel): def run(self): """\ - This method gets run once an L{X2goRevFwTunnelToSFTP} has been started with its - L{start()} method. Use L{X2goRevFwTunnelToSFTP}.stop_thread() to stop the + This method gets run once an L{X2GoRevFwTunnelToSFTP} has been started with its + L{start()} method. Use L{X2GoRevFwTunnelToSFTP}.stop_thread() to stop the reverse forwarding tunnel again (refer also to its pause() and resume() method). - L{X2goRevFwTunnelToSFTP.run()} waits for notifications of an appropriate incoming - Paramiko/SSH channel (issued by L{X2goRevFwTunnelToSFTP.notify()}). Appropriate in + L{X2GoRevFwTunnelToSFTP.run()} waits for notifications of an appropriate incoming + Paramiko/SSH channel (issued by L{X2GoRevFwTunnelToSFTP.notify()}). Appropriate in this context means, that its starting point on the X2Go server matches the class's property C{server_port}. Once a new incoming channel gets announced by the L{notify()} method, a new - L{X2goRevFwSFTPChannelThread} instance will be initialized. As a data stream handler, + L{X2GoRevFwSFTPChannelThread} instance will be initialized. As a data stream handler, the function L{x2go_rev_forward_sftpchannel_handler()} will be used. The channel will last till the connection gets dropped on the X2Go server side or - until the tunnel gets paused by an L{X2goRevFwTunnelToSFTP.pause()} call or - stopped via the C{X2goRevFwTunnelToSFTP.stop_thread()} method. + until the tunnel gets paused by an L{X2GoRevFwTunnelToSFTP.pause()} call or + stopped via the C{X2GoRevFwTunnelToSFTP.stop_thread()} method. """ self._request_port_forwarding() @@ -577,7 +577,7 @@ class X2goRevFwTunnelToSFTP(rforward.X2goRevFwTunnel): self.incoming_channel.release() if self._accept_channels and self._keepalive: - _new_chan_thread = X2goRevFwSFTPChannelThread(_chan, + _new_chan_thread = X2GoRevFwSFTPChannelThread(_chan, target=x2go_rev_forward_sftpchannel_handler, kwargs={ 'chan': _chan, @@ -592,15 +592,15 @@ class X2goRevFwTunnelToSFTP(rforward.X2goRevFwTunnel): def x2go_rev_forward_sftpchannel_handler(chan=None, auth_key=None, logger=None): """\ - Handle incoming sFTP channels that got setup by an L{X2goRevFwTunnelToSFTP} instance. + Handle incoming sFTP channels that got setup by an L{X2GoRevFwTunnelToSFTP} instance. The channel (and the corresponding connections) close either ... - ... if the connecting application closes the connection and thus, drops the sFTP channel, or - - ... if the L{X2goRevFwTunnelToSFTP} parent thread gets paused. The call - of L{X2goRevFwTunnelToSFTP.pause()} on the instance can be used to shut down all incoming - tunneled SSH connections associated to this L{X2goRevFwTunnelToSFTP} instance + - ... if the L{X2GoRevFwTunnelToSFTP} parent thread gets paused. The call + of L{X2GoRevFwTunnelToSFTP.pause()} on the instance can be used to shut down all incoming + tunneled SSH connections associated to this L{X2GoRevFwTunnelToSFTP} instance from within a Python X2Go application. @param chan: an incoming sFTP channel @@ -608,8 +608,8 @@ def x2go_rev_forward_sftpchannel_handler(chan=None, auth_key=None, logger=None): @param auth_key: Paramiko/SSH RSAkey object that has to be authenticated against by the remote sFTP client @type auth_key: C{paramiko.RSAKey} instance - @param logger: you must pass an L{X2goLogger} object to this handler method - @type logger: C{X2goLogger} instance + @param logger: you must pass an L{X2GoLogger} object to this handler method + @type logger: C{X2GoLogger} instance """ if logger is None: @@ -643,5 +643,5 @@ def x2go_rev_forward_sftpchannel_handler(chan=None, auth_key=None, logger=None): logger('sFTP channel %s closed down' % chan, loglevel=log.loglevel_DEBUG) -class X2goRevFwSFTPChannelThread(rforward.X2goRevFwChannelThread): pass -"""A clone of L{rforward.X2goRevFwChannelThread}.""" +class X2GoRevFwSFTPChannelThread(rforward.X2GoRevFwChannelThread): pass +"""A clone of L{rforward.X2GoRevFwChannelThread}.""" diff --git a/x2go/sshproxy.py b/x2go/sshproxy.py index 8252278..f0fd7cc 100644 --- a/x2go/sshproxy.py +++ b/x2go/sshproxy.py @@ -18,7 +18,7 @@ # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. """\ -L{X2goSSHProxy} class - providing a forwarding tunnel for connecting to servers behind firewalls. +L{X2GoSSHProxy} class - providing a forwarding tunnel for connecting to servers behind firewalls. """ __NAME__ = 'x2gosshproxy-pylib' @@ -47,9 +47,9 @@ from x2go.defaults import X2GO_SSH_ROOTDIR as _X2GO_SSH_ROOTDIR import x2go._paramiko x2go._paramiko.monkey_patch_paramiko() -class X2goSSHProxy(paramiko.SSHClient, threading.Thread): +class X2GoSSHProxy(paramiko.SSHClient, threading.Thread): """\ - X2goSSHProxy can be used to proxy X2Go connections through a firewall via SSH. + X2GoSSHProxy can be used to proxy X2Go connections through a firewall via SSH. """ fw_tunnel = None @@ -65,7 +65,7 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): session_instance=None, logger=None, loglevel=log.loglevel_DEFAULT, ): """\ - Initialize an X2goSSHProxy instance. Use an instance of this class to tunnel X2Go requests through + Initialize an X2GoSSHProxy instance. Use an instance of this class to tunnel X2Go requests through a proxying SSH server (i.e. to subLANs that are separated by firewalls or to private IP subLANs that are NATted behind routers). @@ -125,20 +125,20 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): @param ssh_rootdir: local user's SSH base directory (default: ~/.ssh) @type ssh_rootdir: C{str} - @param session_instance: the L{X2goSession} instance that builds up this SSH proxying tunnel - @type session_instance: L{X2goSession} instance - @param logger: you can pass an L{X2goLogger} object to the - L{X2goSSHProxy} constructor - @type logger: L{X2goLogger} instance - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param session_instance: the L{X2GoSession} instance that builds up this SSH proxying tunnel + @type session_instance: L{X2GoSession} instance + @param logger: you can pass an L{X2GoLogger} object to the + L{X2GoSSHProxy} constructor + @type logger: L{X2GoLogger} instance + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: int - @raise X2goSSHProxyAuthenticationException: if the SSH proxy caused a C{paramiko.AuthenticationException} - @raise X2goSSHProxyException: if the SSH proxy caused a C{paramiko.SSHException} + @raise X2GoSSHProxyAuthenticationException: if the SSH proxy caused a C{paramiko.AuthenticationException} + @raise X2GoSSHProxyException: if the SSH proxy caused a C{paramiko.SSHException} """ if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -147,7 +147,7 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): if sshproxy_port: self.port = sshproxy_port - # translate between X2goSession options and paramiko.SSHCLient.connect() options + # translate between X2GoSession options and paramiko.SSHCLient.connect() options # if <hostname>:<port> is used for sshproxy_host, then this <port> is used if sshproxy_host: if sshproxy_host.find(':'): @@ -207,7 +207,7 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): self.load_host_keys(self.known_hosts) if not add_to_known_hosts and session_instance: - self.set_missing_host_key_policy(checkhosts.X2goInteractiveAddPolicy(caller=self, session_instance=session_instance)) + self.set_missing_host_key_policy(checkhosts.X2GoInteractiveAddPolicy(caller=self, session_instance=session_instance)) if add_to_known_hosts: self.set_missing_host_key_policy(paramiko.AutoAddPolicy()) @@ -241,10 +241,10 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): except x2go_exceptions.AuthenticationException, e: self.close() - raise x2go_exceptions.X2goSSHProxyAuthenticationException('pubkey auth mechanisms both failed') + raise x2go_exceptions.X2GoSSHProxyAuthenticationException('pubkey auth mechanisms both failed') except x2go_exceptions.SSHException, e: self.close() - raise x2go_exceptions.X2goSSHProxyAuthenticationException('interactive authentication required') + raise x2go_exceptions.X2GoSSHProxyAuthenticationException('interactive authentication required') except: raise @@ -267,14 +267,14 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): ) except x2go_exceptions.AuthenticationException: self.close() - raise x2go_exceptions.X2goSSHProxyAuthenticationException('interactive auth mechanisms failed') + raise x2go_exceptions.X2GoSSHProxyAuthenticationException('interactive auth mechanisms failed') except: self.close() raise except (x2go_exceptions.SSHException, IOError), e: self.close() - raise x2go_exceptions.X2goSSHProxyException(str(e)) + raise x2go_exceptions.X2GoSSHProxyException(str(e)) except: self.close() raise @@ -304,7 +304,7 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): """\ Start the SSH proxying tunnel... - @raise X2goSSHProxyException: if the SSH proxy could not retrieve an SSH transport for proxying a X2Go server-client connection + @raise X2GoSSHProxyException: if the SSH proxy could not retrieve an SSH transport for proxying a X2Go server-client connection """ if self.get_transport() is not None and self.get_transport().is_authenticated(): @@ -331,7 +331,7 @@ class X2goSSHProxy(paramiko.SSHClient, threading.Thread): gevent.sleep(.1) else: - raise x2go_exceptions.X2goSSHProxyException('SSH proxy connection could not retrieve an SSH transport') + raise x2go_exceptions.X2GoSSHProxyException('SSH proxy connection could not retrieve an SSH transport') def get_local_proxy_host(self): """\ diff --git a/x2go/tests/test_printing.py b/x2go/tests/test_printing.py index 77dba3b..8ac6487 100644 --- a/x2go/tests/test_printing.py +++ b/x2go/tests/test_printing.py @@ -23,7 +23,7 @@ import tempfile # Python X2Go modules import x2go -class TestX2goClientPrinting(unittest.TestCase): +class TestX2GoClientPrinting(unittest.TestCase): def test_client_printing_dialog(self): _printing = """\ @@ -42,8 +42,8 @@ defaultprinter=PDF tf = tempfile.NamedTemporaryFile() print >> tf, _printing tf.seek(0) - p_action = x2go.backends.printing.X2goClientPrinting(config_files=tf.name, client_instance='DUMMY') - self.assertEqual(type(p_action.print_action), x2go.printactions.X2goPrintActionDIALOG) + p_action = x2go.backends.printing.X2GoClientPrinting(config_files=tf.name, client_instance='DUMMY') + self.assertEqual(type(p_action.print_action), x2go.printactions.X2GoPrintActionDIALOG) tf.close() def test_client_printing_pdfview(self): @@ -62,8 +62,8 @@ defaultprinter=PDF tf = tempfile.NamedTemporaryFile() print >> tf, _printing tf.seek(0) - p_action = x2go.backends.printing.X2goClientPrinting(config_files=tf.name) - self.assertEqual(type(p_action.print_action), x2go.printactions.X2goPrintActionPDFVIEW) + p_action = x2go.backends.printing.X2GoClientPrinting(config_files=tf.name) + self.assertEqual(type(p_action.print_action), x2go.printactions.X2GoPrintActionPDFVIEW) tf.close() def test_client_printing_pdfsave(self): @@ -82,8 +82,8 @@ defaultprinter=PDF tf = tempfile.NamedTemporaryFile() print >> tf, _printing tf.seek(0) - p_action = x2go.backends.printing.X2goClientPrinting(config_files=tf.name) - self.assertEqual(type(p_action.print_action), x2go.printactions.X2goPrintActionPDFSAVE) + p_action = x2go.backends.printing.X2GoClientPrinting(config_files=tf.name) + self.assertEqual(type(p_action.print_action), x2go.printactions.X2GoPrintActionPDFSAVE) tf.close() def test_client_printing_print(self): @@ -102,8 +102,8 @@ defaultprinter=PDF tf = tempfile.NamedTemporaryFile() print >> tf, _printing tf.seek(0) - p_action = x2go.backends.printing.X2goClientPrinting(config_files=tf.name) - self.assertEqual(type(p_action.print_action), x2go.printactions.X2goPrintActionPRINT) + p_action = x2go.backends.printing.X2GoClientPrinting(config_files=tf.name) + self.assertEqual(type(p_action.print_action), x2go.printactions.X2GoPrintActionPRINT) tf.close() def test_client_printing_printcmd(self): @@ -122,12 +122,12 @@ defaultprinter=PDF tf = tempfile.NamedTemporaryFile() print >> tf, _printing tf.seek(0) - p_action = x2go.backends.printing.X2goClientPrinting(config_files=tf.name) - self.assertEqual(type(p_action.print_action), x2go.printactions.X2goPrintActionPRINTCMD) + p_action = x2go.backends.printing.X2GoClientPrinting(config_files=tf.name) + self.assertEqual(type(p_action.print_action), x2go.printactions.X2GoPrintActionPRINTCMD) tf.close() def test_suite(): from unittest import TestSuite, makeSuite suite = TestSuite() - suite.addTest(makeSuite(TestX2goClientPrinting)) + suite.addTest(makeSuite(TestX2GoClientPrinting)) return suite diff --git a/x2go/utils.py b/x2go/utils.py index a1dbab5..04306c9 100644 --- a/x2go/utils.py +++ b/x2go/utils.py @@ -163,7 +163,7 @@ def _convert_SessionProfileOptions_2_SessionParams(options): @param options: a dictionary of options, parameter names as in the X2Go ,,sessions'' file @type options: C{dict} - @return: session options as used in C{X2goSession} instances + @return: session options as used in C{X2GoSession} instances @rtype: C{dict} """ @@ -341,7 +341,7 @@ def _convert_SessionProfileOptions_2_SessionParams(options): _params['sshproxy_tunnel'] = 'localhost:44444:%s:%s' % (_params['server'], _params['port']) - # currently known but ignored in Python X2go + # currently known but ignored in Python X2Go _ignored_options = [ 'startsoundsystem', 'soundtunnel', @@ -367,7 +367,7 @@ def session_names_by_timestamp(session_infos): """\ Sorts session profile names by their timestamp (as used in the file format's section name). - @param session_infos: a dictionary of session infos as reported by L{X2goClient.list_sessions()} + @param session_infos: a dictionary of session infos as reported by L{X2GoClient.list_sessions()} @type session_infos: C{dict} @return: a timestamp-sorted list of session names found in C{session_infos} diff --git a/x2go/x2go_exceptions.py b/x2go/x2go_exceptions.py index a8eaa3f..ad19a41 100644 --- a/x2go/x2go_exceptions.py +++ b/x2go/x2go_exceptions.py @@ -39,33 +39,33 @@ BadHostKeyException = paramiko.AuthenticationException SSHException = paramiko.SSHException """inherited from Python Paramiko library""" -class _X2goException(exceptions.BaseException): pass -class X2goClientException(_X2goException): pass -class X2goClientPrintingException(_X2goException): pass -class X2goClientSettingsException(_X2goException): pass -class X2goSessionException(_X2goException): pass -class X2goControlSessionException(_X2goException): pass -class X2goRemoteHomeException(_X2goException): pass -class X2goHostKeyException(_X2goException): pass -class X2goSSHProxyHostKeyException(_X2goException): pass -class X2goTerminalSessionException(_X2goException): pass -class X2goSessionCacheException(_X2goException): pass -class X2goUserException(_X2goException): pass -class X2goProfileException(_X2goException): pass -class X2goSessionRegistryException(_X2goException): pass -class X2goFwTunnelException(_X2goException): pass -class X2goRevFwTunnelException(_X2goException): pass -class X2goPrintException(_X2goException): pass -class X2goPrintQueueException(_X2goException): pass -class X2goPrintActionException(_X2goException): pass -class X2goProxyException(_X2goException): pass -class X2goMIMEboxActionException(_X2goException): pass -class X2goMIMEboxQueueException(_X2goException): pass -class X2goSSHProxyException(_X2goException): pass -class X2goSSHProxyAuthenticationException(_X2goException): pass -class X2goNotImplementedYetException(_X2goException): pass -class X2goDesktopSharingException(_X2goException): pass -class X2goTimeOutException(_X2goException): pass +class _X2GoException(exceptions.BaseException): pass +class X2GoClientException(_X2GoException): pass +class X2GoClientPrintingException(_X2GoException): pass +class X2GoClientSettingsException(_X2GoException): pass +class X2GoSessionException(_X2GoException): pass +class X2GoControlSessionException(_X2GoException): pass +class X2GoRemoteHomeException(_X2GoException): pass +class X2GoHostKeyException(_X2GoException): pass +class X2GoSSHProxyHostKeyException(_X2GoException): pass +class X2GoTerminalSessionException(_X2GoException): pass +class X2GoSessionCacheException(_X2GoException): pass +class X2GoUserException(_X2GoException): pass +class X2GoProfileException(_X2GoException): pass +class X2GoSessionRegistryException(_X2GoException): pass +class X2GoFwTunnelException(_X2GoException): pass +class X2GoRevFwTunnelException(_X2GoException): pass +class X2GoPrintException(_X2GoException): pass +class X2GoPrintQueueException(_X2GoException): pass +class X2GoPrintActionException(_X2GoException): pass +class X2GoProxyException(_X2GoException): pass +class X2GoMIMEboxActionException(_X2GoException): pass +class X2GoMIMEboxQueueException(_X2GoException): pass +class X2GoSSHProxyException(_X2GoException): pass +class X2GoSSHProxyAuthenticationException(_X2GoException): pass +class X2GoNotImplementedYetException(_X2GoException): pass +class X2GoDesktopSharingException(_X2GoException): pass +class X2GoTimeOutException(_X2GoException): pass if _X2GOCLIENT_OS != 'Windows': # faking Windows errors on non-Windows systems... - class WindowsError(_X2goException): pass + class WindowsError(_X2GoException): pass diff --git a/x2go/xserver.py b/x2go/xserver.py index edcb596..ea71102 100644 --- a/x2go/xserver.py +++ b/x2go/xserver.py @@ -43,9 +43,9 @@ from defaults import X2GO_CLIENTXCONFIG_DEFAULTS as _X2GO_CLIENTXCONFIG_DEFAULTS import inifiles import utils -class X2goClientXConfig(inifiles.X2goIniFile): +class X2GoClientXConfig(inifiles.X2GoIniFile): """\ - Configuration file based XServer startup settings for X2goClient instances. + Configuration file based XServer startup settings for X2GoClient instances. This class is needed for Windows systems and (maybe soon) for Unix desktops using Wayland. @@ -54,11 +54,11 @@ class X2goClientXConfig(inifiles.X2goIniFile): def __init__(self, config_files=_X2GO_XCONFIG_CONFIGFILES, defaults=None, logger=None, loglevel=log.loglevel_DEFAULT): """\ - Constructs an L{X2goClientXConfig} instance. This is normally done by an L{X2goClient} instance. - You can retrieve this L{X2goClientXConfig} instance with the C{X2goClient.get_client_xconfig()} + Constructs an L{X2GoClientXConfig} instance. This is normally done by an L{X2GoClient} instance. + You can retrieve this L{X2GoClientXConfig} instance with the C{X2GoClient.get_client_xconfig()} method. - On construction the L{X2goClientXConfig} instance is filled with values from the configuration files:: + On construction the L{X2GoClientXConfig} instance is filled with values from the configuration files:: /etc/x2goclient/xconfig ~/.x2goclient/xconfig @@ -71,9 +71,9 @@ class X2goClientXConfig(inifiles.X2goIniFile): @type config_files: C{list} @param defaults: a Python dictionary with configuration file defaults (use on your own risk) @type defaults: C{dict} - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -83,7 +83,7 @@ class X2goClientXConfig(inifiles.X2goIniFile): class OSNotSupportedException(exceptions.StandardError): pass raise OSNotSupportedException('classes of x2go.xserver module are for Windows only') - inifiles.X2goIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) + inifiles.X2GoIniFile.__init__(self, config_files, defaults=defaults, logger=logger, loglevel=loglevel) _known_xservers = utils.merge_ordered_lists(self.defaultValues['XServers']['known_xservers'], self.known_xservers) @@ -155,7 +155,7 @@ class X2goClientXConfig(inifiles.X2goIniFile): @property def xserver_launch_possible(self): """\ - Detect if there is an XServer (that is known to Python X2go) installed on the system. + Detect if there is an XServer (that is known to Python X2Go) installed on the system. Equals C{True} if we have found an installed XServer that we can launch. """ @@ -239,7 +239,7 @@ class X2goClientXConfig(inifiles.X2goIniFile): pass -class X2goXServer(threading.Thread): +class X2GoXServer(threading.Thread): """ This class is responsible for starting/stopping an external XServer application. @@ -253,11 +253,11 @@ class X2goXServer(threading.Thread): @param xserver_name: name of the XServer to start (refer to the xconfig file for available names) @type xserver_name: C{str} - @param xserver_config: XServer configuration node (as derived from L{X2goClientXConfig.get_xserver_config()} + @param xserver_config: XServer configuration node (as derived from L{X2GoClientXConfig.get_xserver_config()} @type xserver_config: C{dict} - @param logger: you can pass an L{X2goLogger} object to the L{X2goClientXConfig} constructor + @param logger: you can pass an L{X2GoLogger} object to the L{X2GoClientXConfig} constructor @type logger: C{obj} - @param loglevel: if no L{X2goLogger} object has been supplied a new one will be + @param loglevel: if no L{X2GoLogger} object has been supplied a new one will be constructed with the given loglevel @type loglevel: C{int} @@ -268,7 +268,7 @@ class X2goXServer(threading.Thread): raise OSNotSupportedException('classes of x2go.xserver module are for Windows only') if logger is None: - self.logger = log.X2goLogger(loglevel=loglevel) + self.logger = log.X2GoLogger(loglevel=loglevel) else: self.logger = copy.deepcopy(logger) self.logger.tag = __NAME__ @@ -296,7 +296,7 @@ class X2goXServer(threading.Thread): def run(self): """\ - Start this L{X2goXServer} thread. This will launch the configured XServer application. + Start this L{X2GoXServer} thread. This will launch the configured XServer application. """ self._keepalive = True hooks/post-receive -- python-x2go.git (Python X2Go Client API) This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "python-x2go.git" (Python X2Go Client API).