Restrict more sensitive debugging output

There are more places where sensitive information could accidentally be
disclosed.

Also, move SENSITIVE_DEBUG to config.pri so that plugins can use it.

Change-Id: Ifa4ccbd6bf4bf79412f29984c662c9e58ea01992
Reviewed-by: Kari Oikarinen <kari.oikarinen@qt.io>
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Yuntaek Rim <yuntaek.rim@myscript.com>

9 files changed, 35 insertions, 6 deletions

diff --git a/src/config.pri b/src/config.pri
index 81e05763..435ae5e1 100644
--- a/src/config.pri
+++ b/src/config.pri
@@ -115,3 +115,9 @@ disable-xcb {
     message("The disable-xcb option has been deprecated. Please use disable-desktop instead.")
     CONFIG += disable-desktop
 }
+
+# Enables logging of sensitive information, such as key events.
+# Should never be enabled by default.
+# It's defined here rather than virtualkeyboarddebug_p.h
+# so that the plugins can use it.
+sensitive-debug: DEFINES += SENSITIVE_DEBUG
diff --git a/src/plugins/lipi-toolkit/plugin/lipiinputmethod.cpp b/src/plugins/lipi-toolkit/plugin/lipiinputmethod.cpp
index ca23c491..829692c8 100644
--- a/src/plugins/lipi-toolkit/plugin/lipiinputmethod.cpp
+++ b/src/plugins/lipi-toolkit/plugin/lipiinputmethod.cpp
@@ -621,6 +621,7 @@ void LipiInputMethod::timerEvent(QTimerEvent *timerEvent)
 
 void LipiInputMethod::resultsAvailable(const QVariantList &resultList)
 {
+#ifdef SENSITIVE_DEBUG
     if (lcLipi().isDebugEnabled()) {
         qCDebug(lcLipi) << "LipiInputMethod::resultsAvailable():";
         for (int i = 0; i < resultList.size(); i++) {
@@ -631,6 +632,7 @@ void LipiInputMethod::resultsAvailable(const QVariantList &resultList)
                                .arg(unicode).arg(confidence).toUtf8().constData();
         }
     }
+#endif
     Q_D(LipiInputMethod);
     d->resultsAvailable(resultList);
 }
diff --git a/src/plugins/myscript/plugin/myscriptinputmethod.cpp b/src/plugins/myscript/plugin/myscriptinputmethod.cpp
index aaa4d62e..2a87bdbb 100644
--- a/src/plugins/myscript/plugin/myscriptinputmethod.cpp
+++ b/src/plugins/myscript/plugin/myscriptinputmethod.cpp
@@ -890,7 +890,9 @@ public:
             return;
 
         qCDebug(qlcVKMyScript) << Q_FUNC_INFO;
+#ifdef SENSITIVE_DEBUG
         qCDebug(qlcVKMyScript) << "preeditText:" << ic->preeditText();
+#endif
 
         bool isItemChanged = false;
         int lastPosition = 0;
@@ -1299,8 +1301,10 @@ void MyScriptRecognizeWorker::manageRecognitionResult(voimEngine *engine, voimRe
                     char *temp = bytes.data();
 
                     voim_getItemCandidateLabel(engine, result, itemIndex, candidateIndex, temp, length, "UTF-8");
+#ifdef SENSITIVE_DEBUG
                     float score = voim_getItemCandidateScore(engine, result, itemIndex, candidateIndex);
                     qCDebug(qlcVKMyScript) << "      - candidate #" << candidateIndex << " of " << candidateCount << " :" << temp << "(" << score << ")";
+#endif
 
                     QString label = QString::fromUtf8(temp);
 
diff --git a/src/plugins/openwnn/3rdparty/openwnn/wnnEngine/composingtext.cpp b/src/plugins/openwnn/3rdparty/openwnn/wnnEngine/composingtext.cpp
index 1f9ca4ff..b221a7e7 100644
--- a/src/plugins/openwnn/3rdparty/openwnn/wnnEngine/composingtext.cpp
+++ b/src/plugins/openwnn/3rdparty/openwnn/wnnEngine/composingtext.cpp
@@ -205,6 +205,7 @@ StrSegment ComposingText::getStrSegment(TextLayer layer, int pos) const
 
 void ComposingText::debugout() const
 {
+#ifdef SENSITIVE_DEBUG
     Q_D(const ComposingText);
     for (int i = LAYER0; i < MAX_LAYER; i++) {
         QString tmp;
@@ -213,6 +214,7 @@ void ComposingText::debugout() const
             tmp += QStringLiteral("(%1,%2,%3)").arg(it->string).arg(it->from).arg(it->to);
         }
     }
+#endif
 }
 
 QString ComposingText::toString(TextLayer layer, int from, int to) const
