Ticket #2351: skip-clientconnection-mixins.patch

xpra/server/server_base.py

@@ -396 +396 @@
         send_ui = ui_client and not is_request
         self.idle_add(self._process_hello_ui, ss, c, auth_caps, send_ui, share_count)
 
-    def get_client_connection_class(self, _caps):
-        from xpra.server.source.client_connection import ClientConnection
-        return ClientConnection
+    def get_client_connection_class(self, caps):
+        from xpra.server.source.client_connection_factory import get_client_connection_class
+        return get_client_connection_class(caps)
 
 
     def _process_hello_ui(self, ss, c, auth_caps, send_ui, share_count):

xpra/server/source/client_connection.py

@@ -13 +13 @@
 
 from xpra.make_thread import start_thread
 from xpra.os_util import monotonic_time
-from xpra.util import merge_dicts, notypedict, envbool, envint, typedict, AtomicInteger
+from xpra.util import notypedict, envbool, envint, typedict, AtomicInteger
 from xpra.net.compression import compressed_wrapper, Compressed
+from xpra.server.source.stub_source_mixin import StubSourceMixin
 from xpra.server.source.source_stats import GlobalPerformanceStatistics
-from xpra.server.source.clientinfo_mixin import ClientInfoMixin
-from xpra.server import server_features
 from xpra.log import Logger
 
-CC_BASES = [ClientInfoMixin]
-#TODO: notifications mixin
-if server_features.clipboard:
-    from xpra.server.source.clipboard_connection import ClipboardConnection
-    CC_BASES.append(ClipboardConnection)
-if server_features.audio:
-    from xpra.server.source.audio_mixin import AudioMixin
-    CC_BASES.append(AudioMixin)
-if server_features.webcam:
-    from xpra.server.source.webcam_mixin import WebcamMixin
-    CC_BASES.append(WebcamMixin)
-if server_features.fileprint:
-    from xpra.server.source.fileprint_mixin import FilePrintMixin
-    CC_BASES.append(FilePrintMixin)
-if server_features.mmap:
-    from xpra.server.source.mmap_connection import MMAP_Connection
-    CC_BASES.append(MMAP_Connection)
-if server_features.input_devices:
-    from xpra.server.source.input_mixin import InputMixin
-    CC_BASES.append(InputMixin)
-if server_features.dbus:
-    from xpra.server.source.dbus_mixin import DBUS_Mixin
-    CC_BASES.append(DBUS_Mixin)
-if server_features.network_state:
-    from xpra.server.source.networkstate_mixin import NetworkStateMixin
-    CC_BASES.append(NetworkStateMixin)
-if server_features.display:
-    from xpra.server.source.clientdisplay_mixin import ClientDisplayMixin
-    CC_BASES.append(ClientDisplayMixin)
-if server_features.windows:
-    from xpra.server.source.windows_mixin import WindowsMixin
-    CC_BASES.append(WindowsMixin)
-    #must be after windows mixin so it can assume "self.send_windows" is set
-    if server_features.encoding:
-        from xpra.server.source.encodings_mixin import EncodingsMixin
-        CC_BASES.append(EncodingsMixin)
-    if server_features.audio and server_features.av_sync:
-        from xpra.server.source.avsync_mixin import AVSyncMixin
-        CC_BASES.append(AVSyncMixin)
-from xpra.server.source.idle_mixin import IdleMixin
-CC_BASES.append(IdleMixin)
-CC_BASES = tuple(CC_BASES)
-ClientConnectionClass = type('ClientConnectionClass', CC_BASES, {})
-
 log = Logger("server")
 elog = Logger("encoding")
 proxylog = Logger("proxy")
@@ -70 +25 @@
 notifylog = Logger("notify")
 bandwidthlog = Logger("bandwidth")
 
-log("ClientConnectionClass%s", CC_BASES)
 
