1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
|
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "helpviewer.h"
#include "helpviewer_p.h"
#include "centralwidget.h"
#include "helpenginewrapper.h"
#include "openpagesmanager.h"
#include "tracer.h"
#include <QtCore/QFileInfo>
#include <QtCore/QString>
#include <QtCore/QTimer>
#include <QtWidgets/QApplication>
#include <QtGui/QWheelEvent>
#include <QtHelp/QHelpEngineCore>
#include <QtNetwork/QNetworkAccessManager>
#include <QtNetwork/QNetworkReply>
#include <QtNetwork/QNetworkRequest>
QT_BEGIN_NAMESPACE
// -- HelpNetworkReply
class HelpNetworkReply : public QNetworkReply
{
public:
HelpNetworkReply(const QNetworkRequest &request, const QByteArray &fileData,
const QString &mimeType);
virtual void abort();
virtual qint64 bytesAvailable() const
{ return data.length() + QNetworkReply::bytesAvailable(); }
protected:
virtual qint64 readData(char *data, qint64 maxlen);
private:
QByteArray data;
qint64 origLen;
};
HelpNetworkReply::HelpNetworkReply(const QNetworkRequest &request,
const QByteArray &fileData, const QString& mimeType)
: data(fileData), origLen(fileData.length())
{
TRACE_OBJ
setRequest(request);
setOpenMode(QIODevice::ReadOnly);
setHeader(QNetworkRequest::ContentTypeHeader, mimeType);
setHeader(QNetworkRequest::ContentLengthHeader, QByteArray::number(origLen));
QTimer::singleShot(0, this, SIGNAL(metaDataChanged()));
QTimer::singleShot(0, this, SIGNAL(readyRead()));
QTimer::singleShot(0, this, SIGNAL(finished()));
}
void HelpNetworkReply::abort()
{
TRACE_OBJ
}
qint64 HelpNetworkReply::readData(char *buffer, qint64 maxlen)
{
TRACE_OBJ
qint64 len = qMin(qint64(data.length()), maxlen);
if (len) {
memcpy(buffer, data.constData(), len);
data.remove(0, len);
}
if (!data.length())
QTimer::singleShot(0, this, SIGNAL(finished()));
return len;
}
// -- HelpNetworkAccessManager
class HelpNetworkAccessManager : public QNetworkAccessManager
{
public:
HelpNetworkAccessManager(QObject *parent);
protected:
virtual QNetworkReply *createRequest(Operation op,
const QNetworkRequest &request, QIODevice *outgoingData = 0);
};
HelpNetworkAccessManager::HelpNetworkAccessManager(QObject *parent)
: QNetworkAccessManager(parent)
{
TRACE_OBJ
}
QNetworkReply *HelpNetworkAccessManager::createRequest(Operation /*op*/,
const QNetworkRequest &request, QIODevice* /*outgoingData*/)
{
TRACE_OBJ
QString url = request.url().toString();
const HelpEngineWrapper &engine = HelpEngineWrapper::instance();
bool fileFound = engine.findFile(url).isValid();
if (!fileFound && HelpViewer::isLocalUrl(request.url()))
url = HelpViewer::fixupVirtualFolderForUrl(&engine, request.url(), &fileFound);
const QString &mimeType = HelpViewer::mimeFromUrl(url);
const QByteArray &data = fileFound ? engine.fileData(url)
: HelpViewer::PageNotFoundMessage.arg(url).toUtf8();
return new HelpNetworkReply(request, data, mimeType.isEmpty()
? QLatin1String("application/octet-stream") : mimeType);
}
// -- HelpPage
class HelpPage : public QWebPage
{
public:
HelpPage(QObject *parent);
protected:
virtual QWebPage *createWindow(QWebPage::WebWindowType);
virtual void triggerAction(WebAction action, bool checked = false);
virtual bool acceptNavigationRequest(QWebFrame *frame,
const QNetworkRequest &request, NavigationType type);
private:
bool closeNewTabIfNeeded;
friend class HelpViewer;
QUrl m_loadingUrl;
Qt::MouseButtons m_pressedButtons;
Qt::KeyboardModifiers m_keyboardModifiers;
};
HelpPage::HelpPage(QObject *parent)
: QWebPage(parent)
, closeNewTabIfNeeded(false)
, m_pressedButtons(Qt::NoButton)
, m_keyboardModifiers(Qt::NoModifier)
{
TRACE_OBJ
}
QWebPage *HelpPage::createWindow(QWebPage::WebWindowType)
{
TRACE_OBJ
HelpPage* newPage = static_cast<HelpPage*>(OpenPagesManager::instance()
->createPage()->page());
newPage->closeNewTabIfNeeded = closeNewTabIfNeeded;
closeNewTabIfNeeded = false;
return newPage;
}
void HelpPage::triggerAction(WebAction action, bool checked)
{
TRACE_OBJ
switch (action) {
case OpenLinkInNewWindow:
closeNewTabIfNeeded = true;
default: // fall through
QWebPage::triggerAction(action, checked);
break;
}
}
bool HelpPage::acceptNavigationRequest(QWebFrame *,
const QNetworkRequest &request, QWebPage::NavigationType type)
{
TRACE_OBJ
const bool closeNewTab = closeNewTabIfNeeded;
closeNewTabIfNeeded = false;
const QUrl &url = request.url();
if (HelpViewer::launchWithExternalApp(url)) {
if (closeNewTab)
QMetaObject::invokeMethod(OpenPagesManager::instance(), "closeCurrentPage");
return false;
}
if (type == QWebPage::NavigationTypeLinkClicked
&& (m_keyboardModifiers & Qt::ControlModifier || m_pressedButtons == Qt::MidButton)) {
m_pressedButtons = Qt::NoButton;
m_keyboardModifiers = Qt::NoModifier;
OpenPagesManager::instance()->createPage(url);
return false;
}
m_loadingUrl = url; // because of async page loading, we will hit some kind
// of race condition while using a remote command, like a combination of
// SetSource; SyncContent. SetSource would be called and SyncContents shortly
// afterwards, but the page might not have finished loading and the old url
// would be returned.
return true;
}
// -- HelpViewer
HelpViewer::HelpViewer(qreal zoom, QWidget *parent)
: QWebView(parent)
, d(new HelpViewerPrivate)
{
TRACE_OBJ
setAcceptDrops(false);
settings()->setAttribute(QWebSettings::JavaEnabled, false);
settings()->setAttribute(QWebSettings::PluginsEnabled, false);
setPage(new HelpPage(this));
page()->setNetworkAccessManager(new HelpNetworkAccessManager(this));
QAction* action = pageAction(QWebPage::OpenLinkInNewWindow);
action->setText(tr("Open Link in New Page"));
pageAction(QWebPage::DownloadLinkToDisk)->setVisible(false);
pageAction(QWebPage::DownloadImageToDisk)->setVisible(false);
pageAction(QWebPage::OpenImageInNewWindow)->setVisible(false);
connect(pageAction(QWebPage::Copy), SIGNAL(changed()), this,
SLOT(actionChanged()));
connect(pageAction(QWebPage::Back), SIGNAL(changed()), this,
SLOT(actionChanged()));
connect(pageAction(QWebPage::Forward), SIGNAL(changed()), this,
SLOT(actionChanged()));
connect(page(), SIGNAL(linkHovered(QString, QString, QString)), this,
SIGNAL(highlighted(QString)));
connect(this, SIGNAL(urlChanged(QUrl)), this, SIGNAL(sourceChanged(QUrl)));
connect(this, SIGNAL(loadStarted()), this, SLOT(setLoadStarted()));
connect(this, SIGNAL(loadFinished(bool)), this, SLOT(setLoadFinished(bool)));
connect(this, SIGNAL(titleChanged(QString)), this, SIGNAL(titleChanged()));
connect(page(), SIGNAL(printRequested(QWebFrame*)), this, SIGNAL(printRequested()));
setFont(viewerFont());
setTextSizeMultiplier(zoom == 0.0 ? 1.0 : zoom);
}
QFont HelpViewer::viewerFont() const
{
TRACE_OBJ
if (HelpEngineWrapper::instance().usesBrowserFont())
return HelpEngineWrapper::instance().browserFont();
QWebSettings *webSettings = QWebSettings::globalSettings();
return QFont(webSettings->fontFamily(QWebSettings::StandardFont),
webSettings->fontSize(QWebSettings::DefaultFontSize));
}
void HelpViewer::setViewerFont(const QFont &font)
{
TRACE_OBJ
QWebSettings *webSettings = settings();
webSettings->setFontFamily(QWebSettings::StandardFont, font.family());
webSettings->setFontSize(QWebSettings::DefaultFontSize, font.pointSize());
}
void HelpViewer::scaleUp()
{
TRACE_OBJ
setTextSizeMultiplier(textSizeMultiplier() + 0.1);
}
void HelpViewer::scaleDown()
{
TRACE_OBJ
setTextSizeMultiplier(qMax(0.0, textSizeMultiplier() - 0.1));
}
void HelpViewer::resetScale()
{
TRACE_OBJ
setTextSizeMultiplier(1.0);
}
qreal HelpViewer::scale() const
{
TRACE_OBJ
return textSizeMultiplier();
}
QString HelpViewer::title() const
{
TRACE_OBJ
return QWebView::title();
}
void HelpViewer::setTitle(const QString &title)
{
TRACE_OBJ
Q_UNUSED(title)
}
QUrl HelpViewer::source() const
{
TRACE_OBJ
HelpPage *currentPage = static_cast<HelpPage*> (page());
if (currentPage && !d->m_loadFinished) {
// see HelpPage::acceptNavigationRequest(...)
return currentPage->m_loadingUrl;
}
return url();
}
void HelpViewer::setSource(const QUrl &url)
{
TRACE_OBJ
load(url.toString() == QLatin1String("help") ? LocalHelpFile : url);
}
QString HelpViewer::selectedText() const
{
TRACE_OBJ
return QWebView::selectedText();
}
bool HelpViewer::isForwardAvailable() const
{
TRACE_OBJ
return pageAction(QWebPage::Forward)->isEnabled();
}
bool HelpViewer::isBackwardAvailable() const
{
TRACE_OBJ
return pageAction(QWebPage::Back)->isEnabled();
}
bool HelpViewer::findText(const QString &text, FindFlags flags, bool incremental,
bool fromSearch)
{
TRACE_OBJ
Q_UNUSED(incremental); Q_UNUSED(fromSearch);
QWebPage::FindFlags options = QWebPage::FindWrapsAroundDocument;
if (flags & FindBackward)
options |= QWebPage::FindBackward;
if (flags & FindCaseSensitively)
options |= QWebPage::FindCaseSensitively;
bool found = QWebView::findText(text, options);
options = QWebPage::HighlightAllOccurrences;
QWebView::findText(QLatin1String(""), options); // clear first
QWebView::findText(text, options); // force highlighting of all other matches
return found;
}
// -- public slots
#ifndef QT_NO_CLIPBOARD
void HelpViewer::copy()
{
TRACE_OBJ
triggerPageAction(QWebPage::Copy);
}
#endif
void HelpViewer::forward()
{
TRACE_OBJ
QWebView::forward();
}
void HelpViewer::backward()
{
TRACE_OBJ
back();
}
// -- protected
void HelpViewer::keyPressEvent(QKeyEvent *e)
{
TRACE_OBJ
// TODO: remove this once we support multiple keysequences per command
#ifndef QT_NO_CLIPBOARD
if (e->key() == Qt::Key_Insert && e->modifiers() == Qt::CTRL) {
if (!selectedText().isEmpty())
copy();
}
#endif
QWebView::keyPressEvent(e);
}
void HelpViewer::wheelEvent(QWheelEvent *event)
{
TRACE_OBJ
if (event->modifiers()& Qt::ControlModifier) {
event->accept();
event->delta() > 0 ? scaleUp() : scaleDown();
} else {
QWebView::wheelEvent(event);
}
}
void HelpViewer::mousePressEvent(QMouseEvent *event)
{
TRACE_OBJ
#ifdef Q_OS_LINUX
if (handleForwardBackwardMouseButtons(event))
return;
#endif
if (HelpPage *currentPage = static_cast<HelpPage*> (page())) {
currentPage->m_pressedButtons = event->buttons();
currentPage->m_keyboardModifiers = event->modifiers();
}
QWebView::mousePressEvent(event);
}
void HelpViewer::mouseReleaseEvent(QMouseEvent *event)
{
TRACE_OBJ
#ifndef Q_OS_LINUX
if (handleForwardBackwardMouseButtons(event))
return;
#endif
QWebView::mouseReleaseEvent(event);
}
// -- private slots
void HelpViewer::actionChanged()
{
TRACE_OBJ
QAction *a = qobject_cast<QAction *>(sender());
if (a == pageAction(QWebPage::Copy))
emit copyAvailable(a->isEnabled());
else if (a == pageAction(QWebPage::Back))
emit backwardAvailable(a->isEnabled());
else if (a == pageAction(QWebPage::Forward))
emit forwardAvailable(a->isEnabled());
}
// -- private
bool HelpViewer::eventFilter(QObject *obj, QEvent *event)
{
TRACE_OBJ
return QWebView::eventFilter(obj, event);
}
void HelpViewer::contextMenuEvent(QContextMenuEvent *event)
{
TRACE_OBJ
QWebView::contextMenuEvent(event);
}
QT_END_NAMESPACE
|