diff --git a/src/plugins/t9write/plugin/t9writeinputmethod.cpp b/src/plugins/t9write/plugin/t9writeinputmethod.cpp
index 9e62e836..1626a199 100644
--- a/src/plugins/t9write/plugin/t9writeinputmethod.cpp
+++ b/src/plugins/t9write/plugin/t9writeinputmethod.cpp
@@ -2127,6 +2127,7 @@ void T9WriteInputMethod::dictionaryLoadCompleted(QSharedPointer<T9WriteDictionar
 
 void T9WriteInputMethod::resultsAvailable(const QVariantList &resultList)
 {
+#ifdef SENSITIVE_DEBUG
     if (lcT9Write().isDebugEnabled()) {
         qCDebug(lcT9Write) << "T9WriteInputMethod::resultsAvailable():";
         for (int i = 0; i < resultList.size(); i++) {
@@ -2147,6 +2148,7 @@ void T9WriteInputMethod::resultsAvailable(const QVariantList &resultList)
             qCDebug(lcT9Write) << resultPrint.toUtf8().constData();
         }
     }
+#endif
     Q_D(T9WriteInputMethod);
     QMutexLocker resultListGuard(&d->resultListLock);
     d->resultList = resultList;
diff --git a/src/plugins/t9write/plugin/t9writeworker.cpp b/src/plugins/t9write/plugin/t9writeworker.cpp
index be9b4d9e..3dd0a6a2 100644
--- a/src/plugins/t9write/plugin/t9writeworker.cpp
+++ b/src/plugins/t9write/plugin/t9writeworker.cpp
@@ -173,7 +173,9 @@ T9WriteRecognitionTask::T9WriteRecognitionTask(QSharedPointer<T9WriteRecognition
     stringStart(stringStart),
     stateCancelled(false)
 {
+#ifdef SENSITIVE_DEBUG
     qCDebug(lcT9Write) << "T9WriteRecognitionTask():" << "boostLevel:" << boostLevel << "stringStart:" << stringStart;
+#endif
 }
 
 void T9WriteRecognitionTask::run()
diff --git a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
index e74f5201..c4b97695 100644
--- a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
@@ -278,7 +278,12 @@ void QVirtualKeyboardInputContext::commit()
 void QVirtualKeyboardInputContext::commit(const QString &text, int replaceFrom, int replaceLength)
 {
     Q_D(QVirtualKeyboardInputContext);
-    VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContext::commit():" << text << replaceFrom << replaceLength;
+
+    VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContext::commit()"
+#ifdef SENSITIVE_DEBUG
+           << text << replaceFrom << replaceLength
+#endif
+        ;
     bool preeditChanged = !d->preeditText.isEmpty();
 
     if (d->platformInputContext) {
diff --git a/src/virtualkeyboard/qvirtualkeyboardinputcontext_p.cpp b/src/virtualkeyboard/qvirtualkeyboardinputcontext_p.cpp
index d2308b04..1233de99 100644
--- a/src/virtualkeyboard/qvirtualkeyboardinputcontext_p.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardinputcontext_p.cpp
@@ -267,7 +267,11 @@ void QVirtualKeyboardInputContextPrivate::onInputItemChanged()
 
 void QVirtualKeyboardInputContextPrivate::sendPreedit(const QString &text, const QList<QInputMethodEvent::Attribute> &attributes, int replaceFrom, int replaceLength)
 {
-    VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContextPrivate::sendPreedit():" << text << replaceFrom << replaceLength;
+    VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContextPrivate::sendPreedit()"
+#ifdef SENSITIVE_DEBUG
+           << text << replaceFrom << replaceLength
+#endif
+        ;
 
     bool textChanged = preeditText != text;
     bool attributesChanged = preeditTextAttributes != attributes;
@@ -289,7 +293,11 @@ void QVirtualKeyboardInputContextPrivate::sendPreedit(const QString &text, const
             // input may be out of sync.
             if (_shadow.inputItem() && !replace && !text.isEmpty() &&
                     !textChanged && attributesChanged) {
-                VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContextPrivate::sendPreedit(shadow):" << text << replaceFrom << replaceLength;
+                VIRTUALKEYBOARD_DEBUG() << "QVirtualKeyboardInputContextPrivate::sendPreedit(shadow)"
+#ifdef SENSITIVE_DEBUG
+                       << text << replaceFrom << replaceLength
+#endif
+                    ;
                 event.setAccepted(true);
                 QGuiApplication::sendEvent(_shadow.inputItem(), &event);
             }
diff --git a/src/virtualkeyboard/virtualkeyboarddebug_p.h b/src/virtualkeyboard/virtualkeyboarddebug_p.h
index 0479aa25..02374663 100644
--- a/src/virtualkeyboard/virtualkeyboarddebug_p.h
+++ b/src/virtualkeyboard/virtualkeyboarddebug_p.h
@@ -49,9 +49,7 @@ namespace QtVirtualKeyboard {
 
 Q_DECLARE_LOGGING_CATEGORY(qlcVirtualKeyboard)
 
-// Enables logging of sensitive information, such as key events.
-// Should never be enabled by default.
-//#define SENSITIVE_DEBUG
+// See config.pri for SENSITIVE_DEBUG.
 
 #define VIRTUALKEYBOARD_DEBUG() qCDebug(qlcVirtualKeyboard)
 #define VIRTUALKEYBOARD_WARN() qCWarning(qlcVirtualKeyboard)