blob: 8d6a7bc6a1643cf53dc677a8a1acfac7969fc1b3 [file] [log] [blame]
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
Pierre Ossmancef3cf72016-11-25 10:06:34 +01002 * Copyright 2009-2016 Pierre Ossman for Cendio AB
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00003 *
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//
21// VNCSConnectionST is our derived class of SConnection for VNCServerST - there
22// is one for each connected client. We think of VNCSConnectionST as part of
23// the VNCServerST implementation, so its methods are allowed full access to
24// members of VNCServerST.
25//
26
27#ifndef __RFB_VNCSCONNECTIONST_H__
28#define __RFB_VNCSCONNECTIONST_H__
29
Pierre Ossman16e1dcb2017-05-16 14:33:43 +020030#include <map>
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000031#include <rfb/SConnection.h>
32#include <rfb/SMsgWriter.h>
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000033#include <rfb/VNCServerST.h>
Pierre Ossman1bb8b6c2011-10-25 15:20:05 +000034#include <rfb/Timer.h>
Pierre Ossmanc0397262014-03-14 15:59:46 +010035#include <rfb/EncodeManager.h>
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000036
Pierre Ossman1b478e52011-11-15 12:08:30 +000037struct RTTInfo;
38
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000039namespace rfb {
Pierre Ossmanfdba3fe2014-01-31 13:12:18 +010040
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000041 class VNCSConnectionST : public SConnection,
Pierre Ossman1bb8b6c2011-10-25 15:20:05 +000042 public Timer::Callback {
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000043 public:
44 VNCSConnectionST(VNCServerST* server_, network::Socket* s, bool reverse);
45 virtual ~VNCSConnectionST();
46
47 // Methods called from VNCServerST. None of these methods ever knowingly
48 // throw an exception.
49
50 // Unless otherwise stated, the SConnectionST may not be valid after any of
51 // these methods are called, since they catch exceptions and may have
52 // called close() which deletes the object.
53
54 // init() must be called to initialise the protocol. If it fails it
55 // returns false, and close() will have been called.
56 bool init();
57
58 // close() shuts down the socket to the client and deletes the
59 // SConnectionST object.
60 void close(const char* reason);
61
62 // processMessages() processes incoming messages from the client, invoking
63 // various callbacks as a result. It continues to process messages until
64 // reading might block. shutdown() will be called on the connection's
65 // Socket if an error occurs, via the close() call.
66 void processMessages();
67
Pierre Ossmand408ca52016-04-29 14:26:05 +020068 // flushSocket() pushes any unwritten data on to the network.
69 void flushSocket();
70
Pierre Ossmana3ac01e2011-11-07 21:13:54 +000071 // Called when the underlying pixelbuffer is resized or replaced.
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000072 void pixelBufferChange();
Pierre Ossmana3ac01e2011-11-07 21:13:54 +000073
74 // Wrappers to make these methods "safe" for VNCServerST.
75 void writeFramebufferUpdateOrClose();
76 void screenLayoutChangeOrClose(rdr::U16 reason);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000077 void setCursorOrClose();
Pierre Ossmana3ac01e2011-11-07 21:13:54 +000078 void bellOrClose();
79 void serverCutTextOrClose(const char *str, int len);
80 void setDesktopNameOrClose(const char *name);
Pierre Ossmanb45a84f2016-12-12 16:59:15 +010081 void setLEDStateOrClose(unsigned int state);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000082
83 // checkIdleTimeout() returns the number of milliseconds left until the
84 // idle timeout expires. If it has expired, the connection is closed and
85 // zero is returned. Zero is also returned if there is no idle timeout.
86 int checkIdleTimeout();
87
88 // The following methods never throw exceptions nor do they ever delete the
89 // SConnectionST object.
90
Pierre Ossmanb114cec2011-11-20 15:36:11 +000091 // getComparerState() returns if this client would like the framebuffer
92 // comparer to be enabled.
93 bool getComparerState();
94
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000095 // renderedCursorChange() is called whenever the server-side rendered
96 // cursor changes shape or position. It ensures that the next update will
97 // clean up the old rendered cursor and if necessary draw the new rendered
98 // cursor.
99 void renderedCursorChange();
100
101 // needRenderedCursor() returns true if this client needs the server-side
102 // rendered cursor. This may be because it does not support local cursor
103 // or because the current cursor position has not been set by this client.
104 bool needRenderedCursor();
105
106 network::Socket* getSock() { return sock; }
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000107 void add_changed(const Region& region) { updates.add_changed(region); }
108 void add_copied(const Region& dest, const Point& delta) {
109 updates.add_copied(dest, delta);
110 }
111
112 const char* getPeerEndpoint() const {return peerEndpoint.buf;}
113
114 // approveConnectionOrClose() is called some time after
115 // VNCServerST::queryConnection() has returned with PENDING to accept or
116 // reject the connection. The accept argument should be true for
117 // acceptance, or false for rejection, in which case a string reason may
118 // also be given.
119
120 void approveConnectionOrClose(bool accept, const char* reason);
121
122 char* getStartTime();
123
124 void setStatus(int status);
125 int getStatus();
126
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000127 private:
128 // SConnection callbacks
129
130 // These methods are invoked as callbacks from processMsg(). Note that
131 // none of these methods should call any of the above methods which may
132 // delete the SConnectionST object.
133
134 virtual void authSuccess();
135 virtual void queryConnection(const char* userName);
136 virtual void clientInit(bool shared);
137 virtual void setPixelFormat(const PixelFormat& pf);
138 virtual void pointerEvent(const Point& pos, int buttonMask);
Pierre Ossman5ae28212017-05-16 14:30:38 +0200139 virtual void keyEvent(rdr::U32 keysym, rdr::U32 keycode, bool down);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000140 virtual void clientCutText(const char* str, int len);
141 virtual void framebufferUpdateRequest(const Rect& r, bool incremental);
Pierre Ossman34bb0612009-03-21 21:16:14 +0000142 virtual void setDesktopSize(int fb_width, int fb_height,
143 const ScreenSet& layout);
Pierre Ossman2c764942011-11-14 15:54:30 +0000144 virtual void fence(rdr::U32 flags, unsigned len, const char data[]);
Pierre Ossman1b478e52011-11-15 12:08:30 +0000145 virtual void enableContinuousUpdates(bool enable,
146 int x, int y, int w, int h);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000147 virtual void supportsLocalCursor();
Pierre Ossman2c764942011-11-14 15:54:30 +0000148 virtual void supportsFence();
Pierre Ossman1b478e52011-11-15 12:08:30 +0000149 virtual void supportsContinuousUpdates();
Pierre Ossmanb45a84f2016-12-12 16:59:15 +0100150 virtual void supportsLEDState();
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000151
152 // setAccessRights() allows a security package to limit the access rights
153 // of a VNCSConnectioST to the server. These access rights are applied
154 // such that the actual rights granted are the minimum of the server's
155 // default access settings and the connection's access settings.
156 virtual void setAccessRights(AccessRights ar) {accessRights=ar;}
157
Pierre Ossman1bb8b6c2011-10-25 15:20:05 +0000158 // Timer callbacks
159 virtual bool handleTimeout(Timer* t);
160
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000161 // Internal methods
162
Pierre Ossman851e6802017-09-12 16:44:44 +0200163 bool isShiftPressed();
164
Pierre Ossman1b478e52011-11-15 12:08:30 +0000165 // Congestion control
166 void writeRTTPing();
167 void handleRTTPong(const struct RTTInfo &rttInfo);
Pierre Ossman1bb8b6c2011-10-25 15:20:05 +0000168 bool isCongested();
Pierre Ossman1b478e52011-11-15 12:08:30 +0000169 void updateCongestion();
Pierre Ossman1bb8b6c2011-10-25 15:20:05 +0000170
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000171 // writeFramebufferUpdate() attempts to write a framebuffer update to the
172 // client.
173
174 void writeFramebufferUpdate();
Pierre Ossmancef3cf72016-11-25 10:06:34 +0100175 void writeNoDataUpdate();
176 void writeDataUpdate();
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000177
Pierre Ossmana3ac01e2011-11-07 21:13:54 +0000178 void screenLayoutChange(rdr::U16 reason);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000179 void setCursor();
Pierre Ossmana3ac01e2011-11-07 21:13:54 +0000180 void setDesktopName(const char *name);
Pierre Ossmanb45a84f2016-12-12 16:59:15 +0100181 void setLEDState(unsigned int state);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000182 void setSocketTimeouts();
183
184 network::Socket* sock;
185 CharArray peerEndpoint;
Pierre Ossman7069bdd2015-02-06 14:41:58 +0100186 bool reverseConnection;
Pierre Ossmana3ac01e2011-11-07 21:13:54 +0000187
188 bool inProcessMessages;
189
Pierre Ossmanb8b1e962012-07-20 10:47:00 +0000190 bool pendingSyncFence, syncFence;
Pierre Ossman2c764942011-11-14 15:54:30 +0000191 rdr::U32 fenceFlags;
192 unsigned fenceDataLen;
193 char *fenceData;
194
Pierre Ossman1b478e52011-11-15 12:08:30 +0000195 unsigned baseRTT;
196 unsigned congWindow;
Pierre Ossmana9af1f12015-06-17 10:47:28 +0200197 unsigned ackedOffset, sentOffset;
Pierre Ossman1b478e52011-11-15 12:08:30 +0000198
199 unsigned minRTT;
200 bool seenCongestion;
201 unsigned pingCounter;
202 Timer congestionTimer;
203
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000204 VNCServerST* server;
205 SimpleUpdateTracker updates;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000206 Region requested;
Pierre Ossman671d2ef2015-06-09 16:09:06 +0200207 bool updateRenderedCursor, removeRenderedCursor;
208 Region damagedCursorRegion;
Pierre Ossman1b478e52011-11-15 12:08:30 +0000209 bool continuousUpdates;
210 Region cuRegion;
Pierre Ossmanc0397262014-03-14 15:59:46 +0100211 EncodeManager encodeManager;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000212
Pierre Ossman16e1dcb2017-05-16 14:33:43 +0200213 std::map<rdr::U32, rdr::U32> pressedKeys;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000214
215 time_t lastEventTime;
216 time_t pointerEventTime;
217 Point pointerEventPos;
Pierre Ossman25db44a2017-11-16 16:40:44 +0100218 bool clientHasCursor;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000219
220 AccessRights accessRights;
221
222 CharArray closeReason;
223 time_t startTime;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000224 };
225}
226#endif