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
|
/*
SPDX-FileCopyrightText: 1999 Matthias Elter <me@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "scrollkeepertreebuilder.h"
#include "docentry.h"
#include "khc_debug.h"
#include "navigatoritem.h"
#include <KProcess>
#include <QDomDocument>
#include <QFile>
#include <QStandardPaths>
#include <prefs.h>
using namespace KHC;
ScrollKeeperTreeBuilder::ScrollKeeperTreeBuilder(QObject *parent)
: QObject(parent)
{
loadConfig();
}
void ScrollKeeperTreeBuilder::loadConfig()
{
mShowEmptyDirs = Prefs::showEmptyDirs();
}
void ScrollKeeperTreeBuilder::buildOrHide(NavigatorItem *parent)
{
build(parent);
parent->setHidden(parent->childCount() == 0);
}
void ScrollKeeperTreeBuilder::build(NavigatorItem *parent)
{
const QString lang = QLocale().bcp47Name();
qCDebug(KHC_LOG) << "ScrollKeeper language: " << lang;
const QString exePath = QStandardPaths::findExecutable(QStringLiteral("scrollkeeper-get-content-list"));
if (exePath.isEmpty()) {
qCDebug(KHC_LOG) << "scrollkeeper-get-content-list is not available, skipping";
return;
}
KProcess proc;
proc << exePath;
proc << lang;
proc.setOutputChannelMode(KProcess::OnlyStdoutChannel);
proc.start();
if (!proc.waitForFinished()) {
qCWarning(KHC_LOG) << "Could not execute scrollkeeper-get-content-list";
return;
}
mContentsList = QString::fromUtf8(proc.readAllStandardOutput().trimmed());
if (!QFile::exists(mContentsList)) {
qCWarning(KHC_LOG) << "Scrollkeeper contents file" << mContentsList << "does not exist.";
return;
}
QDomDocument doc(QStringLiteral("ScrollKeeperContentsList"));
QFile f(mContentsList);
if (!f.open(QIODevice::ReadOnly))
return;
if (!doc.setContent(&f)) {
f.close();
return;
}
f.close();
// Create top-level item
mItems.append(parent);
QDomElement docElem = doc.documentElement();
QDomNode n = docElem.firstChild();
while (!n.isNull()) {
QDomElement e = n.toElement();
if (!e.isNull()) {
if (e.tagName() == QLatin1String("sect")) {
NavigatorItem *createdItem;
insertSection(parent, e, createdItem);
}
}
n = n.nextSibling();
}
}
int ScrollKeeperTreeBuilder::insertSection(NavigatorItem *parent, const QDomNode §Node, NavigatorItem *§Item)
{
// TODO: was contents2 -> needs to be changed to help-contents-alternate or similar
DocEntry *entry = new DocEntry(QString(), QString(), QStringLiteral("help-contents"));
sectItem = new NavigatorItem(entry, parent);
sectItem->setAutoDeleteDocEntry(true);
mItems.append(sectItem);
int numDocs = 0; // Number of docs created in this section
QDomNode n = sectNode.firstChild();
while (!n.isNull()) {
QDomElement e = n.toElement();
if (!e.isNull()) {
if (e.tagName() == QLatin1String("title")) {
entry->setName(e.text());
sectItem->updateItem();
} else if (e.tagName() == QLatin1String("sect")) {
NavigatorItem *created;
numDocs += insertSection(sectItem, e, created);
} else if (e.tagName() == QLatin1String("doc")) {
insertDoc(sectItem, e);
++numDocs;
}
}
n = n.nextSibling();
}
// Remove empty sections
if (!mShowEmptyDirs && numDocs == 0) {
delete sectItem;
sectItem = nullptr;
}
return numDocs;
}
void ScrollKeeperTreeBuilder::insertDoc(NavigatorItem *parent, const QDomNode &docNode)
{
DocEntry *entry = new DocEntry(QString(), QString(), QStringLiteral("text-plain"));
NavigatorItem *docItem = new NavigatorItem(entry, parent);
docItem->setAutoDeleteDocEntry(true);
mItems.append(docItem);
QString url;
QDomNode n = docNode.firstChild();
while (!n.isNull()) {
QDomElement e = n.toElement();
if (!e.isNull()) {
if (e.tagName() == QLatin1String("doctitle")) {
entry->setName(e.text());
docItem->updateItem();
} else if (e.tagName() == QLatin1String("docsource")) {
url.append(e.text());
} else if (e.tagName() == QLatin1String("docformat")) {
QString mimeType = e.text();
if (mimeType == QLatin1String("text/html")) {
// Let the HTML part figure out how to get the doc
} else if (mimeType == QLatin1String("application/xml") || mimeType == QLatin1String("text/xml") /*deprecated name*/) {
if (url.left(5) == QLatin1String("file:"))
url = url.mid(5);
url.prepend(QLatin1String("ghelp:"));
#if 0
url.replace( QRegExp( ".xml$" ), ".html" );
#endif
} else if (mimeType == QLatin1String("text/sgml")) {
// GNOME docs use this type. We don't have a real viewer for this.
url.prepend(QStringLiteral("file:"));
} else if (mimeType.left(5) == QLatin1String("text/")) {
url.prepend(QStringLiteral("file:"));
}
}
}
n = n.nextSibling();
}
entry->setUrl(url);
}
#include "moc_scrollkeepertreebuilder.cpp"
// vim:sw=2:ts=2:et
|
