Server.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 Symless Ltd.
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "base/Event.h"
#include "base/NetworkProtocol.h"
#include "base/Stopwatch.h"
#include "deskflow/Clipboard.h"
#include "deskflow/ClipboardTypes.h"
#include "deskflow/KeyTypes.h"
#include "deskflow/MouseTypes.h"
#include "server/Config.h"
 
#include <climits>
#include <map>
#include <set>
#include <vector>
 
class BaseClientProxy;
class EventQueueTimer;
class PrimaryClient;
class InputFilter;
namespace deskflow {
class Screen;
}
class IEventQueue;
class Thread;
class ClientListener;


class Server
{
  using ServerConfig = deskflow::server::Config;
 
public:
  class LockCursorToScreenInfo : public EventData
  {
  public:
    enum State
    {
      kOff,
      kOn,
      kToggle
    };
 
    explicit LockCursorToScreenInfo(State state = kToggle) : m_state(state)
    {
      // do nothing
    }
    ~LockCursorToScreenInfo() override = default; // do nothing
 
  public:
    State m_state;
  };

  class SwitchToScreenInfo : public EventData
  {
  public:
    explicit SwitchToScreenInfo(const std::string &screen) : m_screen(screen)
    {
      // do nothing
    }
    ~SwitchToScreenInfo() override = default; // do nothing
 
  public:
    std::string m_screen;
  };

  class SwitchInDirectionInfo : public EventData
  {
  public:
    explicit SwitchInDirectionInfo(Direction direction) : m_direction(direction)
    {
      // do nothing
    }
    ~SwitchInDirectionInfo() override = default; // do nothing
 
  public:
    Direction m_direction;
  };

  class ScreenConnectedInfo
  {
  public:
    explicit ScreenConnectedInfo(std::string screen) : m_screen(screen)
    {
      // do nothing
    }
 
  public:
    std::string m_screen; // was char[1]
  };

  class KeyboardBroadcastInfo : public EventData
  {
  public:
    enum State
    {
      kOff,
      kOn,
      kToggle
    };
 
    explicit KeyboardBroadcastInfo(State state = kToggle) : m_state(state)
    {
      // do nothing
    }
    KeyboardBroadcastInfo(State state, const std::string &screens) : m_state(state), m_screens(screens)
    {
      // do nothing
    }
    ~KeyboardBroadcastInfo() override = default; // do nothing
 
  public:
    State m_state;
    std::string m_screens;
  };

  Server(ServerConfig &config, PrimaryClient *primaryClient, deskflow::Screen *screen, IEventQueue *events);
  Server(Server const &) = delete;
  Server(Server &&) = delete;
  ~Server();
 
  Server &operator=(Server const &) = delete;
  Server &operator=(Server &&) = delete;




  bool setConfig(const ServerConfig &);


  void adoptClient(BaseClientProxy *client);


  void disconnect();

  void setListener(ClientListener *p)
  {
    m_clientListener = p;
  }




  std::string protocolString() const;


  uint32_t getNumClients() const;


  void getClients(std::vector<std::string> &list) const;

 
private:
  // get canonical name of client
  std::string getName(const BaseClientProxy *) const;
 
  // get the sides of the primary screen that have neighbors
  uint32_t getActivePrimarySides() const;
 
  // returns true iff mouse should be locked to the current screen
  // according to this object only, ignoring what the primary client
  // says.
  bool isLockedToScreenServer() const;
 
  // returns true iff mouse should be locked to the current screen
  // according to this object or the primary client.
  bool isLockedToScreen() const;
 
  // returns the jump zone of the client
  int32_t getJumpZoneSize(const BaseClientProxy *) const;
 
  // change the active screen
  void switchScreen(BaseClientProxy *, int32_t x, int32_t y, bool forScreenSaver);
 
  // jump to screen
  void jumpToScreen(BaseClientProxy *);
 
  // convert pixel position to fraction, using x or y depending on the
  // direction.
  float mapToFraction(const BaseClientProxy *, Direction, int32_t x, int32_t y) const;
 
  // convert fraction to pixel position, writing only x or y depending
  // on the direction.
  void mapToPixel(const BaseClientProxy *, Direction, float f, int32_t &x, int32_t &y) const;
 
  // returns true if the client has a neighbor anywhere along the edge
  // indicated by the direction.
  bool hasAnyNeighbor(const BaseClientProxy *, Direction) const;
 
