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 ****************************************************************************/
24 #include "vncclientthread.h"
26 #include <QMutexLocker>
29 static QString outputErrorMessageString;
31 rfbBool VncClientThread::newclient(rfbClient *cl)
33 VncClientThread *t = (VncClientThread*)rfbClientGetClientData(cl, 0);
36 const int width = cl->width, height = cl->height, depth = cl->format.bitsPerPixel;
37 const int size = width * height * (depth / 8);
39 delete [] t->frameBuffer; // do not leak if we get a new framebuffer size
40 t->frameBuffer = new uint8_t[size];
41 cl->frameBuffer = t->frameBuffer;
42 memset(cl->frameBuffer, '\0', size);
43 cl->format.bitsPerPixel = 32;
44 cl->format.redShift = 16;
45 cl->format.greenShift = 8;
46 cl->format.blueShift = 0;
47 cl->format.redMax = 0xff;
48 cl->format.greenMax = 0xff;
49 cl->format.blueMax = 0xff;
51 switch (t->quality()) {
52 case RemoteView::High:
53 cl->appData.useBGR233 = 0;
54 cl->appData.encodingsString = "copyrect hextile raw";
55 cl->appData.compressLevel = 0;
56 cl->appData.qualityLevel = 9;
58 case RemoteView::Medium:
59 cl->appData.useBGR233 = 0;
60 cl->appData.encodingsString = "tight zrle ultra copyrect hextile zlib corre rre raw";
61 cl->appData.compressLevel = 5;
62 cl->appData.qualityLevel = 7;
65 case RemoteView::Unknown:
67 cl->appData.useBGR233 = 1;
68 cl->appData.encodingsString = "tight zrle ultra copyrect hextile zlib corre rre raw";
69 cl->appData.compressLevel = 9;
70 cl->appData.qualityLevel = 1;
73 SetFormatAndEncodings(cl);
78 void VncClientThread::updatefb(rfbClient* cl, int x, int y, int w, int h)
80 // kDebug(5011) << "updated client: x: " << x << ", y: " << y << ", w: " << w << ", h: " << h;
82 const int width = cl->width, height = cl->height;
84 const QImage img(cl->frameBuffer, width, height, QImage::Format_RGB32);
87 kDebug(5011) << "image not loaded";
90 VncClientThread *t = (VncClientThread*)rfbClientGetClientData(cl, 0);
95 t->emitUpdated(x, y, w, h);
98 void VncClientThread::cuttext(rfbClient* cl, const char *text, int textlen)
100 const QString cutText = QString::fromUtf8(text, textlen);
101 kDebug(5011) << cutText;
103 if (!cutText.isEmpty()) {
104 VncClientThread *t = (VncClientThread*)rfbClientGetClientData(cl, 0);
107 t->emitGotCut(cutText);
111 char *VncClientThread::passwdHandler(rfbClient *cl)
113 kDebug(5011) << "password request" << kBacktrace();
115 VncClientThread *t = (VncClientThread*)rfbClientGetClientData(cl, 0);
118 t->passwordRequest();
119 t->m_passwordError = true;
121 return strdup(t->password().toLocal8Bit());
124 void VncClientThread::outputHandler(const char *format, ...)
127 va_start(args, format);
130 message.vsprintf(format, args);
134 message = message.trimmed();
136 kDebug(5011) << message;
138 if ((message.contains("Couldn't convert ")) ||
139 (message.contains("Unable to connect to VNC server")))
140 outputErrorMessageString = i18n("Server not found.");
142 if ((message.contains("VNC connection failed: Authentication failed, too many tries")) ||
143 (message.contains("VNC connection failed: Too many authentication failures")))
144 outputErrorMessageString = i18n("VNC authentication failed because of too many authentication tries.");
146 if (message.contains("VNC connection failed: Authentication failed"))
147 outputErrorMessageString = i18n("VNC authentication failed.");
149 if (message.contains("VNC server closed connection"))
150 outputErrorMessageString = i18n("VNC server closed connection.");
152 // internal messages, not displayed to user
153 if (message.contains("VNC server supports protocol version 3.889")) // see http://bugs.kde.org/162640
154 outputErrorMessageString = "INTERNAL:APPLE_VNC_COMPATIBILTY";
157 VncClientThread::VncClientThread(QObject *parent)
161 QMutexLocker locker(&mutex);
164 QTimer *outputErrorMessagesCheckTimer = new QTimer(this);
165 outputErrorMessagesCheckTimer->setInterval(500);
166 connect(outputErrorMessagesCheckTimer, SIGNAL(timeout()), this, SLOT(checkOutputErrorMessage()));
167 outputErrorMessagesCheckTimer->start();
170 VncClientThread::~VncClientThread()
174 const bool quitSuccess = wait(500);
176 kDebug(5011) << "Quit VNC thread success:" << quitSuccess;
178 delete [] frameBuffer;
182 void VncClientThread::checkOutputErrorMessage()
184 if (!outputErrorMessageString.isEmpty()) {
185 kDebug(5011) << outputErrorMessageString;
186 QString errorMessage = outputErrorMessageString;
187 outputErrorMessageString.clear();
188 // show authentication failure error only after the 3rd unsuccessful try
189 if ((errorMessage != i18n("VNC authentication failed.")) || m_passwordError)
190 outputErrorMessage(errorMessage);
194 void VncClientThread::setHost(const QString &host)
196 QMutexLocker locker(&mutex);
200 void VncClientThread::setPort(int port)
202 QMutexLocker locker(&mutex);
206 void VncClientThread::setQuality(RemoteView::Quality quality)
211 RemoteView::Quality VncClientThread::quality() const
216 void VncClientThread::setImage(const QImage &img)
218 QMutexLocker locker(&mutex);
222 const QImage VncClientThread::image(int x, int y, int w, int h)
224 QMutexLocker locker(&mutex);
226 if (w == 0) // full image requested
229 return m_image.copy(x, y, w, h);
232 void VncClientThread::emitUpdated(int x, int y, int w, int h)
234 emit imageUpdated(x, y, w, h);
237 void VncClientThread::emitGotCut(const QString &text)
242 void VncClientThread::stop()
244 QMutexLocker locker(&mutex);
248 void VncClientThread::run()
250 QMutexLocker locker(&mutex);
252 while (!m_stopped) { // try to connect as long as the server allows
253 m_passwordError = false;
255 rfbClientLog = outputHandler;
256 rfbClientErr = outputHandler;
257 cl = rfbGetClient(8, 3, 4);
258 cl->MallocFrameBuffer = newclient;
259 cl->canHandleNewFBSize = true;
260 cl->GetPassword = passwdHandler;
261 cl->GotFrameBufferUpdate = updatefb;
262 cl->GotXCutText = cuttext;
263 rfbClientSetClientData(cl, 0, this);
265 cl->serverHost = strdup(m_host.toUtf8().constData());
267 if (m_port < 0 || !m_port) // port is invalid or empty...
268 m_port = 5900; // fallback: try an often used VNC port
270 if (m_port >= 0 && m_port < 100) // the user most likely used the short form (e.g. :1)
272 cl->serverPort = m_port;
274 kDebug(5011) << "--------------------- trying init ---------------------";
276 if (rfbInitClient(cl, 0, 0))
287 // Main VNC event loop
289 const int i = WaitForMessage(cl, 500);
293 if (!HandleRFBServerMessage(cl))
298 while (!m_eventQueue.isEmpty()) {
299 ClientEvent* clientEvent = m_eventQueue.dequeue();
300 clientEvent->fire(cl);
307 // Cleanup allocated resources
309 rfbClientCleanup(cl);
313 ClientEvent::~ClientEvent()
317 void PointerClientEvent::fire(rfbClient* cl)
319 SendPointerEvent(cl, m_x, m_y, m_buttonMask);
322 void KeyClientEvent::fire(rfbClient* cl)
324 SendKeyEvent(cl, m_key, m_pressed);
327 void ClientCutEvent::fire(rfbClient* cl)
329 SendClientCutText(cl, text.toUtf8().data(), text.size());
332 void VncClientThread::mouseEvent(int x, int y, int buttonMask)
334 QMutexLocker lock(&mutex);
338 m_eventQueue.enqueue(new PointerClientEvent(x, y, buttonMask));
341 void VncClientThread::keyEvent(int key, bool pressed)
343 QMutexLocker lock(&mutex);
347 m_eventQueue.enqueue(new KeyClientEvent(key, pressed));
350 void VncClientThread::clientCut(const QString &text)
352 QMutexLocker lock(&mutex);
356 m_eventQueue.enqueue(new ClientCutEvent(text));
359 #include "moc_vncclientthread.cpp"