1 /****************************************************************************
3 ** Copyright (C) 2007-2008 Urs Wolfer <uwolfer @ kde.org>
5 ** This file is part of KDE.
7 ** This program is free software; you can redistribute it and/or modify
8 ** it under the terms of the GNU General Public License as published by
9 ** the Free Software Foundation; either version 2 of the License, or
10 ** (at your option) any later version.
12 ** This program is distributed in the hope that it will be useful,
13 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ** GNU General Public License for more details.
17 ** You should have received a copy of the GNU General Public License
18 ** along with this program; see the file COPYING. If not, write to
19 ** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 ** Boston, MA 02110-1301, USA.
22 ****************************************************************************/
26 //for mouse button masks
27 #include "rfb/rfbproto.h"
32 // Definition of key modifier mask constants
33 #define KMOD_Alt_R 0x01
34 #define KMOD_Alt_L 0x02
35 #define KMOD_Meta_L 0x04
36 #define KMOD_Control_L 0x08
37 #define KMOD_Shift_L 0x10
39 //local cursor width/height in px, should be an odd number
40 const int CURSOR_SIZE = 7;
43 const int TAP_PRESS_TIME = 180;
44 const int DOUBLE_TAP_UP_TIME = 500;
47 VncView::VncView(QWidget *parent, const KUrl &url, RemoteView::Quality quality, int listen_port)
54 m_firstPasswordTry(true),
55 m_dontSendClipboard(false),
56 m_horizontalFactor(1.0),
57 m_verticalFactor(1.0),
58 m_forceLocalCursor(false),
60 listen_port(listen_port),
61 transformation_mode(Qt::FastTransformation)
67 //BlockingQueuedConnection can cause deadlocks when exiting, handled in startQuitting()
68 connect(&vncThread, SIGNAL(imageUpdated(int, int, int, int)), this, SLOT(updateImage(int, int, int, int)), Qt::BlockingQueuedConnection);
69 connect(&vncThread, SIGNAL(gotCut(const QString&)), this, SLOT(setCut(const QString&)), Qt::BlockingQueuedConnection);
70 connect(&vncThread, SIGNAL(passwordRequest()), this, SLOT(requestPassword()), Qt::BlockingQueuedConnection);
71 connect(&vncThread, SIGNAL(outputErrorMessage(QString)), this, SLOT(outputErrorMessage(QString)));
73 //don't miss early connection failures
74 connect(&vncThread, SIGNAL(finished()), this, SLOT(startQuitting()));
76 m_clipboard = QApplication::clipboard();
77 connect(m_clipboard, SIGNAL(selectionChanged()), this, SLOT(clipboardSelectionChanged()));
78 connect(m_clipboard, SIGNAL(dataChanged()), this, SLOT(clipboardDataChanged()));
87 // Disconnect all signals so that we don't get any more callbacks from the client thread
88 vncThread.disconnect();
93 bool VncView::eventFilter(QObject *obj, QEvent *event)
96 if (event->type() == QEvent::KeyPress ||
97 event->type() == QEvent::KeyRelease ||
98 event->type() == QEvent::MouseButtonDblClick ||
99 event->type() == QEvent::MouseButtonPress ||
100 event->type() == QEvent::MouseButtonRelease ||
101 event->type() == QEvent::Wheel ||
102 event->type() == QEvent::MouseMove) {
109 return RemoteView::eventFilter(obj, event);
112 QSize VncView::framebufferSize()
114 return m_frame.size();
117 QSize VncView::sizeHint() const
122 QSize VncView::minimumSizeHint() const
127 void VncView::startQuitting()
132 kDebug(5011) << "about to quit";
134 setStatus(Disconnecting);
140 const bool quitSuccess = vncThread.wait(700);
142 //happens when vncThread wants to call a slot via BlockingQueuedConnection,
143 //needs an event loop in this thread so execution continues after 'emit'
145 if(!loop.processEvents())
146 kDebug(5011) << "BUG: deadlocked, but no events to deliver?";
149 setStatus(Disconnected);
152 bool VncView::isQuitting()
157 bool VncView::start()
159 vncThread.setHost(m_host);
160 vncThread.setPort(m_port);
161 vncThread.setListenPort(listen_port); //if port is != 0, thread will listen for connections
162 vncThread.setQuality(quality);
164 // set local cursor on by default because low quality mostly means slow internet connection
165 if (quality == RemoteView::Low) {
166 showDotCursor(RemoteView::CursorOn);
169 setStatus(Connecting);
175 bool VncView::supportsScaling() const
180 bool VncView::supportsLocalCursor() const
185 void VncView::requestPassword()
187 kDebug(5011) << "request password";
189 setStatus(Authenticating);
191 if (!m_url.password().isNull()) {
192 vncThread.setPassword(m_url.password());
197 settings.beginGroup("hosts");
199 //check for saved password
200 QString password = settings.value(QString("%1/password").arg(m_host), "").toString();
201 if(m_firstPasswordTry and !password.isEmpty()) {
202 kDebug(5011) << "Trying saved password";
203 m_firstPasswordTry = false;
204 vncThread.setPassword(password);
207 m_firstPasswordTry = false;
210 QDialog dialog(this);
211 dialog.setWindowTitle(tr("Password required"));
213 QLineEdit passwordbox;
214 passwordbox.setEchoMode(QLineEdit::Password);
215 passwordbox.setText(password);
216 QCheckBox save_password(tr("Save Password"));
217 save_password.setChecked(!password.isEmpty()); //offer to overwrite saved password
218 QPushButton ok_button(tr("Done"));
219 ok_button.setMaximumWidth(100);
220 connect(&ok_button, SIGNAL(clicked()),
221 &dialog, SLOT(accept()));
225 layout2.addWidget(&passwordbox);
226 if(!m_host.isEmpty()) //don't save incoming connections
227 layout2.addWidget(&save_password);
228 layout1.addLayout(&layout2);
229 layout1.addWidget(&ok_button);
230 dialog.setLayout(&layout1);
232 if(dialog.exec()) { //dialog accepted
233 password = passwordbox.text();
235 if(!m_host.isEmpty() and save_password.isChecked()) {
236 kDebug(5011) << "Saving password for host '" << m_host << "'";
238 settings.setValue(QString("%1/password").arg(m_host), password);
242 vncThread.setPassword(password);
244 vncThread.setPassword(QString()); //null string to exit
248 void VncView::outputErrorMessage(const QString &message)
250 if (message == "INTERNAL:APPLE_VNC_COMPATIBILTY") {
251 setCursor(localDotCursor());
252 m_forceLocalCursor = true;
258 emit errorMessage(i18n("VNC failure"), message);
261 void VncView::updateImage(int x, int y, int w, int h)
263 if(!QApplication::focusWidget()) { //no focus, we're probably minimized
267 //kDebug(5011) << "got update" << width() << height();
274 if (m_horizontalFactor != 1.0 || m_verticalFactor != 1.0) {
275 // If the view is scaled, grow the update rectangle to avoid artifacts
276 int x_extrapixels = 1.0/m_horizontalFactor + 1;
277 int y_extrapixels = 1.0/m_verticalFactor + 1;
281 m_w+=2*x_extrapixels;
282 m_h+=2*y_extrapixels;
285 m_frame = vncThread.image();
287 if (!m_initDone) { //TODO this seems an odd place for initialization
288 setAttribute(Qt::WA_StaticContents);
289 setAttribute(Qt::WA_OpaquePaintEvent);
290 installEventFilter(this);
292 setCursor(((m_dotCursorState == CursorOn) || m_forceLocalCursor) ? localDotCursor() : Qt::BlankCursor);
294 setMouseTracking(true); // get mouse events even when there is no mousebutton pressed
295 setFocusPolicy(Qt::WheelFocus);
296 setStatus(Connected);
299 resize(width(), height());
305 static QSize old_frame_size = QSize();
306 if ((y == 0 && x == 0) && (m_frame.size() != old_frame_size)) {
307 old_frame_size = m_frame.size();
308 kDebug(5011) << "Updating framebuffer size";
310 useFastTransformations(false);
312 emit framebufferSizeChanged(m_frame.width(), m_frame.height());
315 repaint(qRound(m_x * m_horizontalFactor), qRound(m_y * m_verticalFactor), qRound(m_w * m_horizontalFactor), qRound(m_h * m_verticalFactor));
318 void VncView::setViewOnly(bool viewOnly)
320 RemoteView::setViewOnly(viewOnly);
322 m_dontSendClipboard = viewOnly;
325 showDotCursor(CursorOff);
326 setCursor(Qt::ArrowCursor);
328 setCursor(m_dotCursorState == CursorOn ? localDotCursor() : Qt::BlankCursor);
332 void VncView::showDotCursor(DotCursorState state)
334 RemoteView::showDotCursor(state);
336 setCursor(state == CursorOn ? localDotCursor() : Qt::BlankCursor);
339 //level should be in [0, 100]
340 void VncView::setZoomLevel(int level)
342 Q_ASSERT(parentWidget() != 0);
344 if(level == -1) { //handle resize
345 resize(m_frame.width()*m_horizontalFactor, m_frame.height()*m_verticalFactor);
349 double magnification;
352 } else if(level >= 90) {
355 const double min_horiz_magnification = double(parentWidget()->width())/m_frame.width();
356 const double min_vert_magnification = double(parentWidget()->height())/m_frame.height();
357 const double fit_screen_magnification = qMin(min_horiz_magnification, min_vert_magnification);
359 //level=90 => magnification=1.0, level=0 => magnification=fit_screen_magnification
360 magnification = (level)/90.0*(1.0 - fit_screen_magnification) + fit_screen_magnification;
363 if(magnification < 0 //remote display smaller than local?
364 or magnification != magnification) //nan
367 m_verticalFactor = m_horizontalFactor = magnification;
368 resize(m_frame.width()*magnification, m_frame.height()*magnification);
371 void VncView::setCut(const QString &text)
373 m_dontSendClipboard = true;
374 m_clipboard->setText(text, QClipboard::Clipboard);
375 m_clipboard->setText(text, QClipboard::Selection);
376 m_dontSendClipboard = false;
379 void VncView::paintEvent(QPaintEvent *event)
381 if (m_frame.isNull() || m_frame.format() == QImage::Format_Invalid) {
382 //no valid image to paint
383 RemoteView::paintEvent(event);
389 const QRect update_rect = event->rect();
390 QPainter painter(this);
391 if (update_rect != rect()) {
392 // kDebug(5011) << "Partial repaint";
393 const int sx = qRound(update_rect.x()/m_horizontalFactor);
394 const int sy = qRound(update_rect.y()/m_verticalFactor);
395 const int sw = qRound(update_rect.width()/m_horizontalFactor);
396 const int sh = qRound(update_rect.height()/m_verticalFactor);
398 painter.drawImage(update_rect,
399 m_frame.copy(sx, sy, sw, sh)
400 .scaled(update_rect.size(), Qt::IgnoreAspectRatio, transformation_mode));
402 //kDebug(5011) << "Full repaint" << width() << height() << m_frame.width() << m_frame.height();
404 painter.drawImage(rect(),
405 m_frame.scaled(size(), Qt::IgnoreAspectRatio, transformation_mode));
408 //draw local cursor ourselves, normal mouse pointer doesn't deal with scrolling
409 if((m_dotCursorState == CursorOn) || m_forceLocalCursor) {
410 #if QT_VERSION >= 0x040500
411 painter.setCompositionMode(QPainter::RasterOp_SourceXorDestination);
413 //rectangle size includes 1px pen width
414 painter.drawRect(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE-1, CURSOR_SIZE-1);
417 RemoteView::paintEvent(event);
420 void VncView::resizeEvent(QResizeEvent *event)
422 RemoteView::resizeEvent(event);
426 bool VncView::event(QEvent *event)
428 switch (event->type()) {
429 case QEvent::KeyPress:
430 case QEvent::KeyRelease:
431 keyEventHandler(static_cast<QKeyEvent*>(event));
434 case QEvent::MouseButtonDblClick:
435 case QEvent::MouseButtonPress:
436 case QEvent::MouseButtonRelease:
437 case QEvent::MouseMove:
438 mouseEventHandler(static_cast<QMouseEvent*>(event));
442 wheelEventHandler(static_cast<QWheelEvent*>(event));
445 case QEvent::WindowActivate: //input panel may have been closed, prevent IM from interfering with hardware keyboard
446 setAttribute(Qt::WA_InputMethodEnabled, false);
449 return RemoteView::event(event);
453 //call with e == 0 to flush held events
454 void VncView::mouseEventHandler(QMouseEvent *e)
456 static bool tap_detected = false;
457 static bool double_tap_detected = false;
458 static bool tap_drag_detected = false;
459 static QTime press_time;
460 static QTime up_time; //used for double clicks/tap&drag, for time after first tap
463 if(!e) { //flush held taps
465 m_buttonMask |= rfbButton1Mask;
466 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
467 m_buttonMask &= ~rfbButton1Mask;
468 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
469 tap_detected = false;
470 } else if(double_tap_detected and press_time.elapsed() > TAP_PRESS_TIME) { //got tap + another press -> tap & drag
471 m_buttonMask |= rfbButton1Mask;
472 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
473 double_tap_detected = false;
474 tap_drag_detected = true;
480 if(e->x() < 0 or e->y() < 0) { //QScrollArea tends to send invalid events sometimes...
485 cursor_x = qRound(e->x()/m_horizontalFactor);
486 cursor_y = qRound(e->y()/m_verticalFactor);
487 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask); // plain move event
489 if(!disable_tapping and e->button() == Qt::LeftButton) { //implement touchpad-like input for left button
490 if(e->type() == QEvent::MouseButtonPress or e->type() == QEvent::MouseButtonDblClick) {
492 if(tap_detected and up_time.elapsed() < DOUBLE_TAP_UP_TIME) {
493 tap_detected = false;
494 double_tap_detected = true;
496 QTimer::singleShot(TAP_PRESS_TIME, this, SLOT(mouseEventHandler()));
498 } else if(e->type() == QEvent::MouseButtonRelease) {
499 if(tap_drag_detected) { //end tap & drag
500 m_buttonMask &= ~rfbButton1Mask;
501 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
502 tap_drag_detected = false;
503 } else if(double_tap_detected) { //double click
504 double_tap_detected = false;
506 m_buttonMask |= rfbButton1Mask;
507 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
508 m_buttonMask &= ~rfbButton1Mask;
509 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
510 m_buttonMask |= rfbButton1Mask;
511 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
512 m_buttonMask &= ~rfbButton1Mask;
513 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
514 } else if(press_time.elapsed() < TAP_PRESS_TIME) { //tap
517 QTimer::singleShot(DOUBLE_TAP_UP_TIME, this, SLOT(mouseEventHandler()));
521 } else { //middle or right button, send directly
522 if ((e->type() == QEvent::MouseButtonPress)) {
523 if (e->button() & Qt::MidButton)
524 m_buttonMask |= rfbButton2Mask;
525 if (e->button() & Qt::RightButton)
526 m_buttonMask |= rfbButton3Mask;
527 } else if (e->type() == QEvent::MouseButtonRelease) {
528 if (e->button() & Qt::MidButton)
529 m_buttonMask &= ~rfbButton2Mask;
530 if (e->button() & Qt::RightButton)
531 m_buttonMask &= ~rfbButton3Mask;
533 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
536 //prevent local cursor artifacts
537 static int old_cursor_x = cursor_x;
538 static int old_cursor_y = cursor_y;
539 if(((m_dotCursorState == CursorOn) || m_forceLocalCursor)
540 and (cursor_x != old_cursor_x or cursor_y != old_cursor_y)) {
541 //clear last position
542 repaint(old_cursor_x*m_horizontalFactor - CURSOR_SIZE/2, old_cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
543 //and refresh new one
544 repaint(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
546 old_cursor_x = cursor_x; old_cursor_y = cursor_y;
550 void VncView::wheelEventHandler(QWheelEvent *event)
553 if (event->delta() < 0)
554 eb |= rfbWheelDownMask;
556 eb |= rfbWheelUpMask;
558 const int x = qRound(event->x() / m_horizontalFactor);
559 const int y = qRound(event->y() / m_verticalFactor);
561 vncThread.mouseEvent(x, y, m_buttonMask | eb);
562 vncThread.mouseEvent(x, y, m_buttonMask);
565 void VncView::keyEventHandler(QKeyEvent *e)
567 // strip away autorepeating KeyRelease; see bug #206598
568 if (e->isAutoRepeat() && (e->type() == QEvent::KeyRelease)) {
572 // parts of this code are based on http://italc.sourcearchive.com/documentation/1.0.9.1/vncview_8cpp-source.html
573 rfbKeySym k = e->nativeVirtualKey();
575 // we do not handle Key_Backtab separately as the Shift-modifier
576 // is already enabled
577 if (e->key() == Qt::Key_Backtab) {
581 const bool pressed = (e->type() == QEvent::KeyPress);
584 //don't send ISO_Level3_Shift (would break things like Win+0-9)
585 //also enable IM so symbol key works
587 setAttribute(Qt::WA_InputMethodEnabled, pressed);
594 if (k == XK_Shift_L || k == XK_Control_L || k == XK_Meta_L || k == XK_Alt_L) {
597 } else if (m_mods.contains(k)) {
605 int current_zoom = -1;
606 if(e->key() == Qt::Key_F8)
607 current_zoom = left_zoom;
608 else if(e->key() == Qt::Key_F7)
609 current_zoom = right_zoom;
611 // kDebug(5011) << "got '" << e->text() << "'.";
612 vncThread.keyEvent(k, pressed);
614 kDebug(5011) << "nativeVirtualKey() for '" << e->text() << "' failed.";
618 if(current_zoom == -1)
621 //handle zoom buttons
622 if(current_zoom == 0) { //left click
624 m_buttonMask |= rfbButton1Mask;
626 m_buttonMask &= ~rfbButton1Mask;
627 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
628 } else if(current_zoom == 1) { //right click
630 m_buttonMask |= rfbButton3Mask;
632 m_buttonMask &= ~rfbButton3Mask;
633 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
634 } else if(current_zoom == 2) { //middle click
636 m_buttonMask |= rfbButton2Mask;
638 m_buttonMask &= ~rfbButton2Mask;
639 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
640 } else if(current_zoom == 3 and pressed) { //wheel up
641 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask | rfbWheelUpMask);
642 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
643 } else if(current_zoom == 4 and pressed) { //wheel down
644 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask | rfbWheelDownMask);
645 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
646 } else if(current_zoom == 5) { //page up
647 vncThread.keyEvent(0xff55, pressed);
648 } else if(current_zoom == 6) { //page down
649 vncThread.keyEvent(0xff56, pressed);
653 void VncView::unpressModifiers()
655 const QList<unsigned int> keys = m_mods.keys();
656 QList<unsigned int>::const_iterator it = keys.constBegin();
657 while (it != keys.end()) {
658 vncThread.keyEvent(*it, false);
664 void VncView::clipboardSelectionChanged()
666 if (m_status != Connected)
669 if (m_clipboard->ownsSelection() || m_dontSendClipboard)
672 const QString text = m_clipboard->text(QClipboard::Selection);
674 vncThread.clientCut(text);
677 void VncView::clipboardDataChanged()
679 if (m_status != Connected)
682 if (m_clipboard->ownsClipboard() || m_dontSendClipboard)
685 const QString text = m_clipboard->text(QClipboard::Clipboard);
687 vncThread.clientCut(text);
691 void VncView::sendKey(Qt::Key key)
693 //convert Qt::Key into x11 keysym
705 case Qt::Key_PageDown:
723 case Qt::Key_Backspace:
738 k = 0xffbe + int(key - Qt::Key_F1);
750 case Qt::MetaModifier:
754 case Qt::AltModifier:
757 case Qt::Key_Control:
758 case Qt::ControlModifier:
762 kDebug(5011) << "sendKey(): Unhandled Qt::Key value " << key;
766 if (k == XK_Shift_L || k == XK_Control_L || k == XK_Meta_L || k == XK_Alt_L || k == XK_Super_L) {
767 if (m_mods.contains(k)) { //release
769 vncThread.keyEvent(k, false);
772 vncThread.keyEvent(k, true);
774 } else { //normal key
775 vncThread.keyEvent(k, true);
776 vncThread.keyEvent(k, false);
780 void VncView::sendKeySequence(QKeySequence keys)
782 Q_ASSERT(keys.count() <= 1); //we can only handle a single combination
784 //to get at individual key presses, we split 'keys' into its components
788 QString k = keys.toString().section('+', pos, pos);
792 //kDebug(5011) << "found key: " << k;
794 key_list.append(Qt::Key_Alt);
795 } else if(k == "Ctrl") {
796 key_list.append(Qt::Key_Control);
797 } else if(k == "Meta") {
798 key_list.append(Qt::Key_Meta);
800 key_list.append(QKeySequence(k)[0]);
806 for(int i = 0; i < key_list.count(); i++)
807 sendKey(Qt::Key(key_list.at(i)));
809 //release modifiers (everything before final key)
810 for(int i = key_list.count()-2; i >= 0; i--)
811 sendKey(Qt::Key(key_list.at(i)));
814 void VncView::reloadSettings()
817 left_zoom = settings.value("left_zoom", 0).toInt();
818 right_zoom = settings.value("right_zoom", 1).toInt();
819 disable_tapping = settings.value("disable_tapping", false).toBool();
821 bool always_show_local_cursor = settings.value("always_show_local_cursor", false).toBool();
822 if(always_show_local_cursor)
823 showDotCursor(CursorOn);
828 //convert commitString into keyevents
829 void VncView::inputMethodEvent(QInputMethodEvent *event)
831 //TODO handle replacements
832 //NOTE for the return key to work Qt needs to enable multiline input, which only works for Q(Plain)TextEdit
834 //kDebug(5011) << event->commitString() << "|" << event->preeditString() << "|" << event->replacementLength() << "|" << event->replacementStart();
835 QString letters = event->commitString();
836 for(int i = 0; i < letters.length(); i++) {
837 char k = letters.at(i).toLatin1();
839 kDebug(5011) << "unhandled key";
842 vncThread.keyEvent(k, true);
843 vncThread.keyEvent(k, false);
847 void VncView::useFastTransformations(bool enabled)
849 if(enabled or zoomFactor() >= 1.0) {
850 transformation_mode = Qt::FastTransformation;
852 transformation_mode = Qt::SmoothTransformation;