  // lookup neighboring screen, mapping the coordinate independent of
  // the direction to the neighbor's coordinate space.
  BaseClientProxy *getNeighbor(const BaseClientProxy *, Direction, int32_t &x, int32_t &y) const;
 
  // lookup neighboring screen.  given a position relative to the
  // source screen, find the screen we should move onto and where.
  // if the position is sufficiently far from the source then we
  // cross multiple screens.  if there is no suitable screen then
  // return nullptr and x,y are not modified.
  BaseClientProxy *mapToNeighbor(BaseClientProxy *, Direction, int32_t &x, int32_t &y) const;
 
  // adjusts x and y or neither to avoid ending up in a jump zone
  // after entering the client in the given direction.
  void avoidJumpZone(const BaseClientProxy *, Direction, int32_t &x, int32_t &y) const;
 
  // test if a switch is permitted.  this includes testing user
  // options like switch delay and tracking any state required to
  // implement them.  returns true iff a switch is permitted.
  bool isSwitchOkay(BaseClientProxy *dst, Direction, int32_t x, int32_t y, int32_t xActive, int32_t yActive);
 
  // update switch state due to a mouse move at \p x, \p y that
  // doesn't switch screens.
  void noSwitch(int32_t x, int32_t y);
 
  // stop switch timers
  void stopSwitch();
 
  // start two tap switch timer
  void startSwitchTwoTap();
 
  // arm the two tap switch timer if \p x, \p y is outside the tap zone
  void armSwitchTwoTap(int32_t x, int32_t y);
 
  // stop the two tap switch timer
  void stopSwitchTwoTap();
 
  // returns true iff the two tap switch timer is started
  bool isSwitchTwoTapStarted() const;
 
  // returns true iff should switch because of two tap
  bool shouldSwitchTwoTap() const;
 
  // start delay switch timer
  void startSwitchWait(int32_t x, int32_t y);
 
  // stop delay switch timer
  void stopSwitchWait();
 
  // returns true iff the delay switch timer is started
  bool isSwitchWaitStarted() const;
 
  // returns the corner (EScreenSwitchCornerMasks) where x,y is on the
  // given client.  corners have the given size.
  uint32_t getCorner(const BaseClientProxy *, int32_t x, int32_t y, int32_t size) const;
 
  // stop relative mouse moves
  void stopRelativeMoves();
 
  // send screen options to \c client
  void sendOptions(BaseClientProxy *client) const;
 
  // process options from configuration
  void processOptions();
 
  // event handlers
  void handleShapeChanged(BaseClientProxy *client);
  void handleClipboardGrabbed(const Event &event, BaseClientProxy *client);
  void handleClipboardChanged(const Event &event, BaseClientProxy *client);
  void handleKeyDownEvent(const Event &event);
  void handleKeyUpEvent(const Event &event);
  void handleKeyRepeatEvent(const Event &event);
  void handleButtonDownEvent(const Event &event);
  void handleButtonUpEvent(const Event &event);
  void handleMotionPrimaryEvent(const Event &event);
  void handleMotionSecondaryEvent(const Event &event);
  void handleWheelEvent(const Event &event);
  void handleSwitchWaitTimeout();
  void handleClientDisconnected(BaseClientProxy *client);
  void handleClientCloseTimeout(BaseClientProxy *client);
  void handleSwitchToScreenEvent(const Event &event);
  void handleSwitchInDirectionEvent(const Event &event);
  void handleToggleScreenEvent(const Event &);
  void handleKeyboardBroadcastEvent(const Event &event);
  void handleLockCursorToScreenEvent(const Event &event);
 
  // event processing
  void onClipboardChanged(const BaseClientProxy *sender, ClipboardID id, uint32_t seqNum);
  void onScreensaver(bool activated);
  void onKeyDown(KeyID, KeyModifierMask, KeyButton, const std::string &, const char *screens);
  void onKeyUp(KeyID, KeyModifierMask, KeyButton, const char *screens);
  void onKeyRepeat(KeyID, KeyModifierMask, int32_t, KeyButton, const std::string &);
  void onMouseDown(ButtonID);
  void onMouseUp(ButtonID);
  bool onMouseMovePrimary(int32_t x, int32_t y);
  void onMouseMoveSecondary(int32_t dx, int32_t dy);
  void onMouseWheel(int32_t xDelta, int32_t yDelta);
 
