blob: 0006ff204a8a0664a67a0d896ba56d65773e1e50 [file] [log] [blame]
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +00001/* Copyright (C) 2002-2005 RealVNC Ltd. All Rights Reserved.
Pierre Ossmanc5e25602009-03-20 12:59:05 +00002 * Copyright 2009 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#include <rfb/VNCSConnectionST.h>
21#include <rfb/LogWriter.h>
22#include <rfb/secTypes.h>
Pierre Ossmanc5e25602009-03-20 12:59:05 +000023#include <rfb/screenTypes.h>
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000024#include <rfb/ServerCore.h>
25#include <rfb/ComparingUpdateTracker.h>
26#include <rfb/KeyRemapper.h>
27#define XK_MISCELLANY
28#define XK_XKB_KEYS
29#include <rfb/keysymdef.h>
30
31using namespace rfb;
32
33static LogWriter vlog("VNCSConnST");
34
35VNCSConnectionST::VNCSConnectionST(VNCServerST* server_, network::Socket *s,
36 bool reverse)
37 : SConnection(server_->securityFactory, reverse), sock(s), server(server_),
38 updates(false), image_getter(server->useEconomicTranslate),
39 drawRenderedCursor(false), removeRenderedCursor(false),
40 pointerEventTime(0), accessRights(AccessDefault),
Pierre Ossmanf99c5712009-03-13 14:41:27 +000041 startTime(time(0))
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000042{
43 setStreams(&sock->inStream(), &sock->outStream());
44 peerEndpoint.buf = sock->getPeerEndpoint();
45 VNCServerST::connectionsLog.write(1,"accepted: %s", peerEndpoint.buf);
46
47 // Configure the socket
48 setSocketTimeouts();
49 lastEventTime = time(0);
50
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000051 server->clients.push_front(this);
52}
53
54
55VNCSConnectionST::~VNCSConnectionST()
56{
57 // If we reach here then VNCServerST is deleting us!
58 VNCServerST::connectionsLog.write(1,"closed: %s (%s)",
59 peerEndpoint.buf,
60 (closeReason.buf) ? closeReason.buf : "");
61
62 // Release any keys the client still had pressed
63 std::set<rdr::U32>::iterator i;
64 for (i=pressedKeys.begin(); i!=pressedKeys.end(); i++)
65 server->desktop->keyEvent(*i, false);
66 if (server->pointerClient == this)
67 server->pointerClient = 0;
68
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000069 // Remove this client from the server
70 server->clients.remove(this);
71
72}
73
74
75// Methods called from VNCServerST
76
77bool VNCSConnectionST::init()
78{
79 try {
80 initialiseProtocol();
81 } catch (rdr::Exception& e) {
82 close(e.str());
83 return false;
84 }
85 return true;
86}
87
88void VNCSConnectionST::close(const char* reason)
89{
90 // Log the reason for the close
91 if (!closeReason.buf)
Adam Tkac97abe8a2009-09-04 10:16:58 +000092 closeReason.buf = safe_strdup(reason);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +000093 else
94 vlog.debug("second close: %s (%s)", peerEndpoint.buf, reason);
95
96 if (authenticated()) {
97 server->lastDisconnectTime = time(0);
98 }
99
100 // Just shutdown the socket and mark our state as closing. Eventually the
101 // calling code will call VNCServerST's removeSocket() method causing us to
102 // be deleted.
103 sock->shutdown();
104 setState(RFBSTATE_CLOSING);
105}
106
107
108void VNCSConnectionST::processMessages()
109{
110 if (state() == RFBSTATE_CLOSING) return;
111 try {
112 // - Now set appropriate socket timeouts and process data
113 setSocketTimeouts();
114 bool clientsReadyBefore = server->clientsReadyForUpdate();
115
116 while (getInStream()->checkNoWait(1)) {
117 processMsg();
118 }
119
Constantin Kaplinsky2ef66952008-08-29 11:33:46 +0000120 // If there were update requests, try to send a framebuffer update.
Pierre Ossman02e43d72009-03-05 11:57:11 +0000121 // We don't send updates immediately on requests as this way, we
122 // give higher priority to user actions such as keyboard and
123 // pointer events.
Constantin Kaplinsky2ef66952008-08-29 11:33:46 +0000124 if (!requested.is_empty()) {
125 writeFramebufferUpdate();
126 }
127
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000128 if (!clientsReadyBefore && !requested.is_empty())
129 server->desktop->framebufferUpdateRequest();
130 } catch (rdr::EndOfStream&) {
131 close("Clean disconnection");
132 } catch (rdr::Exception &e) {
133 close(e.str());
134 }
135}
136
137void VNCSConnectionST::writeFramebufferUpdateOrClose()
138{
139 try {
140 writeFramebufferUpdate();
141 } catch(rdr::Exception &e) {
142 close(e.str());
143 }
144}
145
146void VNCSConnectionST::pixelBufferChange()
147{
148 try {
149 if (!authenticated()) return;
150 if (cp.width && cp.height && (server->pb->width() != cp.width ||
151 server->pb->height() != cp.height))
152 {
153 // We need to clip the next update to the new size, but also add any
154 // extra bits if it's bigger. If we wanted to do this exactly, something
155 // like the code below would do it, but at the moment we just update the
156 // entire new size. However, we do need to clip the renderedCursorRect
157 // because that might be added to updates in writeFramebufferUpdate().
158
159 //updates.intersect(server->pb->getRect());
160 //
161 //if (server->pb->width() > cp.width)
162 // updates.add_changed(Rect(cp.width, 0, server->pb->width(),
163 // server->pb->height()));
164 //if (server->pb->height() > cp.height)
165 // updates.add_changed(Rect(0, cp.height, cp.width,
166 // server->pb->height()));
167
168 renderedCursorRect = renderedCursorRect.intersect(server->pb->getRect());
169
170 cp.width = server->pb->width();
171 cp.height = server->pb->height();
Pierre Ossman34e62f32009-03-20 21:46:12 +0000172 cp.screenLayout = server->screenLayout;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000173 if (state() == RFBSTATE_NORMAL) {
Pierre Ossman2ee430a2009-05-28 12:54:24 +0000174 // We should only send EDS to client asking for both
175 if (!writer()->writeExtendedDesktopSize()) {
176 if (!writer()->writeSetDesktopSize()) {
177 close("Client does not support desktop resize");
178 return;
179 }
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000180 }
181 }
182 }
183 // Just update the whole screen at the moment because we're too lazy to
184 // work out what's actually changed.
185 updates.clear();
186 updates.add_changed(server->pb->getRect());
187 vlog.debug("pixel buffer changed - re-initialising image getter");
188 image_getter.init(server->pb, cp.pf(), writer());
189 if (writer()->needFakeUpdate())
190 writeFramebufferUpdate();
191 } catch(rdr::Exception &e) {
192 close(e.str());
193 }
194}
195
Pierre Ossman04e62db2009-03-23 16:57:07 +0000196void VNCSConnectionST::screenLayoutChange(rdr::U16 reason)
197{
198 try {
199 if (!authenticated())
200 return;
201
202 cp.screenLayout = server->screenLayout;
203 if (state() == RFBSTATE_NORMAL) {
204 writer()->writeExtendedDesktopSize(reason, 0, cp.width, cp.height,
205 cp.screenLayout);
206 }
207
208 if (writer()->needFakeUpdate())
209 writeFramebufferUpdate();
210 } catch(rdr::Exception &e) {
211 close(e.str());
212 }
213}
214
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000215void VNCSConnectionST::setColourMapEntriesOrClose(int firstColour,int nColours)
216{
217 try {
218 setColourMapEntries(firstColour, nColours);
219 } catch(rdr::Exception& e) {
220 close(e.str());
221 }
222}
223
224void VNCSConnectionST::bell()
225{
226 try {
227 if (state() == RFBSTATE_NORMAL) writer()->writeBell();
228 } catch(rdr::Exception& e) {
229 close(e.str());
230 }
231}
232
233void VNCSConnectionST::serverCutText(const char *str, int len)
234{
235 try {
236 if (!(accessRights & AccessCutText)) return;
237 if (!rfb::Server::sendCutText) return;
238 if (state() == RFBSTATE_NORMAL)
239 writer()->writeServerCutText(str, len);
240 } catch(rdr::Exception& e) {
241 close(e.str());
242 }
243}
244
Peter Ã…strandc39e0782009-01-15 12:21:42 +0000245
246void VNCSConnectionST::setDesktopName(const char *name)
247{
248 cp.setName(name);
249 try {
250 if (state() == RFBSTATE_NORMAL) {
251 if (!writer()->writeSetDesktopName()) {
252 fprintf(stderr, "Client does not support desktop rename\n");
253 }
254 }
255 } catch(rdr::Exception& e) {
256 close(e.str());
257 }
258}
259
260
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000261void VNCSConnectionST::setCursorOrClose()
262{
263 try {
264 setCursor();
265 } catch(rdr::Exception& e) {
266 close(e.str());
267 }
268}
269
270
271int VNCSConnectionST::checkIdleTimeout()
272{
273 int idleTimeout = rfb::Server::idleTimeout;
274 if (idleTimeout == 0) return 0;
275 if (state() != RFBSTATE_NORMAL && idleTimeout < 15)
276 idleTimeout = 15; // minimum of 15 seconds while authenticating
277 time_t now = time(0);
278 if (now < lastEventTime) {
279 // Someone must have set the time backwards. Set lastEventTime so that the
280 // idleTimeout will count from now.
281 vlog.info("Time has gone backwards - resetting idle timeout");
282 lastEventTime = now;
283 }
284 int timeLeft = lastEventTime + idleTimeout - now;
285 if (timeLeft < -60) {
286 // Our callback is over a minute late - someone must have set the time
287 // forwards. Set lastEventTime so that the idleTimeout will count from
288 // now.
289 vlog.info("Time has gone forwards - resetting idle timeout");
290 lastEventTime = now;
291 return secsToMillis(idleTimeout);
292 }
293 if (timeLeft <= 0) {
294 close("Idle timeout");
295 return 0;
296 }
297 return secsToMillis(timeLeft);
298}
299
300// renderedCursorChange() is called whenever the server-side rendered cursor
301// changes shape or position. It ensures that the next update will clean up
302// the old rendered cursor and if necessary draw the new rendered cursor.
303
304void VNCSConnectionST::renderedCursorChange()
305{
306 if (state() != RFBSTATE_NORMAL) return;
307 removeRenderedCursor = true;
308 if (needRenderedCursor())
309 drawRenderedCursor = true;
310}
311
312// needRenderedCursor() returns true if this client needs the server-side
313// rendered cursor. This may be because it does not support local cursor or
314// because the current cursor position has not been set by this client.
315// Unfortunately we can't know for sure when the current cursor position has
316// been set by this client. We guess that this is the case when the current
317// cursor position is the same as the last pointer event from this client, or
318// if it is a very short time since this client's last pointer event (up to a
319// second). [ Ideally we should do finer-grained timing here and make the time
320// configurable, but I don't think it's that important. ]
321
322bool VNCSConnectionST::needRenderedCursor()
323{
324 return (state() == RFBSTATE_NORMAL
325 && (!cp.supportsLocalCursor && !cp.supportsLocalXCursor
326 || (!server->cursorPos.equals(pointerEventPos) &&
327 (time(0) - pointerEventTime) > 0)));
328}
329
330
331void VNCSConnectionST::approveConnectionOrClose(bool accept,
332 const char* reason)
333{
334 try {
335 approveConnection(accept, reason);
336 } catch (rdr::Exception& e) {
337 close(e.str());
338 }
339}
340
341
342
343// -=- Callbacks from SConnection
344
345void VNCSConnectionST::authSuccess()
346{
347 lastEventTime = time(0);
348
349 server->startDesktop();
350
351 // - Set the connection parameters appropriately
352 cp.width = server->pb->width();
353 cp.height = server->pb->height();
Pierre Ossman34e62f32009-03-20 21:46:12 +0000354 cp.screenLayout = server->screenLayout;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000355 cp.setName(server->getName());
356
357 // - Set the default pixel format
358 cp.setPF(server->pb->getPF());
359 char buffer[256];
360 cp.pf().print(buffer, 256);
361 vlog.info("Server default pixel format %s", buffer);
362 image_getter.init(server->pb, cp.pf(), 0);
363
364 // - Mark the entire display as "dirty"
365 updates.add_changed(server->pb->getRect());
366 startTime = time(0);
367}
368
369void VNCSConnectionST::queryConnection(const char* userName)
370{
371 // - Authentication succeeded - clear from blacklist
372 CharArray name; name.buf = sock->getPeerAddress();
373 server->blHosts->clearBlackmark(name.buf);
374
375 // - Special case to provide a more useful error message
376 if (rfb::Server::neverShared && !rfb::Server::disconnectClients &&
377 server->authClientCount() > 0) {
378 approveConnection(false, "The server is already in use");
379 return;
380 }
381
382 // - Does the client have the right to bypass the query?
383 if (reverseConnection ||
384 !(rfb::Server::queryConnect || sock->requiresQuery()) ||
385 (accessRights & AccessNoQuery))
386 {
387 approveConnection(true);
388 return;
389 }
390
391 // - Get the server to display an Accept/Reject dialog, if required
392 // If a dialog is displayed, the result will be PENDING, and the
393 // server will call approveConnection at a later time
394 CharArray reason;
395 VNCServerST::queryResult qr = server->queryConnection(sock, userName,
396 &reason.buf);
397 if (qr == VNCServerST::PENDING)
398 return;
399
400 // - If server returns ACCEPT/REJECT then pass result to SConnection
401 approveConnection(qr == VNCServerST::ACCEPT, reason.buf);
402}
403
404void VNCSConnectionST::clientInit(bool shared)
405{
406 lastEventTime = time(0);
407 if (rfb::Server::alwaysShared || reverseConnection) shared = true;
408 if (rfb::Server::neverShared) shared = false;
409 if (!shared) {
410 if (rfb::Server::disconnectClients) {
411 // - Close all the other connected clients
412 vlog.debug("non-shared connection - closing clients");
413 server->closeClients("Non-shared connection requested", getSock());
414 } else {
415 // - Refuse this connection if there are existing clients, in addition to
416 // this one
417 if (server->authClientCount() > 1) {
418 close("Server is already in use");
419 return;
420 }
421 }
422 }
423 SConnection::clientInit(shared);
424}
425
426void VNCSConnectionST::setPixelFormat(const PixelFormat& pf)
427{
428 SConnection::setPixelFormat(pf);
429 char buffer[256];
430 pf.print(buffer, 256);
431 vlog.info("Client pixel format %s", buffer);
432 image_getter.init(server->pb, pf, writer());
433 setCursor();
434}
435
436void VNCSConnectionST::pointerEvent(const Point& pos, int buttonMask)
437{
438 pointerEventTime = lastEventTime = time(0);
439 server->lastUserInputTime = lastEventTime;
440 if (!(accessRights & AccessPtrEvents)) return;
441 if (!rfb::Server::acceptPointerEvents) return;
442 if (!server->pointerClient || server->pointerClient == this) {
443 pointerEventPos = pos;
444 if (buttonMask)
445 server->pointerClient = this;
446 else
447 server->pointerClient = 0;
448 server->desktop->pointerEvent(pointerEventPos, buttonMask);
449 }
450}
451
452
453class VNCSConnectionSTShiftPresser {
454public:
455 VNCSConnectionSTShiftPresser(SDesktop* desktop_)
456 : desktop(desktop_), pressed(false) {}
457 ~VNCSConnectionSTShiftPresser() {
458 if (pressed) { desktop->keyEvent(XK_Shift_L, false); }
459 }
460 void press() {
461 desktop->keyEvent(XK_Shift_L, true);
462 pressed = true;
463 }
464 SDesktop* desktop;
465 bool pressed;
466};
467
468// keyEvent() - record in the pressedKeys which keys were pressed. Allow
469// multiple down events (for autorepeat), but only allow a single up event.
470void VNCSConnectionST::keyEvent(rdr::U32 key, bool down) {
471 lastEventTime = time(0);
472 server->lastUserInputTime = lastEventTime;
473 if (!(accessRights & AccessKeyEvents)) return;
474 if (!rfb::Server::acceptKeyEvents) return;
475
476 // Remap the key if required
477 if (server->keyRemapper)
478 key = server->keyRemapper->remapKey(key);
479
480 // Turn ISO_Left_Tab into shifted Tab.
481 VNCSConnectionSTShiftPresser shiftPresser(server->desktop);
482 if (key == XK_ISO_Left_Tab) {
483 if (pressedKeys.find(XK_Shift_L) == pressedKeys.end() &&
484 pressedKeys.find(XK_Shift_R) == pressedKeys.end())
485 shiftPresser.press();
486 key = XK_Tab;
487 }
488
489 if (down) {
490 pressedKeys.insert(key);
491 } else {
492 if (!pressedKeys.erase(key)) return;
493 }
494 server->desktop->keyEvent(key, down);
495}
496
497void VNCSConnectionST::clientCutText(const char* str, int len)
498{
499 if (!(accessRights & AccessCutText)) return;
500 if (!rfb::Server::acceptCutText) return;
501 server->desktop->clientCutText(str, len);
502}
503
504void VNCSConnectionST::framebufferUpdateRequest(const Rect& r,bool incremental)
505{
Pierre Ossmane9962f72009-04-23 12:31:42 +0000506 Rect safeRect;
507
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000508 if (!(accessRights & AccessView)) return;
509
510 SConnection::framebufferUpdateRequest(r, incremental);
511
Pierre Ossmand9a59ba2009-03-20 15:55:37 +0000512 // Check that the client isn't sending crappy requests
513 if (!r.enclosed_by(Rect(0, 0, cp.width, cp.height))) {
514 vlog.error("FramebufferUpdateRequest %dx%d at %d,%d exceeds framebuffer %dx%d",
515 r.width(), r.height(), r.tl.x, r.tl.y, cp.width, cp.height);
Pierre Ossmane9962f72009-04-23 12:31:42 +0000516 safeRect = r.intersect(Rect(0, 0, cp.width, cp.height));
517 } else {
518 safeRect = r;
Pierre Ossmand9a59ba2009-03-20 15:55:37 +0000519 }
520
Constantin Kaplinsky2ef66952008-08-29 11:33:46 +0000521 // Just update the requested region.
522 // Framebuffer update will be sent a bit later, see processMessages().
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000523 Region reqRgn(r);
524 requested.assign_union(reqRgn);
525
526 if (!incremental) {
527 // Non-incremental update - treat as if area requested has changed
528 updates.add_changed(reqRgn);
529 server->comparer->add_changed(reqRgn);
Pierre Ossman53125a72009-04-22 15:37:51 +0000530
531 // And send the screen layout to the client (which, unlike the
532 // framebuffer dimensions, the client doesn't get during init)
Pierre Ossmanc5e25602009-03-20 12:59:05 +0000533 writer()->writeExtendedDesktopSize();
Pierre Ossman53125a72009-04-22 15:37:51 +0000534
535 // We do not send a DesktopSize since it only contains the
536 // framebuffer size (which the client already should know) and
537 // because some clients don't handle extra DesktopSize events
538 // very well.
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000539 }
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000540}
541
Pierre Ossman34bb0612009-03-21 21:16:14 +0000542void VNCSConnectionST::setDesktopSize(int fb_width, int fb_height,
543 const ScreenSet& layout)
Pierre Ossmanc5e25602009-03-20 12:59:05 +0000544{
Pierre Ossman04e62db2009-03-23 16:57:07 +0000545 unsigned int result;
546
547 // Don't bother the desktop with an invalid configuration
548 if (!layout.validate(fb_width, fb_height)) {
549 writer()->writeExtendedDesktopSize(reasonClient, resultInvalid,
550 fb_width, fb_height, layout);
551 if (writer()->needFakeUpdate())
552 writeFramebufferUpdate();
553 return;
554 }
555
556 // FIXME: the desktop will call back to VNCServerST and an extra set
557 // of ExtendedDesktopSize messages will be sent. This is okay
558 // protocol-wise, but unnecessary.
559 result = server->desktop->setScreenLayout(fb_width, fb_height, layout);
560
561 // Always send back a reply to the requesting client
562 writer()->writeExtendedDesktopSize(reasonClient, result,
563 fb_width, fb_height, layout);
564 if (writer()->needFakeUpdate())
565 writeFramebufferUpdate();
566
567 // But only notify other clients on success
568 if (result == resultSuccess) {
569 if (server->screenLayout != layout)
570 throw Exception("Desktop configured a different screen layout than requested");
571 server->notifyScreenLayoutChange(this);
572 }
Pierre Ossmanc5e25602009-03-20 12:59:05 +0000573}
574
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000575void VNCSConnectionST::setInitialColourMap()
576{
577 setColourMapEntries(0, 0);
578}
579
580// supportsLocalCursor() is called whenever the status of
581// cp.supportsLocalCursor has changed. If the client does now support local
582// cursor, we make sure that the old server-side rendered cursor is cleaned up
583// and the cursor is sent to the client.
584
585void VNCSConnectionST::supportsLocalCursor()
586{
587 if (cp.supportsLocalCursor || cp.supportsLocalXCursor) {
588 removeRenderedCursor = true;
589 drawRenderedCursor = false;
590 setCursor();
591 }
592}
593
594void VNCSConnectionST::writeSetCursorCallback()
595{
596 if (cp.supportsLocalXCursor) {
597 Pixel pix0, pix1;
598 rdr::U8Array bitmap(server->cursor.getBitmap(&pix0, &pix1));
599 if (bitmap.buf) {
600 // The client supports XCursor and the cursor only has two
601 // colors. Use the XCursor encoding.
602 writer()->writeSetXCursor(server->cursor.width(),
603 server->cursor.height(),
604 server->cursor.hotspot.x,
605 server->cursor.hotspot.y,
606 bitmap.buf, server->cursor.mask.buf);
607 return;
608 } else {
609 // More than two colors
610 if (!cp.supportsLocalCursor) {
611 // FIXME: We could reduce to two colors.
612 vlog.info("Unable to send multicolor cursor: RichCursor not supported by client");
613 return;
614 }
615 }
616 }
617
618 // Use RichCursor
619 rdr::U8* transData = writer()->getImageBuf(server->cursor.area());
620 image_getter.translatePixels(server->cursor.data, transData,
621 server->cursor.area());
622 writer()->writeSetCursor(server->cursor.width(),
623 server->cursor.height(),
624 server->cursor.hotspot,
625 transData, server->cursor.mask.buf);
626}
627
628
629void VNCSConnectionST::writeFramebufferUpdate()
630{
Pierre Ossmane9962f72009-04-23 12:31:42 +0000631 if (state() != RFBSTATE_NORMAL || requested.is_empty())
632 return;
Pierre Ossmand9a59ba2009-03-20 15:55:37 +0000633
Pierre Ossmane9962f72009-04-23 12:31:42 +0000634 // First take care of any updates that cannot contain framebuffer data
635 // changes.
636 if (writer()->needNoDataUpdate()) {
637 writer()->writeNoDataUpdate();
638 requested.clear();
639 return;
640 }
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000641
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000642 updates.enable_copyrect(cp.useCopyRect);
643
Pierre Ossman02e43d72009-03-05 11:57:11 +0000644 server->checkUpdate();
Constantin Kaplinskya09dc142008-12-18 12:08:15 +0000645
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000646 // Get the lists of updates. Prior to exporting the data to the `ui' object,
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000647 // getUpdateInfo() will normalize the `updates' object such way that its
Pierre Ossman02e43d72009-03-05 11:57:11 +0000648 // `changed' and `copied' regions would not intersect.
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000649
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000650 UpdateInfo ui;
651 updates.getUpdateInfo(&ui, requested);
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000652 bool needNewUpdateInfo = false;
653
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000654 // If the previous position of the rendered cursor overlaps the source of the
655 // copy, then when the copy happens the corresponding rectangle in the
656 // destination will be wrong, so add it to the changed region.
657
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000658 if (!ui.copied.is_empty() && !renderedCursorRect.is_empty()) {
659 Rect bogusCopiedCursor = (renderedCursorRect.translate(ui.copy_delta)
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000660 .intersect(server->pb->getRect()));
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000661 if (!ui.copied.intersect(bogusCopiedCursor).is_empty()) {
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000662 updates.add_changed(bogusCopiedCursor);
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000663 needNewUpdateInfo = true;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000664 }
665 }
666
667 // If we need to remove the old rendered cursor, just add the rectangle to
668 // the changed region.
669
670 if (removeRenderedCursor) {
671 updates.add_changed(renderedCursorRect);
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000672 needNewUpdateInfo = true;
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000673 renderedCursorRect.clear();
674 removeRenderedCursor = false;
675 }
676
677 // Return if there is nothing to send the client.
678
679 if (updates.is_empty() && !writer()->needFakeUpdate() && !drawRenderedCursor)
680 return;
681
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000682 // The `updates' object could change, make sure we have valid update info.
683
684 if (needNewUpdateInfo)
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000685 updates.getUpdateInfo(&ui, requested);
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000686
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000687 // If the client needs a server-side rendered cursor, work out the cursor
688 // rectangle. If it's empty then don't bother drawing it, but if it overlaps
689 // with the update region, we need to draw the rendered cursor regardless of
690 // whether it has changed.
691
692 if (needRenderedCursor()) {
693 renderedCursorRect
694 = (server->renderedCursor.getRect(server->renderedCursorTL)
695 .intersect(requested.get_bounding_rect()));
696
697 if (renderedCursorRect.is_empty()) {
698 drawRenderedCursor = false;
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000699 } else if (!ui.changed.union_(ui.copied)
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000700 .intersect(renderedCursorRect).is_empty()) {
701 drawRenderedCursor = true;
702 }
703
704 // We could remove the new cursor rect from updates here. It's not clear
705 // whether this is worth it. If we do remove it, then we won't draw over
706 // the same bit of screen twice, but we have the overhead of a more complex
707 // region.
708
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000709 //if (drawRenderedCursor) {
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000710 // updates.subtract(renderedCursorRect);
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000711 // updates.getUpdateInfo(&ui, requested);
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000712 //}
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000713 }
714
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000715 if (!ui.is_empty() || writer()->needFakeUpdate() || drawRenderedCursor) {
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000716 // Compute the number of rectangles. Tight encoder makes the things more
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000717 // complicated as compared to the original VNC4.
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000718 writer()->setupCurrentEncoder();
Constantin Kaplinsky1a845d02007-08-31 21:06:53 +0000719 int nRects = (ui.copied.numRects() +
Constantin Kaplinsky1a845d02007-08-31 21:06:53 +0000720 (drawRenderedCursor ? 1 : 0));
Constantin Kaplinsky651606d2007-10-17 17:40:23 +0000721
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000722 std::vector<Rect> rects;
723 std::vector<Rect>::const_iterator i;
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000724 ui.changed.get_rects(&rects);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000725 for (i = rects.begin(); i != rects.end(); i++) {
726 if (i->width() && i->height())
Constantin Kaplinsky604d7812007-08-31 15:50:37 +0000727 nRects += writer()->getNumRects(*i);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000728 }
729
730 writer()->writeFramebufferUpdateStart(nRects);
731 Region updatedRegion;
Constantin Kaplinsky45517c82007-08-31 15:56:33 +0000732 writer()->writeRects(ui, &image_getter, &updatedRegion);
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000733 updates.subtract(updatedRegion);
734 if (drawRenderedCursor)
735 writeRenderedCursorRect();
736 writer()->writeFramebufferUpdateEnd();
Constantin Kaplinskya2adc8d2006-05-25 05:01:55 +0000737 requested.clear();
738 }
739}
740
741
742// writeRenderedCursorRect() writes a single rectangle drawing the rendered
743// cursor on the client.
744
745void VNCSConnectionST::writeRenderedCursorRect()
746{
747 image_getter.setPixelBuffer(&server->renderedCursor);
748 image_getter.setOffset(server->renderedCursorTL);
749
750 Rect actual;
751 writer()->writeRect(renderedCursorRect, &image_getter, &actual);
752
753 image_getter.setPixelBuffer(server->pb);
754 image_getter.setOffset(Point(0,0));
755
756 drawRenderedCursor = false;
757}
758
759void VNCSConnectionST::setColourMapEntries(int firstColour, int nColours)
760{
761 if (!readyForSetColourMapEntries) return;
762 if (server->pb->getPF().trueColour) return;
763
764 image_getter.setColourMapEntries(firstColour, nColours, writer());
765
766 if (cp.pf().trueColour) {
767 updates.add_changed(server->pb->getRect());
768 }
769}
770
771
772// setCursor() is called whenever the cursor has changed shape or pixel format.
773// If the client supports local cursor then it will arrange for the cursor to
774// be sent to the client.
775
776void VNCSConnectionST::setCursor()
777{
778 if (state() != RFBSTATE_NORMAL || !cp.supportsLocalCursor) return;
779 writer()->cursorChange(this);
780 if (writer()->needFakeUpdate())
781 writeFramebufferUpdate();
782}
783
784void VNCSConnectionST::setSocketTimeouts()
785{
786 int timeoutms = rfb::Server::clientWaitTimeMillis;
787 soonestTimeout(&timeoutms, secsToMillis(rfb::Server::idleTimeout));
788 if (timeoutms == 0)
789 timeoutms = -1;
790 sock->inStream().setTimeout(timeoutms);
791 sock->outStream().setTimeout(timeoutms);
792}
793
794char* VNCSConnectionST::getStartTime()
795{
796 char* result = ctime(&startTime);
797 result[24] = '\0';
798 return result;
799}
800
801void VNCSConnectionST::setStatus(int status)
802{
803 switch (status) {
804 case 0:
805 accessRights = accessRights | AccessPtrEvents | AccessKeyEvents | AccessView;
806 break;
807 case 1:
808 accessRights = accessRights & !(AccessPtrEvents | AccessKeyEvents) | AccessView;
809 break;
810 case 2:
811 accessRights = accessRights & !(AccessPtrEvents | AccessKeyEvents | AccessView);
812 break;
813 }
814 framebufferUpdateRequest(server->pb->getRect(), false);
815}
816int VNCSConnectionST::getStatus()
817{
818 if ((accessRights & (AccessPtrEvents | AccessKeyEvents | AccessView)) == 0x0007)
819 return 0;
820 if ((accessRights & (AccessPtrEvents | AccessKeyEvents | AccessView)) == 0x0001)
821 return 1;
822 if ((accessRights & (AccessPtrEvents | AccessKeyEvents | AccessView)) == 0x0000)
823 return 2;
824 return 4;
825}
826