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),
68 //BlockingQueuedConnection can cause deadlocks when exiting, handled in startQuitting()
69 connect(&vncThread, SIGNAL(imageUpdated(int, int, int, int)), this, SLOT(updateImage(int, int, int, int)), Qt::BlockingQueuedConnection);
70 connect(&vncThread, SIGNAL(gotCut(const QString&)), this, SLOT(setCut(const QString&)), Qt::BlockingQueuedConnection);
71 connect(&vncThread, SIGNAL(passwordRequest()), this, SLOT(requestPassword()), Qt::BlockingQueuedConnection);
72 connect(&vncThread, SIGNAL(outputErrorMessage(QString)), this, SLOT(outputErrorMessage(QString)));
74 //don't miss early connection failures
75 connect(&vncThread, SIGNAL(finished()), this, SLOT(startQuitting()));
77 m_clipboard = QApplication::clipboard();
78 connect(m_clipboard, SIGNAL(selectionChanged()), this, SLOT(clipboardSelectionChanged()));
79 connect(m_clipboard, SIGNAL(dataChanged()), this, SLOT(clipboardDataChanged()));
88 // Disconnect all signals so that we don't get any more callbacks from the client thread
89 vncThread.disconnect();
94 bool VncView::eventFilter(QObject *obj, QEvent *event)
97 if (event->type() == QEvent::KeyPress ||
98 event->type() == QEvent::KeyRelease ||
99 event->type() == QEvent::MouseButtonDblClick ||
100 event->type() == QEvent::MouseButtonPress ||
101 event->type() == QEvent::MouseButtonRelease ||
102 event->type() == QEvent::Wheel ||
103 event->type() == QEvent::MouseMove) {
110 return RemoteView::eventFilter(obj, event);
113 QSize VncView::framebufferSize() const
115 return m_frame.size();
118 QSize VncView::sizeHint() const
123 QSize VncView::minimumSizeHint() const
128 void VncView::startQuitting()
133 kDebug(5011) << "about to quit";
135 setStatus(Disconnecting);
141 const bool quitSuccess = vncThread.wait(700);
143 //happens when vncThread wants to call a slot via BlockingQueuedConnection,
144 //needs an event loop in this thread so execution continues after 'emit'
146 if(!loop.processEvents())
147 kDebug(5011) << "BUG: deadlocked, but no events to deliver?";
150 setStatus(Disconnected);
153 bool VncView::isQuitting() const
158 bool VncView::start()
160 vncThread.setHost(m_host);
161 vncThread.setPort(m_port);
162 vncThread.setListenPort(listen_port); //if port is != 0, thread will listen for connections
163 vncThread.setQuality(quality);
165 // set local cursor on by default because low quality mostly means slow internet connection
166 if (quality == RemoteView::Low) {
167 showDotCursor(RemoteView::CursorOn);
170 setStatus(Connecting);
176 bool VncView::supportsScaling() const
181 bool VncView::supportsLocalCursor() const
186 void VncView::requestPassword()
188 kDebug(5011) << "request password";
190 setStatus(Authenticating);
192 if (!m_url.password().isNull()) {
193 vncThread.setPassword(m_url.password());
198 settings.beginGroup("hosts");
200 //check for saved password
201 QString password = settings.value(QString("%1/password").arg(m_host), "").toString();
202 if(m_firstPasswordTry and !password.isEmpty()) {
203 kDebug(5011) << "Trying saved password";
204 m_firstPasswordTry = false;
205 vncThread.setPassword(password);
208 m_firstPasswordTry = false;
211 QDialog dialog(this);
212 dialog.setWindowTitle(tr("Password required"));
214 QLineEdit passwordbox;
215 passwordbox.setEchoMode(QLineEdit::Password);
216 passwordbox.setText(password);
217 QCheckBox save_password(tr("Save Password"));
218 save_password.setChecked(!password.isEmpty()); //offer to overwrite saved password
219 QPushButton ok_button(tr("Done"));
220 ok_button.setMaximumWidth(100);
221 connect(&ok_button, SIGNAL(clicked()),
222 &dialog, SLOT(accept()));
226 layout2.addWidget(&passwordbox);
227 if(!m_host.isEmpty()) //don't save incoming connections
228 layout2.addWidget(&save_password);
229 layout1.addLayout(&layout2);
230 layout1.addWidget(&ok_button);
231 dialog.setLayout(&layout1);
233 if(dialog.exec()) { //dialog accepted
234 password = passwordbox.text();
236 if(!m_host.isEmpty() and save_password.isChecked()) {
237 kDebug(5011) << "Saving password for host '" << m_host << "'";
239 settings.setValue(QString("%1/password").arg(m_host), password);
243 vncThread.setPassword(password);
245 vncThread.setPassword(QString()); //null string to exit
249 void VncView::outputErrorMessage(const QString &message)
251 if (message == "INTERNAL:APPLE_VNC_COMPATIBILTY") {
252 setCursor(localDotCursor());
253 m_forceLocalCursor = true;
257 emit errorMessage(i18n("VNC failure"), message);
262 void VncView::updateImage(int x, int y, int w, int h)
265 //don't update if window is out of focus / display is off
266 if(!QApplication::focusWidget() || display_off) {
271 //kDebug(5011) << "got update" << width() << height();
278 if (m_horizontalFactor != 1.0 || m_verticalFactor != 1.0) {
279 // If the view is scaled, grow the update rectangle to avoid artifacts
280 int x_extrapixels = 1.0/m_horizontalFactor + 1;
281 int y_extrapixels = 1.0/m_verticalFactor + 1;
285 m_w+=2*x_extrapixels;
286 m_h+=2*y_extrapixels;
289 m_frame = vncThread.image();
291 if (!m_initDone) { //TODO this seems an odd place for initialization
292 setAttribute(Qt::WA_NoSystemBackground);
293 installEventFilter(this);
295 setCursor(((m_dotCursorState == CursorOn) || m_forceLocalCursor) ? localDotCursor() : Qt::BlankCursor);
297 setMouseTracking(true); // get mouse events even when there is no mousebutton pressed
298 setFocusPolicy(Qt::WheelFocus);
299 setStatus(Connected);
302 resize(width(), height());
307 static QSize old_frame_size = QSize();
308 if ((y == 0 && x == 0) && (m_frame.size() != old_frame_size)) {
309 old_frame_size = m_frame.size();
310 kDebug(5011) << "Updating framebuffer size";
312 useFastTransformations(false);
314 emit framebufferSizeChanged(m_frame.width(), m_frame.height());
317 update(qRound(m_x * m_horizontalFactor), qRound(m_y * m_verticalFactor), qRound(m_w * m_horizontalFactor), qRound(m_h * m_verticalFactor));
320 void VncView::setViewOnly(bool viewOnly)
322 RemoteView::setViewOnly(viewOnly);
324 m_dontSendClipboard = viewOnly;
327 showDotCursor(CursorOff);
328 setCursor(Qt::ArrowCursor);
330 setCursor(m_dotCursorState == CursorOn ? localDotCursor() : Qt::BlankCursor);
334 void VncView::showDotCursor(DotCursorState state)
336 RemoteView::showDotCursor(state);
338 setCursor(state == CursorOn ? localDotCursor() : Qt::BlankCursor);
341 //level should be in [0, 100]
342 void VncView::setZoomLevel(int level)
344 Q_ASSERT(parentWidget() != 0);
346 if(level == -1) { //handle resize
347 resize(m_frame.width()*m_horizontalFactor, m_frame.height()*m_verticalFactor);
351 double magnification;
354 } else if(level >= 90) {
357 const double min_horiz_magnification = double(parentWidget()->width())/m_frame.width();
358 const double min_vert_magnification = double(parentWidget()->height())/m_frame.height();
359 const double fit_screen_magnification = qMin(min_horiz_magnification, min_vert_magnification);
361 //level=90 => magnification=1.0, level=0 => magnification=fit_screen_magnification
362 magnification = (level)/90.0*(1.0 - fit_screen_magnification) + fit_screen_magnification;
365 //remote display smaller than local (or NAN)?
366 if(magnification < 0 or magnification != magnification)
369 m_verticalFactor = m_horizontalFactor = magnification;
370 resize(m_frame.width()*magnification, m_frame.height()*magnification);
373 void VncView::setCut(const QString &text)
375 m_dontSendClipboard = true;
376 m_clipboard->setText(text, QClipboard::Clipboard);
377 m_clipboard->setText(text, QClipboard::Selection);
378 m_dontSendClipboard = false;
381 void VncView::paintEvent(QPaintEvent *event)
383 if (m_frame.isNull() || m_frame.format() == QImage::Format_Invalid) {
384 //no valid image to paint
385 RemoteView::paintEvent(event);
391 //split update region into smaller non-intersecting rectangles and only paint those
392 QPainter painter(this);
393 foreach(QRect update_rect, event->region().rects()) {
394 if(m_horizontalFactor == 2.0 and m_verticalFactor == 2.0) {
395 //grow client side updates to multiples of 2 to avoid artifacts
400 update_rect.adjust(0, 0,
401 (update_rect.x()+update_rect.width())%2,
402 (update_rect.y()+update_rect.height())%2);
404 const int sx = qRound(update_rect.x()/m_horizontalFactor);
405 const int sy = qRound(update_rect.y()/m_verticalFactor);
406 const int sw = qRound(update_rect.width()/m_horizontalFactor);
407 const int sh = qRound(update_rect.height()/m_verticalFactor);
409 //kDebug(5011) << "Partial repaint, widget x,y,w,h:" << update_rect.x() << update_rect.y() << update_rect.width() << update_rect.height() << "orig: " << sx << sy << sw << sh;
411 painter.drawImage(update_rect,
412 m_frame.copy(sx, sy, sw, sh)
413 .scaled(update_rect.size(), Qt::IgnoreAspectRatio, transformation_mode));
416 //draw local cursor ourselves, normal mouse pointer doesn't deal with scrolling
417 if((m_dotCursorState == CursorOn) || m_forceLocalCursor) {
418 #if QT_VERSION >= 0x040500
419 painter.setCompositionMode(QPainter::RasterOp_SourceXorDestination);
421 //rectangle size includes 1px pen width
422 painter.drawRect(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE-1, CURSOR_SIZE-1);
425 RemoteView::paintEvent(event);
428 void VncView::resizeEvent(QResizeEvent *event)
430 RemoteView::resizeEvent(event);
434 bool VncView::event(QEvent *event)
436 switch (event->type()) {
437 case QEvent::KeyPress:
438 case QEvent::KeyRelease:
439 keyEventHandler(static_cast<QKeyEvent*>(event));
442 case QEvent::MouseButtonDblClick:
443 case QEvent::MouseButtonPress:
444 case QEvent::MouseButtonRelease:
445 case QEvent::MouseMove:
446 mouseEventHandler(static_cast<QMouseEvent*>(event));
450 wheelEventHandler(static_cast<QWheelEvent*>(event));
453 case QEvent::WindowActivate: //input panel may have been closed, prevent IM from interfering with hardware keyboard
454 setAttribute(Qt::WA_InputMethodEnabled, false);
457 return RemoteView::event(event);
461 //call with e == 0 to flush held events
462 void VncView::mouseEventHandler(QMouseEvent *e)
464 static bool tap_detected = false;
465 static bool double_tap_detected = false;
466 static bool tap_drag_detected = false;
467 static QTime press_time;
468 static QTime up_time; //used for double clicks/tap&drag, for time after first tap
471 if(!e) { //flush held taps
473 m_buttonMask |= rfbButton1Mask;
474 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
475 m_buttonMask &= ~rfbButton1Mask;
476 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
477 tap_detected = false;
478 } else if(double_tap_detected and press_time.elapsed() > TAP_PRESS_TIME) { //got tap + another press -> tap & drag
479 m_buttonMask |= rfbButton1Mask;
480 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
481 double_tap_detected = false;
482 tap_drag_detected = true;
488 if(e->x() < 0 or e->y() < 0) { //QScrollArea tends to send invalid events sometimes...
493 cursor_x = qRound(e->x()/m_horizontalFactor);
494 cursor_y = qRound(e->y()/m_verticalFactor);
495 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask); // plain move event
497 if(!disable_tapping and e->button() == Qt::LeftButton) { //implement touchpad-like input for left button
498 if(e->type() == QEvent::MouseButtonPress or e->type() == QEvent::MouseButtonDblClick) {
500 if(tap_detected and up_time.elapsed() < DOUBLE_TAP_UP_TIME) {
501 tap_detected = false;
502 double_tap_detected = true;
504 QTimer::singleShot(TAP_PRESS_TIME, this, SLOT(mouseEventHandler()));
506 } else if(e->type() == QEvent::MouseButtonRelease) {
507 if(tap_drag_detected) { //end tap & drag
508 m_buttonMask &= ~rfbButton1Mask;
509 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
510 tap_drag_detected = false;
511 } else if(double_tap_detected) { //double click
512 double_tap_detected = false;
514 m_buttonMask |= rfbButton1Mask;
515 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
516 m_buttonMask &= ~rfbButton1Mask;
517 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
518 m_buttonMask |= rfbButton1Mask;
519 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
520 m_buttonMask &= ~rfbButton1Mask;
521 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
522 } else if(press_time.elapsed() < TAP_PRESS_TIME) { //tap
525 QTimer::singleShot(DOUBLE_TAP_UP_TIME, this, SLOT(mouseEventHandler()));
529 } else { //middle or right button, send directly
530 if ((e->type() == QEvent::MouseButtonPress)) {
531 if (e->button() & Qt::MidButton)
532 m_buttonMask |= rfbButton2Mask;
533 if (e->button() & Qt::RightButton)
534 m_buttonMask |= rfbButton3Mask;
535 } else if (e->type() == QEvent::MouseButtonRelease) {
536 if (e->button() & Qt::MidButton)
537 m_buttonMask &= ~rfbButton2Mask;
538 if (e->button() & Qt::RightButton)
539 m_buttonMask &= ~rfbButton3Mask;
541 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
544 //prevent local cursor artifacts
545 static int old_cursor_x = cursor_x;
546 static int old_cursor_y = cursor_y;
547 if(((m_dotCursorState == CursorOn) || m_forceLocalCursor)
548 and (cursor_x != old_cursor_x or cursor_y != old_cursor_y)) {
549 //clear last position
550 update(old_cursor_x*m_horizontalFactor - CURSOR_SIZE/2, old_cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
551 //and refresh new one
552 update(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
554 old_cursor_x = cursor_x;
555 old_cursor_y = cursor_y;
559 void VncView::wheelEventHandler(QWheelEvent *event)
562 if (event->delta() < 0)
563 eb |= rfbWheelDownMask;
565 eb |= rfbWheelUpMask;
567 const int x = qRound(event->x() / m_horizontalFactor);
568 const int y = qRound(event->y() / m_verticalFactor);
570 vncThread.mouseEvent(x, y, m_buttonMask | eb);
571 vncThread.mouseEvent(x, y, m_buttonMask);
574 void VncView::keyEventHandler(QKeyEvent *e)
576 // strip away autorepeating KeyRelease; see bug #206598
577 if (e->isAutoRepeat() && (e->type() == QEvent::KeyRelease)) {
581 // parts of this code are based on http://italc.sourcearchive.com/documentation/1.0.9.1/vncview_8cpp-source.html
582 rfbKeySym k = e->nativeVirtualKey();
585 // we do not handle Key_Backtab separately as the Shift-modifier
586 // is already enabled
587 if (e->key() == Qt::Key_Backtab) {
591 const bool pressed = (e->type() == QEvent::KeyPress);
594 //don't send ISO_Level3_Shift (would break things like Win+0-9)
595 //also enable IM so symbol key works
597 setAttribute(Qt::WA_InputMethodEnabled, pressed);
604 if (k == XK_Shift_L || k == XK_Control_L || k == XK_Meta_L || k == XK_Alt_L) {
607 } else if (m_mods.contains(k)) {
615 int current_zoom = -1;
616 if(e->key() == Qt::Key_F8)
617 current_zoom = left_zoom;
618 else if(e->key() == Qt::Key_F7)
619 current_zoom = right_zoom;
621 //kDebug(5011) << "got '" << e->text() << "', nativeVirtualKey: " << k;
622 vncThread.keyEvent(k, pressed);
624 kDebug(5011) << "nativeVirtualKey() for '" << e->text() << "' failed.";
628 if(current_zoom == -1)
631 //handle zoom buttons
632 if(current_zoom == 0) { //left click
634 m_buttonMask |= rfbButton1Mask;
636 m_buttonMask &= ~rfbButton1Mask;
637 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
638 } else if(current_zoom == 1) { //right click
640 m_buttonMask |= rfbButton3Mask;
642 m_buttonMask &= ~rfbButton3Mask;
643 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
644 } else if(current_zoom == 2) { //middle click
646 m_buttonMask |= rfbButton2Mask;
648 m_buttonMask &= ~rfbButton2Mask;
649 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
650 } else if(current_zoom == 3 and pressed) { //wheel up
651 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask | rfbWheelUpMask);
652 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
653 } else if(current_zoom == 4 and pressed) { //wheel down
654 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask | rfbWheelDownMask);
655 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
656 } else if(current_zoom == 5) { //page up
657 vncThread.keyEvent(0xff55, pressed);
658 } else if(current_zoom == 6) { //page down
659 vncThread.keyEvent(0xff56, pressed);
663 void VncView::unpressModifiers()
665 const QList<unsigned int> keys = m_mods.keys();
666 QList<unsigned int>::const_iterator it = keys.constBegin();
667 while (it != keys.end()) {
668 vncThread.keyEvent(*it, false);
674 void VncView::clipboardSelectionChanged()
676 if (m_status != Connected)
679 if (m_clipboard->ownsSelection() || m_dontSendClipboard)
682 const QString text = m_clipboard->text(QClipboard::Selection);
684 vncThread.clientCut(text);
687 void VncView::clipboardDataChanged()
689 if (m_status != Connected)
692 if (m_clipboard->ownsClipboard() || m_dontSendClipboard)
695 const QString text = m_clipboard->text(QClipboard::Clipboard);
697 vncThread.clientCut(text);
701 void VncView::sendKey(Qt::Key key)
703 //convert Qt::Key into x11 keysym
715 case Qt::Key_PageDown:
733 case Qt::Key_Backspace:
748 k = 0xffbe + int(key - Qt::Key_F1);
760 case Qt::MetaModifier:
764 case Qt::AltModifier:
767 case Qt::Key_Control:
768 case Qt::ControlModifier:
772 kDebug(5011) << "sendKey(): Unhandled Qt::Key value " << key;
776 if (k == XK_Shift_L || k == XK_Control_L || k == XK_Meta_L || k == XK_Alt_L || k == XK_Super_L) {
777 if (m_mods.contains(k)) { //release
779 vncThread.keyEvent(k, false);
782 vncThread.keyEvent(k, true);
784 } else { //normal key
785 vncThread.keyEvent(k, true);
786 vncThread.keyEvent(k, false);
790 void VncView::sendKeySequence(QKeySequence keys)
792 Q_ASSERT(keys.count() <= 1); //we can only handle a single combination
794 //to get at individual key presses, we split 'keys' into its components
798 QString k = keys.toString().section('+', pos, pos);
802 //kDebug(5011) << "found key: " << k;
804 key_list.append(Qt::Key_Alt);
805 } else if(k == "Ctrl") {
806 key_list.append(Qt::Key_Control);
807 } else if(k == "Meta") {
808 key_list.append(Qt::Key_Meta);
810 key_list.append(QKeySequence(k)[0]);
816 for(int i = 0; i < key_list.count(); i++)
817 sendKey(Qt::Key(key_list.at(i)));
819 //release modifiers (everything before final key)
820 for(int i = key_list.count()-2; i >= 0; i--)
821 sendKey(Qt::Key(key_list.at(i)));
824 void VncView::reloadSettings()
827 left_zoom = settings.value("left_zoom", 0).toInt();
828 right_zoom = settings.value("right_zoom", 1).toInt();
829 disable_tapping = settings.value("disable_tapping", false).toBool();
831 bool always_show_local_cursor = settings.value("always_show_local_cursor", false).toBool();
832 showDotCursor(always_show_local_cursor?CursorOn:CursorOff);
837 //convert commitString into keyevents
838 void VncView::inputMethodEvent(QInputMethodEvent *event)
840 //TODO handle replacements
841 //NOTE for the return key to work Qt needs to enable multiline input, which only works for Q(Plain)TextEdit
843 //kDebug(5011) << event->commitString() << "|" << event->preeditString() << "|" << event->replacementLength() << "|" << event->replacementStart();
844 QString letters = event->commitString();
845 for(int i = 0; i < letters.length(); i++) {
846 char k = letters.at(i).toLatin1();
848 kDebug(5011) << "unhandled key";
851 vncThread.keyEvent(k, true);
852 vncThread.keyEvent(k, false);
856 void VncView::useFastTransformations(bool enabled)
858 if(enabled or zoomFactor() >= 1.0) {
859 transformation_mode = Qt::FastTransformation;
861 transformation_mode = Qt::SmoothTransformation;