  // add client to list and attach event handlers for client
  bool addClient(BaseClientProxy *);
 
  // remove client from list and detach event handlers for client
  bool removeClient(BaseClientProxy *);
 
  // close a client
  void closeClient(BaseClientProxy *, const char *msg);
 
  // close clients not in \p config
  void closeClients(const ServerConfig &config);
 
  // close all clients whether they've completed the handshake or not,
  // except the primary client
  void closeAllClients();
 
  // remove clients from internal state
  void removeActiveClient(BaseClientProxy *);
  void removeOldClient(BaseClientProxy *);
 
  // force the cursor off of \p client
  void forceLeaveClient(const BaseClientProxy *client);
 
private:
  class ClipboardInfo
  {
  public:
    ClipboardInfo() = default;
 
  public:
    Clipboard m_clipboard;
    std::string m_clipboardData;
    std::string m_clipboardOwner;
    uint32_t m_clipboardSeqNum = 0;
  };
  // Order suggested by clang
 
  // the Primary Screen Client
  PrimaryClient *m_primaryClient = nullptr;
 
  // the client with focus
  BaseClientProxy *m_active = nullptr;
 
  // current configuration
  ServerConfig *m_config = nullptr;
 
  // input filter (from m_config);
  InputFilter *m_inputFilter = nullptr;
 
  // state saved when screen saver activates
  BaseClientProxy *m_activeSaver = nullptr;
 
  BaseClientProxy *m_switchScreen = nullptr;
  double m_switchWaitDelay = 0.0;
  EventQueueTimer *m_switchWaitTimer = nullptr;
 
  // delay for double-tap screen switching
  double m_switchTwoTapDelay = 0.0;
 
  // server screen
  deskflow::Screen *m_screen;
 
  IEventQueue *m_events = nullptr;
  size_t m_maximumClipboardSize = INT_MAX;
  ClientListener *m_clientListener = nullptr;
  Stopwatch m_switchTwoTapTimer;
 
  // Name of screen broadcasting the keyboard events
  std::string m_keyboardBroadcastingScreens;
 
  // all clients (including the primary client) indexed by name
  using ClientList = std::map<std::string, BaseClientProxy *>;
  using ClientSet = std::set<BaseClientProxy *>;
  ClientList m_clients;
  ClientSet m_clientSet;
 
  // all old connections that we're waiting to hangup
  using OldClients = std::map<BaseClientProxy *, EventQueueTimer *>;
  OldClients m_oldClients;
 
  // clipboard cache
  ClipboardInfo m_clipboards[kClipboardEnd];
 
  // used in hello message sent to the client
  NetworkProtocol m_protocol = NetworkProtocol::Barrier;
 
  // the sequence number of enter messages
  uint32_t m_seqNum = 0;
 
  // current mouse position (in absolute screen coordinates) on
  // whichever screen is active
  int32_t m_x;
  int32_t m_y;
 
  // last mouse deltas.  this is needed to smooth out double tap
  // on win32 which reports bogus mouse motion at the edge of
  // the screen when using low level hooks, synthesizing motion
  // in the opposite direction the mouse actually moved.
  int32_t m_xDelta = 0;
  int32_t m_yDelta = 0;
  int32_t m_xDelta2 = 0;
  int32_t m_yDelta2 = 0;
 
  int32_t m_xSaver;
  int32_t m_ySaver;
 
  // state for delayed screen switching
  int32_t m_switchWaitX;
  int32_t m_switchWaitY;
 
  int32_t m_switchTwoTapZone = 3;
 
  // common state for screen switch tests.  all tests are always
  // trying to reach the same screen in the same direction.
  Direction m_switchDir = Direction::NoDirection;
 
  bool m_switchTwoTapEngaged = false;
  bool m_switchTwoTapArmed = false;
 
  // modifiers needed before switching
  bool m_switchNeedsShift = false;
  bool m_switchNeedsControl = false;
  bool m_switchNeedsAlt = false;
 
  // relative mouse move option
  bool m_relativeMoves = false;
 
  // flag whether or not we have broadcasting enabled and the screens to
  // which we should send broadcasted keys.
  bool m_keyboardBroadcasting = false;
 
  // screen locking (former scroll lock)
  bool m_lockedToScreen = false;
 
  bool m_defaultLockToScreenState = false;
  bool m_disableLockToScreen = false;
  bool m_enableClipboard = true;
};