Allow XScreensaver syncing from client to server

Allows to deactivate the screensaver and postpone screensaver
activation if local input is detected on a client. This fixes
the screensavers getting out of sync if a client has a local
input device such as a touchscreen

Author: florianhofhammer

src/lib/barrier/Screen.cpp

@@ -2,11 +2,11 @@
  * barrier -- mouse and keyboard sharing utility
  * Copyright (C) 2012-2016 Symless Ltd.
  * Copyright (C) 2003 Chris Schoeneman
- * 
+ *
  * This package is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * found in the file LICENSE that should have accompanied this file.
- * 
+ *
  * This package is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -178,11 +178,9 @@ Screen::grabClipboard(ClipboardID id)
 void
 Screen::screensaver(bool activate)
 {
-    if (!m_isPrimary) {
-        // activate/deactivation screen saver iff synchronization enabled
-        if (m_screenSaverSync) {
-            m_screen->screensaver(activate);
-        }
+    // activate/deactivation screen saver iff synchronization enabled
+    if (m_screenSaverSync) {
+        m_screen->screensaver(activate);
     }
 }
 
@@ -376,7 +374,7 @@ Screen::isLockedToScreen() const
         if (buttonID != kButtonLeft) {
             LOG((CLOG_DEBUG "locked by mouse buttonID: %d", buttonID));
         }
-        
+
         if (m_enableDragDrop) {
             return (buttonID == kButtonLeft) ? false : true;
         }

src/lib/barrier/Screen.h

@@ -2,11 +2,11 @@
  * barrier -- mouse and keyboard sharing utility
  * Copyright (C) 2012-2016 Symless Ltd.
  * Copyright (C) 2002 Chris Schoeneman
- * 
+ *
  * This package is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * found in the file LICENSE that should have accompanied this file.
- * 
+ *
  * This package is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -223,7 +223,7 @@ class Screen : public IScreen {
 
     //! Change dragging status
     void                setDraggingStarted(bool started);
-    
+
     //! Fake a files dragging operation
     void                startDraggingFiles(DragFileList& fileList);
 
@@ -278,7 +278,7 @@ class Screen : public IScreen {
 
     //! Test if file is dragged on primary screen
     bool                isDraggingStarted() const;
-    
+
     //! Test if file is dragged on secondary screen
     bool                isFakeDraggingStarted() const;
 
@@ -299,7 +299,7 @@ class Screen : public IScreen {
     virtual void        getShape(SInt32& x, SInt32& y,
                             SInt32& width, SInt32& height) const;
     virtual void        getCursorPos(SInt32& x, SInt32& y) const;
-    
+
     IPlatformScreen*    getPlatformScreen() { return m_screen; }
 
 protected:

src/lib/barrier/protocol_types.cpp

@@ -22,7 +22,8 @@ const char*                kMsgHello            = "Barrier%2i%2i";
 const char*                kMsgHelloBack        = "Barrier%2i%2i%s";
 const char*                kMsgCNoop            = "CNOP";
 const char*                kMsgCClose           = "CBYE";
-const char*                kMsgCEnter           = "CINN%2i%2i%4i%2i";
+const char*                kMsgCEnter           = "CINN%2i%2i%4i%2i%1i";
+const char*                kMsgCEnter1_0        = "CINN%2i%2i%4i%2i";
 const char*                kMsgCLeave           = "COUT";
 const char*                kMsgCClipboard       = "CCLP%1i%4i";
 const char*                kMsgCScreenSaver     = "CSEC%1i";

src/lib/barrier/protocol_types.h

@@ -2,11 +2,11 @@
  * barrier -- mouse and keyboard sharing utility
  * Copyright (C) 2012-2016 Symless Ltd.
  * Copyright (C) 2002 Chris Schoeneman
- * 
+ *
  * This package is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * found in the file LICENSE that should have accompanied this file.
- * 
+ *
  * This package is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -30,6 +30,7 @@
 // 1.5:  adds file transfer and removes home brew crypto
 // 1.6:  adds clipboard streaming
 // 1.7:  adds focus/screen switch on local input
+//       adds screensaver sync on client local input
 // NOTE: with new version, barrier minor version should increment
 static const SInt16        kProtocolMajorVersion = 1;
 static const SInt16        kProtocolMinorVersion = 7;
@@ -130,9 +131,16 @@ extern const char*        kMsgCClose;
 // must return this number with some messages.  $4 = modifier key
 // mask.  this will have bits set for each toggle modifier key
 // that is activated on entry to the screen.  the secondary screen
-// should adjust its toggle modifiers to reflect that state.
+// should adjust its toggle modifiers to reflect that state. $5 =
+// forScreensaver flag which denotes whether the screen is only
+// entered for screensaver management purposes or not and thus
+// whether the client can change its screensaver state or should
+// not change the screensaver state
 extern const char*        kMsgCEnter;
 
+// enter screen 1.0: same as above but without respecting the screensaver state
+extern const char*        kMsgCEnter1_0;
+
 // leave screen:  primary -> secondary
 // leaving screen.  the secondary screen should send clipboard
 // data in response to this message for those clipboards that
@@ -149,8 +157,10 @@ extern const char*        kMsgCLeave;
 // most recent kMsgCEnter.  the primary always sends 0.
 extern const char*        kMsgCClipboard;
 
-// screensaver change:  primary -> secondary
-// screensaver on primary has started ($1 == 1) or closed ($1 == 0)
+// screensaver change:  primary <-> secondary
+// screensaver has started ($1 == 1) or closed ($1 == 0).
+// sync screensavers by dispatching information to all clients via
+// the server
 extern const char*        kMsgCScreenSaver;
 
 // reset options:  primary -> secondary

src/lib/client/Client.cpp

@@ -237,10 +237,13 @@ Client::getCursorPos(SInt32& x, SInt32& y) const
 }
 
 void
-Client::enter(SInt32 xAbs, SInt32 yAbs, UInt32, KeyModifierMask mask, bool)
+Client::enter(SInt32 xAbs, SInt32 yAbs, UInt32, KeyModifierMask mask, bool forScreensaver)
 {
     m_active = true;
     m_screen->mouseMove(xAbs, yAbs);
+    if (!forScreensaver) {
+        m_screen->screensaver(false);
+    }
     m_screen->enter(mask);
 
     if (m_sendFileThread != NULL) {
@@ -509,9 +512,17 @@ Client::setupScreen()
                             new TMethodEventJob<Client>(this,
                                 &Client::handleClipboardGrabbed));
     m_events->adoptHandler(m_events->forIScreen().localInput(),
-							getEventTarget(),
-							new TMethodEventJob<Client>(this,
-								&Client::handleLocalInputEvent));
+                            getEventTarget(),
+                            new TMethodEventJob<Client>(this,
+                                &Client::handleLocalInputEvent));
+    m_events->adoptHandler(m_events->forIPrimaryScreen().screensaverActivated(),
+                            getEventTarget(),
+                            new TMethodEventJob<Client>(this,
+                                &Client::handleScreensaverActivatedEvent));
+    m_events->adoptHandler(m_events->forIPrimaryScreen().screensaverDeactivated(),
+                            getEventTarget(),
+                            new TMethodEventJob<Client>(this,
+                                &Client::handleScreensaverDeactivatedEvent));
 }
 
 void
@@ -570,6 +581,11 @@ Client::cleanupScreen()
                             getEventTarget());
         m_events->removeHandler(m_events->forIScreen().localInput(),
                             getEventTarget());
+        m_events->removeHandler(m_events->forIPrimaryScreen().screensaverActivated(),
+                            getEventTarget());
+        m_events->removeHandler(m_events->forIPrimaryScreen().screensaverDeactivated(),
+                            getEventTarget());
+
         delete m_server;
         m_server = NULL;
     }