-
 BANDWIDTH_DETECTION = envbool("XPRA_BANDWIDTH_DETECTION", True)
 MIN_BANDWIDTH = envint("XPRA_MIN_BANDWIDTH", 5*1024*1024)
 AUTO_BANDWIDTH_PCT = envint("XPRA_AUTO_BANDWIDTH_PCT", 80)
@@ -100 +53 @@
 and added to the damage_packet_queue.
 """
 
-class ClientConnection(ClientConnectionClass):
+class ClientConnection(StubSourceMixin):
 
     def __init__(self, protocol, disconnect_cb, session_name, server,
-                 idle_add, timeout_add, source_remove,
                  setting_changed,
                  socket_dir, unix_socket_paths, log_disconnect, bandwidth_limit, bandwidth_detection,
                  ):
@@ -115 +67 @@
         self.disconnect = disconnect_cb
         self.session_name = session_name
 
-        for bc in CC_BASES:
-            try:
-                bc.__init__(self)
-                bc.init_from(self, protocol, server)
-            except Exception as e:
-                raise Exception("failed to initialize %s: %s" % (bc, e)) from None
+        self.socket_dir = socket_dir
+        self.unix_socket_paths = unix_socket_paths
+        self.log_disconnect = log_disconnect
 
-        for c in CC_BASES:
-            c.init_state(self)
+        self.setting_changed = setting_changed
+        # network constraints:
+        self.server_bandwidth_limit = bandwidth_limit
+        self.bandwidth_detection = bandwidth_detection
 
+    def init_state(self):
         #holds actual packets ready for sending (already encoded)
         #these packets are picked off by the "protocol" via 'next_packet()'
         #format: packet, wid, pixels, start_send_cb, end_send_cb
@@ -138 +90 @@
         self.encode_work_queue = None
         self.encode_thread = None
         self.ordinary_packets = []
-        self.socket_dir = socket_dir
-        self.unix_socket_paths = unix_socket_paths
-        self.log_disconnect = log_disconnect
-        self.idle_add = idle_add
-        self.timeout_add = timeout_add
-        self.source_remove = source_remove
 
-        self.setting_changed = setting_changed
-        # network constraints:
-        self.server_bandwidth_limit = bandwidth_limit
-        self.bandwidth_detection = bandwidth_detection
-
         #these statistics are shared by all WindowSource instances:
         self.statistics = GlobalPerformanceStatistics()
 
@@ -157 +98 @@
 
         # ready for processing:
         self.queue_encode = self.start_queue_encode
-        protocol.set_packet_source(self.next_packet)
+        self.protocol.set_packet_source(self.next_packet)
 
 
     def __repr__(self):
@@ -191 +132 @@
     def is_closed(self):
         return self.close_event.isSet()
 
-    def close(self):
-        log("%s.close()", self)
-        for c in CC_BASES:
-            c.cleanup(self)
+    def cleanup(self):
         self.close_event.set()
         self.protocol = None
 
@@ -254 +192 @@
                 ws.bandwidth_limit = max(MIN_BANDWIDTH//10, bandwidth_limit*weight//total_weight)
 
 
-    def parse_hello(self, c):
-        self.ui_client = c.boolget("ui_client", True)
-        self.wants_encodings = c.boolget("wants_encodings", self.ui_client)
-        self.wants_display = c.boolget("wants_display", self.ui_client)
-        self.wants_events = c.boolget("wants_events", False)
-        self.wants_aliases = c.boolget("wants_aliases", True)
-        self.wants_versions = c.boolget("wants_versions", True)
-        self.wants_features = c.boolget("wants_features", True)
-        self.wants_default_cursor = c.boolget("wants_default_cursor", False)
-
-        for mixin in CC_BASES:
-            mixin.parse_client_caps(self, c)
-
+    def parse_client_caps(self, c):
         #general features:
         self.info_namespace = c.boolget("info-namespace")
         self.send_notifications = c.boolget("notifications")
@@ -430 +356 @@
         self.send(*parts, **kwargs)
 
 
-    def send_hello(self, server_capabilities):
-        capabilities = server_capabilities.copy()
-        for bc in CC_BASES:
-            merge_dicts(capabilities, bc.get_caps(self))
-        self.send("hello", capabilities)
-        self.hello_sent = True
-
-
     ######################################################################
     # info:
     def get_info(self) -> dict:
@@ -459 +377 @@
                          "connection"       : p.get_info(),
                          })
         info.update(self.get_features_info())
-        for bc in CC_BASES:
-            try:
-                merge_dicts(info, bc.get_info(self))
-            except Exception as e:
-                log("merge_dicts on %s", bc, exc_info=True)
-                log.error("Error: cannot add information from %s:", bc)
-                log.error(" %s", e)
         return info
 
     def get_features_info(self) -> dict:

xpra/server/source/client_connection_factory.py

@@ +1 @@
+# -*- coding: utf-8 -*-
+# This file is part of Xpra.
+# Copyright (C) 2010-2020 Antoine Martin <antoine@xpra.org>
+# Xpra is released under the terms of the GNU GPL v2, or, at your option, any
+# later version. See the file COPYING for details.
+
+from xpra.server import server_features
+from xpra.util import merge_dicts
+
+
+def get_client_connection_class(caps):
+    from xpra.server.source.client_connection import ClientConnection
+    CC = [ClientConnection]
+    from xpra.server.source.clientinfo_mixin import ClientInfoMixin
+    CC.append(ClientInfoMixin)
+    #TODO: notifications mixin
+    if server_features.clipboard:
+        from xpra.server.source.clipboard_connection import ClipboardConnection
+        CC.append(ClipboardConnection)
+    if server_features.audio:
+        from xpra.server.source.audio_mixin import AudioMixin
+        CC.append(AudioMixin)
+    if server_features.webcam:
+        from xpra.server.source.webcam_mixin import WebcamMixin
+        CC.append(WebcamMixin)
+    if server_features.fileprint:
+        from xpra.server.source.fileprint_mixin import FilePrintMixin
+        CC.append(FilePrintMixin)
+    if server_features.mmap:
+        from xpra.server.source.mmap_connection import MMAP_Connection
+        CC.append(MMAP_Connection)
+    if server_features.input_devices:
+        from xpra.server.source.input_mixin import InputMixin
+        CC.append(InputMixin)
+    if server_features.dbus:
+        from xpra.server.source.dbus_mixin import DBUS_Mixin
+        CC.append(DBUS_Mixin)
+    if server_features.network_state:
+        from xpra.server.source.networkstate_mixin import NetworkStateMixin
+        CC.append(NetworkStateMixin)
+    if server_features.display:
+        from xpra.server.source.clientdisplay_mixin import ClientDisplayMixin
+        CC.append(ClientDisplayMixin)
+    if server_features.windows:
+        from xpra.server.source.windows_mixin import WindowsMixin
+        CC.append(WindowsMixin)
+        #must be after windows mixin so it can assume "self.send_windows" is set
+        if server_features.encoding:
+            from xpra.server.source.encodings_mixin import EncodingsMixin
+            CC.append(EncodingsMixin)
+        if server_features.audio and server_features.av_sync:
+            from xpra.server.source.avsync_mixin import AVSyncMixin
+            CC.append(AVSyncMixin)
+    from xpra.server.source.idle_mixin import IdleMixin
+    CC.append(IdleMixin)
+
+    from xpra.log import Logger
+    log = Logger("server")
+    NEEDED_CC_BASES = []
+    for c in CC:
+        r = c.is_needed(caps)
+        log("%s.is_needed()=%s", c, r)
+        if r:
+            NEEDED_CC_BASES.append(c)
+    CC_BASES = tuple(CC)
+    ClientConnectionClass = type('ClientConnectionClass', CC_BASES, {})
+    log("get_client_connection_class(..)=%s for base classes %s",
+        ClientConnectionClass, CC_BASES)
+
+    class ClientConnectionMuxer(ClientConnectionClass):
+
+        def __init__(self, protocol, disconnect_cb, session_name, server,
+                     idle_add, timeout_add, source_remove,
+                     *args):
+            self.idle_add = idle_add
+            self.timeout_add = timeout_add
+            self.source_remove = source_remove
+            for bc in CC_BASES:
+                try:
+                    if bc==ClientConnection:
+                        initargs = [protocol, disconnect_cb, session_name, server]+list(args)
+                    else:
+                        initargs = ()
+                    bc.__init__(self, *initargs)
+                    bc.init_from(self, protocol, server)
+                except Exception as e:
+                    raise Exception("failed to initialize %s: %s" % (bc, e)) from None
+    
+            for c in CC_BASES:
+                c.init_state(self)
+
+        def close(self):
+            log("%s.close()", self)
+            for bc in reversed(CC_BASES):
+                log("%s.cleanup()", bc)
+                c.cleanup(self)
+
+        def send_hello(self, server_capabilities):
+            capabilities = server_capabilities.copy()
+            for bc in CC_BASES:
+                log("%s.get_caps()", bc)
+                merge_dicts(capabilities, bc.get_caps(self))
+            self.send("hello", capabilities)
+            self.hello_sent = True
+
+        def get_info(self) -> dict:
+            info = {}
+            for bc in CC_BASES:
+                log("%s.get_info()", bc)
+                try:
+                    merge_dicts(info, bc.get_info(self))
+                except Exception as e:
+                    log("merge_dicts on %s", bc, exc_info=True)
+                    log.error("Error: cannot add information from %s:", bc)
+                    log.error(" %s", e)
+            return info
+
+        def parse_hello(self, c):
+            self.ui_client = c.boolget("ui_client", True)
+            self.wants_encodings = c.boolget("wants_encodings", self.ui_client)
+            self.wants_display = c.boolget("wants_display", self.ui_client)
+            self.wants_events = c.boolget("wants_events", False)
+            self.wants_aliases = c.boolget("wants_aliases", True)
+            self.wants_versions = c.boolget("wants_versions", True)
+            self.wants_features = c.boolget("wants_features", True)
+            self.wants_default_cursor = c.boolget("wants_default_cursor", False)
+            for bc in CC_BASES:
+                log("%s.parse_client_caps(..)", bc)
+                bc.parse_client_caps(self, c)
+
+    return ClientConnectionMuxer

xpra/server/source/mmap_connection.py

@@ -16 +16 @@
 
 class MMAP_Connection(StubSourceMixin):
 
+    @classmethod
+    def is_needed(cls, caps):
+        #pre 2.3 clients;
+        if caps.strget("mmap_file"):
+            return True
+        v = caps.rawget("mmap")
+        #we should be receiving a dict with mmap attributes
+        #(but pre v4 clients also send a boolean telling us if mmap is supported by the platform..)
+        return isinstance(v, dict)
+
     def __init__(self):
         self.supports_mmap = False
         self.mmap_filename = None

xpra/server/source/stub_source_mixin.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
 # This file is part of Xpra.
-# Copyright (C) 2018 Antoine Martin <antoine@xpra.org>
+# Copyright (C) 2018-2020 Antoine Martin <antoine@xpra.org>
 # Xpra is released under the terms of the GNU GPL v2, or, at your option, any
 # later version. See the file COPYING for details.
 
@@ -11 +11 @@
 class StubSourceMixin:
 
     """
+    Is this mixin needed for the caps given?
+    """
+    @classmethod
+    def is_needed(cls, caps):
+        return True
+
+    def __init__(self, *_args):
+        pass
+
+    """
     Initialize state attributes.
     """
     def init_state(self):