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()
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()
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;
259 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_StaticContents);
293 setAttribute(Qt::WA_OpaquePaintEvent);
294 installEventFilter(this);
296 setCursor(((m_dotCursorState == CursorOn) || m_forceLocalCursor) ? localDotCursor() : Qt::BlankCursor);
298 setMouseTracking(true); // get mouse events even when there is no mousebutton pressed
299 setFocusPolicy(Qt::WheelFocus);
300 setStatus(Connected);
303 resize(width(), height());
308 static QSize old_frame_size = QSize();
309 if ((y == 0 && x == 0) && (m_frame.size() != old_frame_size)) {
310 old_frame_size = m_frame.size();
311 kDebug(5011) << "Updating framebuffer size";
313 useFastTransformations(false);
315 emit framebufferSizeChanged(m_frame.width(), m_frame.height());
318 repaint(qRound(m_x * m_horizontalFactor), qRound(m_y * m_verticalFactor), qRound(m_w * m_horizontalFactor), qRound(m_h * m_verticalFactor));
321 void VncView::setViewOnly(bool viewOnly)
323 RemoteView::setViewOnly(viewOnly);
325 m_dontSendClipboard = viewOnly;
328 showDotCursor(CursorOff);
329 setCursor(Qt::ArrowCursor);
331 setCursor(m_dotCursorState == CursorOn ? localDotCursor() : Qt::BlankCursor);
335 void VncView::showDotCursor(DotCursorState state)
337 RemoteView::showDotCursor(state);
339 setCursor(state == CursorOn ? localDotCursor() : Qt::BlankCursor);
342 //level should be in [0, 100]
343 void VncView::setZoomLevel(int level)
345 Q_ASSERT(parentWidget() != 0);
347 if(level == -1) { //handle resize
348 resize(m_frame.width()*m_horizontalFactor, m_frame.height()*m_verticalFactor);
352 double magnification;
355 } else if(level >= 90) {
358 const double min_horiz_magnification = double(parentWidget()->width())/m_frame.width();
359 const double min_vert_magnification = double(parentWidget()->height())/m_frame.height();
360 const double fit_screen_magnification = qMin(min_horiz_magnification, min_vert_magnification);
362 //level=90 => magnification=1.0, level=0 => magnification=fit_screen_magnification
363 magnification = (level)/90.0*(1.0 - fit_screen_magnification) + fit_screen_magnification;
366 if(magnification < 0 //remote display smaller than local?
367 or magnification != magnification) //nan
370 m_verticalFactor = m_horizontalFactor = magnification;
371 resize(m_frame.width()*magnification, m_frame.height()*magnification);
374 void VncView::setCut(const QString &text)
376 m_dontSendClipboard = true;
377 m_clipboard->setText(text, QClipboard::Clipboard);
378 m_clipboard->setText(text, QClipboard::Selection);
379 m_dontSendClipboard = false;
382 void VncView::paintEvent(QPaintEvent *event)
384 if (m_frame.isNull() || m_frame.format() == QImage::Format_Invalid) {
385 //no valid image to paint
386 RemoteView::paintEvent(event);
392 //split update region into smaller non-intersecting rectangles and only paint those
393 QPainter painter(this);
394 foreach(const QRect& update_rect, event->region().rects()) {
395 const int sx = qRound(update_rect.x()/m_horizontalFactor);
396 const int sy = qRound(update_rect.y()/m_verticalFactor);
397 const int sw = qRound(update_rect.width()/m_horizontalFactor);
398 const int sh = qRound(update_rect.height()/m_verticalFactor);
400 //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;
402 painter.drawImage(update_rect,
403 m_frame.copy(sx, sy, sw, sh)
404 .scaled(update_rect.size(), Qt::IgnoreAspectRatio, transformation_mode));
407 //draw local cursor ourselves, normal mouse pointer doesn't deal with scrolling
408 if((m_dotCursorState == CursorOn) || m_forceLocalCursor) {
409 #if QT_VERSION >= 0x040500
410 painter.setCompositionMode(QPainter::RasterOp_SourceXorDestination);
412 //rectangle size includes 1px pen width
413 painter.drawRect(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE-1, CURSOR_SIZE-1);
416 RemoteView::paintEvent(event);
419 void VncView::resizeEvent(QResizeEvent *event)
421 RemoteView::resizeEvent(event);
425 bool VncView::event(QEvent *event)
427 switch (event->type()) {
428 case QEvent::KeyPress:
429 case QEvent::KeyRelease:
430 keyEventHandler(static_cast<QKeyEvent*>(event));
433 case QEvent::MouseButtonDblClick:
434 case QEvent::MouseButtonPress:
435 case QEvent::MouseButtonRelease:
436 case QEvent::MouseMove:
437 mouseEventHandler(static_cast<QMouseEvent*>(event));
441 wheelEventHandler(static_cast<QWheelEvent*>(event));
444 case QEvent::WindowActivate: //input panel may have been closed, prevent IM from interfering with hardware keyboard
445 setAttribute(Qt::WA_InputMethodEnabled, false);
448 return RemoteView::event(event);
452 //call with e == 0 to flush held events
453 void VncView::mouseEventHandler(QMouseEvent *e)
455 static bool tap_detected = false;
456 static bool double_tap_detected = false;
457 static bool tap_drag_detected = false;
458 static QTime press_time;
459 static QTime up_time; //used for double clicks/tap&drag, for time after first tap
462 if(!e) { //flush held taps
464 m_buttonMask |= rfbButton1Mask;
465 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
466 m_buttonMask &= ~rfbButton1Mask;
467 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
468 tap_detected = false;
469 } else if(double_tap_detected and press_time.elapsed() > TAP_PRESS_TIME) { //got tap + another press -> tap & drag
470 m_buttonMask |= rfbButton1Mask;
471 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
472 double_tap_detected = false;
473 tap_drag_detected = true;
479 if(e->x() < 0 or e->y() < 0) { //QScrollArea tends to send invalid events sometimes...
484 cursor_x = qRound(e->x()/m_horizontalFactor);
485 cursor_y = qRound(e->y()/m_verticalFactor);
486 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask); // plain move event
488 if(!disable_tapping and e->button() == Qt::LeftButton) { //implement touchpad-like input for left button
489 if(e->type() == QEvent::MouseButtonPress or e->type() == QEvent::MouseButtonDblClick) {
491 if(tap_detected and up_time.elapsed() < DOUBLE_TAP_UP_TIME) {
492 tap_detected = false;
493 double_tap_detected = true;
495 QTimer::singleShot(TAP_PRESS_TIME, this, SLOT(mouseEventHandler()));
497 } else if(e->type() == QEvent::MouseButtonRelease) {
498 if(tap_drag_detected) { //end tap & drag
499 m_buttonMask &= ~rfbButton1Mask;
500 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
501 tap_drag_detected = false;
502 } else if(double_tap_detected) { //double click
503 double_tap_detected = false;
505 m_buttonMask |= rfbButton1Mask;
506 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
507 m_buttonMask &= ~rfbButton1Mask;
508 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
509 m_buttonMask |= rfbButton1Mask;
510 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
511 m_buttonMask &= ~rfbButton1Mask;
512 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
513 } else if(press_time.elapsed() < TAP_PRESS_TIME) { //tap
516 QTimer::singleShot(DOUBLE_TAP_UP_TIME, this, SLOT(mouseEventHandler()));
520 } else { //middle or right button, send directly
521 if ((e->type() == QEvent::MouseButtonPress)) {
522 if (e->button() & Qt::MidButton)
523 m_buttonMask |= rfbButton2Mask;
524 if (e->button() & Qt::RightButton)
525 m_buttonMask |= rfbButton3Mask;
526 } else if (e->type() == QEvent::MouseButtonRelease) {
527 if (e->button() & Qt::MidButton)
528 m_buttonMask &= ~rfbButton2Mask;
529 if (e->button() & Qt::RightButton)
530 m_buttonMask &= ~rfbButton3Mask;
532 vncThread.mouseEvent(cursor_x, cursor_y, m_buttonMask);
535 //prevent local cursor artifacts
536 static int old_cursor_x = cursor_x;
537 static int old_cursor_y = cursor_y;
538 if(((m_dotCursorState == CursorOn) || m_forceLocalCursor)
539 and (cursor_x != old_cursor_x or cursor_y != old_cursor_y)) {
540 //clear last position
541 repaint(old_cursor_x*m_horizontalFactor - CURSOR_SIZE/2, old_cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
542 //and refresh new one
543 repaint(cursor_x*m_horizontalFactor - CURSOR_SIZE/2, cursor_y*m_verticalFactor - CURSOR_SIZE/2, CURSOR_SIZE, CURSOR_SIZE);
545 old_cursor_x = cursor_x;
546 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;