@@ -745,6 +761,18 @@ Client::handleResume(const Event&, void*)
     }
 }
 
+void
+Client::handleScreensaverActivatedEvent(const Event&, void*) {
+    LOG((CLOG_DEBUG "Client received screensaver activate"));
+    m_server->sendScreensaver(true);
+}
+
+void
+Client::handleScreensaverDeactivatedEvent(const Event&, void*) {
+    LOG((CLOG_DEBUG "Client received screensaver deactivate"));
+    m_server->sendScreensaver(false);
+}
+
 void
 Client::handleFileChunkSending(const Event& event, void*)
 {

src/lib/client/Client.h

@@ -2,11 +2,11 @@
  * barrier -- mouse and keyboard sharing utility
  * Copyright (C) 2012-2016 Symless Ltd.
  * Copyright (C) 2002 Chris Schoeneman
- * 
+ *
  * This package is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * found in the file LICENSE that should have accompanied this file.
- * 
+ *
  * This package is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -90,11 +90,11 @@ class Client : public IClient, public INode {
 
     //! Create a new thread and use it to send file to Server
     void                sendFileToServer(const char* filename);
-    
+
     //! Send dragging file information back to server
     void sendDragInfo(UInt32 fileCount, std::string& info, size_t size);
 
-    
+
     //@}
     //! @name accessors
     //@{
@@ -118,7 +118,7 @@ class Client : public IClient, public INode {
     to connect) to.
     */
     NetworkAddress        getServerAddress() const;
-    
+
     //! Return true if recieved file size is valid
     bool                isReceivedFileSizeValid();
 
@@ -188,6 +188,8 @@ class Client : public IClient, public INode {
     void                handleHello(const Event&, void*);
     void                handleSuspend(const Event& event, void*);
     void                handleResume(const Event& event, void*);
+    void                handleScreensaverActivatedEvent(const Event&, void*);
+    void                handleScreensaverDeactivatedEvent(const Event&, void*);
     void                handleFileChunkSending(const Event&, void*);
     void                handleFileRecieveCompleted(const Event&, void*);
     void                handleStopRetry(const Event&, void*);

src/lib/client/ServerProxy.cpp

@@ -275,7 +275,7 @@ ServerProxy::parseMessage(const UInt8* code)
     }
 
     else if (memcmp(code, kMsgCScreenSaver, 4) == 0) {
-        screensaver();
+        rcvScreensaver();
     }
 
     else if (memcmp(code, kMsgQInfo, 4) == 0) {
@@ -524,11 +524,12 @@ void
 ServerProxy::enter()
 {
     // parse
+    SInt8 forScreensaver;
     SInt16 x, y;
     UInt16 mask;
     UInt32 seqNum;
-    ProtocolUtil::readf(m_stream, kMsgCEnter + 4, &x, &y, &seqNum, &mask);
-    LOG((CLOG_DEBUG1 "recv enter, %d,%d %d %04x", x, y, seqNum, mask));
+    ProtocolUtil::readf(m_stream, kMsgCEnter + 4, &x, &y, &seqNum, &mask, &forScreensaver);
+    LOG((CLOG_DEBUG1 "recv enter, %d,%d %d %04x, forScreensaver=%d", x, y, seqNum, mask, forScreensaver));
 
     // discard old compressed mouse motion, if any
     m_compressMouse         = false;
@@ -538,7 +539,7 @@ ServerProxy::enter()
     m_seqNum                = seqNum;
 
     // forward
-    m_client->enter(x, y, seqNum, static_cast<KeyModifierMask>(mask), false);
+    m_client->enter(x, y, seqNum, static_cast<KeyModifierMask>(mask), forScreensaver != 0);
 }
 
 void
@@ -777,7 +778,7 @@ ServerProxy::mouseWheel()
 }
 
 void
-ServerProxy::screensaver()
+ServerProxy::rcvScreensaver()
 {
     // parse
     SInt8 on;
@@ -788,6 +789,12 @@ ServerProxy::screensaver()
     m_client->screensaver(on != 0);
 }
 
+void
+ServerProxy::sendScreensaver(bool activate) {
+    // Notify server about screensaver state of client
+    ProtocolUtil::writef(m_stream, kMsgCScreenSaver, activate ? 1 : 0);
+}
+
 void
 ServerProxy::resetOptions()
 {

src/lib/client/ServerProxy.h

@@ -60,6 +60,9 @@ class ServerProxy {
     // sending dragging information to server
     void                sendDragInfo(UInt32 fileCount, const char* info, size_t size);
 
+    // Send screensaver information to server
+    void                sendScreensaver(bool activate);
+
 #ifdef TEST_ENV
     void                handleDataForTest() { handleData(Event(), NULL); }
 #endif
@@ -99,7 +102,7 @@ class ServerProxy {
     void                mouseMove();
     void                mouseRelativeMove();
     void                mouseWheel();
-    void                screensaver();
+    void                rcvScreensaver();
     void                resetOptions();
     void                setOptions();
     void                queryInfo();