Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 1 | /* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved. |
Pierre Ossman | 24684e5 | 2016-12-05 16:58:19 +0100 | [diff] [blame] | 2 | * Copyright 2009-2016 Pierre Ossman for Cendio AB |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 3 | * |
| 4 | * This is free software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU General Public License as published by |
| 6 | * the Free Software Foundation; either version 2 of the License, or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This software is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this software; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
| 17 | * USA. |
| 18 | */ |
| 19 | |
| 20 | // -=- VNCServerST.h |
| 21 | |
| 22 | // Single-threaded VNCServer implementation |
| 23 | |
| 24 | #ifndef __RFB_VNCSERVERST_H__ |
| 25 | #define __RFB_VNCSERVERST_H__ |
| 26 | |
Pierre Ossman | bbf955e | 2011-11-08 12:44:10 +0000 | [diff] [blame] | 27 | #include <sys/time.h> |
| 28 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 29 | #include <rfb/SDesktop.h> |
| 30 | #include <rfb/VNCServer.h> |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 31 | #include <rfb/LogWriter.h> |
| 32 | #include <rfb/Blacklist.h> |
| 33 | #include <rfb/Cursor.h> |
Pierre Ossman | bbf955e | 2011-11-08 12:44:10 +0000 | [diff] [blame] | 34 | #include <rfb/Timer.h> |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 35 | #include <network/Socket.h> |
Pierre Ossman | 34e62f3 | 2009-03-20 21:46:12 +0000 | [diff] [blame] | 36 | #include <rfb/ScreenSet.h> |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 37 | |
| 38 | namespace rfb { |
| 39 | |
| 40 | class VNCSConnectionST; |
| 41 | class ComparingUpdateTracker; |
Pierre Ossman | 707fa12 | 2015-12-11 20:21:20 +0100 | [diff] [blame] | 42 | class ListConnInfo; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 43 | class PixelBuffer; |
| 44 | class KeyRemapper; |
| 45 | |
Pierre Ossman | bbf955e | 2011-11-08 12:44:10 +0000 | [diff] [blame] | 46 | class VNCServerST : public VNCServer, |
| 47 | public Timer::Callback, |
| 48 | public network::SocketServer { |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 49 | public: |
| 50 | // -=- Constructors |
| 51 | |
| 52 | // Create a server exporting the supplied desktop. |
Adam Tkac | a6578bf | 2010-04-23 14:07:41 +0000 | [diff] [blame] | 53 | VNCServerST(const char* name_, SDesktop* desktop_); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 54 | virtual ~VNCServerST(); |
| 55 | |
| 56 | |
| 57 | // Methods overridden from SocketServer |
| 58 | |
| 59 | // addSocket |
| 60 | // Causes the server to allocate an RFB-protocol management |
| 61 | // structure for the socket & initialise it. |
| 62 | virtual void addSocket(network::Socket* sock, bool outgoing=false); |
| 63 | |
| 64 | // removeSocket |
| 65 | // Clean up any resources associated with the Socket |
| 66 | virtual void removeSocket(network::Socket* sock); |
| 67 | |
Pierre Ossman | 574dc64 | 2016-10-05 13:39:11 +0200 | [diff] [blame] | 68 | // getSockets() gets a list of sockets. This can be used to generate an |
| 69 | // fd_set for calling select(). |
| 70 | virtual void getSockets(std::list<network::Socket*>* sockets); |
| 71 | |
Pierre Ossman | d408ca5 | 2016-04-29 14:26:05 +0200 | [diff] [blame] | 72 | // processSocketReadEvent |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 73 | // Read more RFB data from the Socket. If an error occurs during |
| 74 | // processing then shutdown() is called on the Socket, causing |
| 75 | // removeSocket() to be called by the caller at a later time. |
Pierre Ossman | d408ca5 | 2016-04-29 14:26:05 +0200 | [diff] [blame] | 76 | virtual void processSocketReadEvent(network::Socket* sock); |
| 77 | |
| 78 | // processSocketWriteEvent |
| 79 | // Flush pending data from the Socket on to the network. |
| 80 | virtual void processSocketWriteEvent(network::Socket* sock); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 81 | |
| 82 | // checkTimeouts |
| 83 | // Returns the number of milliseconds left until the next idle timeout |
| 84 | // expires. If any have already expired, the corresponding connections |
| 85 | // are closed. Zero is returned if there is no idle timeout. |
| 86 | virtual int checkTimeouts(); |
| 87 | |
| 88 | |
| 89 | // Methods overridden from VNCServer |
| 90 | |
Pierre Ossman | 559a2e8 | 2012-01-23 15:54:11 +0000 | [diff] [blame] | 91 | virtual void blockUpdates(); |
| 92 | virtual void unblockUpdates(); |
Pierre Ossman | 04e62db | 2009-03-23 16:57:07 +0000 | [diff] [blame] | 93 | virtual void setPixelBuffer(PixelBuffer* pb, const ScreenSet& layout); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 94 | virtual void setPixelBuffer(PixelBuffer* pb); |
Pierre Ossman | 04e62db | 2009-03-23 16:57:07 +0000 | [diff] [blame] | 95 | virtual void setScreenLayout(const ScreenSet& layout); |
Pierre Ossman | 6094ced | 2018-10-05 17:24:51 +0200 | [diff] [blame] | 96 | virtual const PixelBuffer* getPixelBuffer() const { return pb; } |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 97 | virtual void serverCutText(const char* str, int len); |
Pierre Ossman | eef6c9a | 2018-10-05 17:11:25 +0200 | [diff] [blame] | 98 | |
| 99 | virtual void approveConnection(network::Socket* sock, bool accept, |
| 100 | const char* reason); |
| 101 | virtual void closeClients(const char* reason) {closeClients(reason, 0);} |
| 102 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 103 | virtual void add_changed(const Region ®ion); |
| 104 | virtual void add_copied(const Region &dest, const Point &delta); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 105 | virtual void setCursor(int width, int height, const Point& hotspot, |
Pierre Ossman | 6a1a0d0 | 2017-02-19 15:48:17 +0100 | [diff] [blame] | 106 | const rdr::U8* data); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 107 | virtual void setCursorPos(const Point& p); |
Pierre Ossman | 6094ced | 2018-10-05 17:24:51 +0200 | [diff] [blame] | 108 | virtual void setName(const char* name_); |
Pierre Ossman | bb305ca | 2016-12-11 12:41:26 +0100 | [diff] [blame] | 109 | virtual void setLEDState(unsigned state); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 110 | |
| 111 | virtual void bell(); |
| 112 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 113 | // VNCServerST-only methods |
| 114 | |
Pierre Ossman | 6094ced | 2018-10-05 17:24:51 +0200 | [diff] [blame] | 115 | // Methods to get the currently set server state |
| 116 | |
| 117 | const ScreenSet& getScreenLayout() const { return screenLayout; } |
| 118 | const Cursor* getCursor() const { return cursor; } |
| 119 | const Point& getCursorPos() const { return cursorPos; } |
| 120 | const char* getName() const { return name.buf; } |
| 121 | unsigned getLEDState() const { return ledState; } |
| 122 | |
Pierre Ossman | b684341 | 2018-10-05 17:30:52 +0200 | [diff] [blame^] | 123 | // Event handlers |
| 124 | void keyEvent(rdr::U32 keysym, rdr::U32 keycode, bool down); |
| 125 | void pointerEvent(VNCSConnectionST* client, const Point& pos, int buttonMask); |
| 126 | void clientCutText(const char* str, int len); |
| 127 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 128 | // closeClients() closes all RFB sessions, except the specified one (if |
| 129 | // any), and logs the specified reason for closure. |
| 130 | void closeClients(const char* reason, network::Socket* sock); |
| 131 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 132 | // getSConnection() gets the SConnection for a particular Socket. If |
| 133 | // the Socket is not recognised then null is returned. |
| 134 | |
| 135 | SConnection* getSConnection(network::Socket* sock); |
| 136 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 137 | // queryConnection() is called when a connection has been |
| 138 | // successfully authenticated. The sock and userName arguments identify |
Pierre Ossman | e6aab24 | 2018-10-05 16:59:22 +0200 | [diff] [blame] | 139 | // the socket and the name of the authenticated user, if any. |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 140 | // approveConnection() must be called some time later to accept or reject |
| 141 | // the connection. |
Pierre Ossman | e6aab24 | 2018-10-05 16:59:22 +0200 | [diff] [blame] | 142 | virtual void queryConnection(network::Socket* sock, |
Pierre Ossman | eef6c9a | 2018-10-05 17:11:25 +0200 | [diff] [blame] | 143 | const char* userName); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 144 | |
| 145 | // setBlacklist() is called to replace the VNCServerST's internal |
| 146 | // Blacklist instance with another instance. This allows a single |
| 147 | // Blacklist to be shared by multiple VNCServerST instances. |
| 148 | void setBlacklist(Blacklist* bl) {blHosts = bl ? bl : &blacklist;} |
| 149 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 150 | // setKeyRemapper() replaces the VNCServerST's default key remapper. |
| 151 | // NB: A null pointer is valid here. |
| 152 | void setKeyRemapper(KeyRemapper* kr) { keyRemapper = kr; } |
| 153 | |
| 154 | void getConnInfo(ListConnInfo * listConn); |
| 155 | void setConnStatus(ListConnInfo* listConn); |
| 156 | |
| 157 | bool getDisable() { return disableclients;}; |
| 158 | void setDisable(bool disable) { disableclients = disable;}; |
| 159 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 160 | protected: |
| 161 | |
| 162 | friend class VNCSConnectionST; |
| 163 | |
Pierre Ossman | bbf955e | 2011-11-08 12:44:10 +0000 | [diff] [blame] | 164 | // Timer callbacks |
| 165 | virtual bool handleTimeout(Timer* t); |
| 166 | |
| 167 | // - Internal methods |
| 168 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 169 | void startDesktop(); |
Pierre Ossman | b53c3bf | 2018-03-22 16:01:44 +0100 | [diff] [blame] | 170 | void stopDesktop(); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 171 | |
| 172 | static LogWriter connectionsLog; |
| 173 | Blacklist blacklist; |
| 174 | Blacklist* blHosts; |
| 175 | |
| 176 | SDesktop* desktop; |
| 177 | bool desktopStarted; |
Pierre Ossman | 559a2e8 | 2012-01-23 15:54:11 +0000 | [diff] [blame] | 178 | int blockCounter; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 179 | PixelBuffer* pb; |
Pierre Ossman | 34e62f3 | 2009-03-20 21:46:12 +0000 | [diff] [blame] | 180 | ScreenSet screenLayout; |
Pierre Ossman | bb305ca | 2016-12-11 12:41:26 +0100 | [diff] [blame] | 181 | unsigned int ledState; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 182 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 183 | CharArray name; |
| 184 | |
| 185 | std::list<VNCSConnectionST*> clients; |
| 186 | VNCSConnectionST* pointerClient; |
| 187 | std::list<network::Socket*> closingSockets; |
| 188 | |
| 189 | ComparingUpdateTracker* comparer; |
| 190 | |
| 191 | Point cursorPos; |
Pierre Ossman | 6a1a0d0 | 2017-02-19 15:48:17 +0100 | [diff] [blame] | 192 | Cursor* cursor; |
Pierre Ossman | 6ea6e1a | 2014-02-12 16:33:43 +0100 | [diff] [blame] | 193 | RenderedCursor renderedCursor; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 194 | bool renderedCursorInvalid; |
| 195 | |
| 196 | // - Check how many of the clients are authenticated. |
| 197 | int authClientCount(); |
| 198 | |
| 199 | bool needRenderedCursor(); |
Pierre Ossman | 6e49e95 | 2016-10-07 15:59:38 +0200 | [diff] [blame] | 200 | void startFrameClock(); |
| 201 | void stopFrameClock(); |
Pierre Ossman | a2b80d6 | 2018-03-23 09:30:09 +0100 | [diff] [blame] | 202 | int msToNextUpdate(); |
Pierre Ossman | 6e49e95 | 2016-10-07 15:59:38 +0200 | [diff] [blame] | 203 | void writeUpdate(); |
Pierre Ossman | 8efc7b4 | 2018-03-23 11:45:51 +0100 | [diff] [blame] | 204 | Region getPendingRegion(); |
Pierre Ossman | 24684e5 | 2016-12-05 16:58:19 +0100 | [diff] [blame] | 205 | const RenderedCursor* getRenderedCursor(); |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 206 | |
Pierre Ossman | 04e62db | 2009-03-23 16:57:07 +0000 | [diff] [blame] | 207 | void notifyScreenLayoutChange(VNCSConnectionST *requester); |
| 208 | |
Pierre Ossman | b114cec | 2011-11-20 15:36:11 +0000 | [diff] [blame] | 209 | bool getComparerState(); |
| 210 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 211 | KeyRemapper* keyRemapper; |
Pierre Ossman | 0c9bd4b | 2014-07-09 16:44:11 +0200 | [diff] [blame] | 212 | |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 213 | time_t lastUserInputTime; |
| 214 | time_t lastDisconnectTime; |
| 215 | time_t lastConnectionTime; |
| 216 | |
| 217 | bool disableclients; |
Pierre Ossman | bbf955e | 2011-11-08 12:44:10 +0000 | [diff] [blame] | 218 | |
Pierre Ossman | 6e49e95 | 2016-10-07 15:59:38 +0200 | [diff] [blame] | 219 | Timer frameTimer; |
Constantin Kaplinsky | a2adc8d | 2006-05-25 05:01:55 +0000 | [diff] [blame] | 220 | }; |
| 221 | |
| 222 | }; |
| 223 | |
| 224 | #endif |
| 225 | |