XMPP Console (#902)

* xmlconsole.ui add tooltips

* xmlconsole.ui rename title to XMPP Console

* xmlconsole.ui disable ck_sm (asks) by default: it's too many of them

* xmlconsole.ui remove black background

* xmlconsole.ui use frame color to distinguish in/out messages

* xmlconsole.ui: addRecord() use early return

* xmlconsole.ui: addRecord() extract vars for readability

Author: stokito

src/contactlistaccountmenu.cpp

@@ -122,7 +122,7 @@ class ContactListAccountMenu::Private : public QObject {
         privacyListsAction_ = new IconAction(tr("Privacy Lists"), this, "psi/eye");
         connect(privacyListsAction_, SIGNAL(triggered()), SLOT(privacyLists()));
 
-        xmlConsoleAction_ = new IconAction(tr("&XML Console"), this, "psi/xml");
+        xmlConsoleAction_ = new IconAction(tr("&XMPP Console"), this, "psi/xml");
         connect(xmlConsoleAction_, SIGNAL(triggered()), SLOT(xmlConsole()));
 
         modifyAccountAction_ = new IconAction(tr("&Modify Account..."), this, "psi/account");

src/psiactionlist.cpp

@@ -244,7 +244,7 @@ void PsiActionList::Private::createMainWin()
         if (!PsiOptions::instance()->getOption("options.ui.contactlist.lockdown-roster").toBool())
             add_act = new MAction(IconsetFactory::icon("psi/addContact"), tr("&Add a Contact"), 0, psi, this);
 
-        IconAction *lw_act = new MAction(IconsetFactory::icon("psi/xml"), tr("&XML Console"), 2, psi, this);
+        IconAction *lw_act = new MAction(IconsetFactory::icon("psi/xml"), tr("&XMPP Console"), 2, psi, this);
 
         IconAction *actDisco = nullptr;
         if (!PsiOptions::instance()->getOption("options.ui.contactlist.disable-service-discovery").toBool())

src/psiiconset.cpp

@@ -59,7 +59,7 @@ struct ClientIconCheck {
  *
  * To discover the client do next:
  * 1. Find any alive contact using interested you client
- * 2. Open xml console, and insert the current JID together with current online resource into the filter line
+ * 2. Open XMPP Console and insert the current JID together with its current online resource into the filter line
  * 3. Press Dump Ringbuf to see some stanzas.
  * 4. Find <presence....> stanza and remember "ver" attribute from <c> element
  * 5. Open caps.xml file (~/.cache/psi/caps.xml, "C:/Users/<USER>/AppData/Local/psi/cache") and search for

src/xmlconsole.cpp

@@ -57,10 +57,6 @@ XmlConsole::XmlConsole(PsiAccount *_pa) : QWidget()
     ui_.te->setReadOnly(true);
     ui_.te->setAcceptRichText(false);
 
-    QTextFrameFormat f = ui_.te->document()->rootFrame()->frameFormat();
-    f.setBackground(QBrush(Qt::black));
-    ui_.te->document()->rootFrame()->setFrameFormat(f);
-
     connect(ui_.pb_clear, SIGNAL(clicked()), SLOT(clear()));
     connect(ui_.pb_input, SIGNAL(clicked()), SLOT(insertXml()));
     connect(ui_.pb_close, SIGNAL(clicked()), SLOT(close()));
@@ -74,17 +70,14 @@ XmlConsole::~XmlConsole() { pa->dialogUnregister(this); }
 void XmlConsole::clear()
 {
     ui_.te->clear();
-    QTextFrameFormat f = ui_.te->document()->rootFrame()->frameFormat();
-    f.setBackground(QBrush(Qt::black));
-    ui_.te->document()->rootFrame()->setFrameFormat(f);
 }
 
 void XmlConsole::updateCaption()
 {
     if (pa->psi()->contactList()->enabledAccounts().count() > 1)
-        setWindowTitle(pa->name() + ": " + tr("XML Console"));
+        setWindowTitle(pa->name() + ": " + tr("XMPP Console"));
     else
-        setWindowTitle(tr("XML Console"));
+        setWindowTitle(tr("XMPP Console"));
 }
 
 void XmlConsole::enable() { ui_.ck_enable->setChecked(true); }
@@ -135,23 +128,38 @@ void XmlConsole::dumpRingbuf()
     ui_.ck_enable->setChecked(enablesave);
 }
 
+static const QTextFrameFormat frameFormatIncoming = [] {
+    QTextFrameFormat f;
+    f.setBackground(QColorConstants::Svg::lemonchiffon);
+    return f;
+}();
+
+static const QTextFrameFormat frameFormatOutcoming = [] {
+    QTextFrameFormat f;
+    f.setBackground(QColorConstants::Svg::lightpink);
+    return f;
+}();
+
+
 void XmlConsole::addRecord(bool incoming, const QString &str)
 {
-    if (!filtered(str)) {
-        int         prevSPos = ui_.te->verticalScrollBar()->value();
-        bool        atBottom = (prevSPos == ui_.te->verticalScrollBar()->maximum());
-        QTextCursor prevCur  = ui_.te->textCursor();
-
-        ui_.te->moveCursor(QTextCursor::End);
-        ui_.te->setTextColor(incoming ? Qt::yellow : Qt::red);
-        ui_.te->insertPlainText(str + '\n');
-
-        if (!atBottom) {
-            ui_.te->setTextCursor(prevCur);
-            ui_.te->verticalScrollBar()->setValue(prevSPos);
-        } else {
-            ui_.te->verticalScrollBar()->setValue(ui_.te->verticalScrollBar()->maximum());
-        }
+    if (filtered(str))
+        return;
+    auto *textEdit    = ui_.te;
+    auto *scrollBar   = textEdit->verticalScrollBar();
+    int   prevSPos    = scrollBar->value();
+    bool  wasAtBottom = (prevSPos == scrollBar->maximum());
+    auto  prevCur     = textEdit->textCursor();
+
+    textEdit->moveCursor(QTextCursor::End);
+    textEdit->textCursor().insertFrame(incoming ?  frameFormatIncoming : frameFormatOutcoming);
+    textEdit->insertPlainText(str);
+
+    if (!wasAtBottom) {
+        textEdit->setTextCursor(prevCur);
+        scrollBar->setValue(prevSPos);
+    } else {
+        scrollBar->setValue(scrollBar->maximum());
     }
 }
 

src/xmlconsole.ui

@@ -11,7 +11,7 @@
    </rect>
   </property>
   <property name="windowTitle">
-   <string>XML Console</string>
+   <string>XMPP Console</string>
   </property>
   <layout class="QVBoxLayout">
    <property name="margin" >
@@ -37,6 +37,9 @@
       </property>
       <item>
        <widget class="QCheckBox" name="ck_message">
+        <property name="toolTip">
+         <string>&lt;message&gt; stanza used to send information to other XMPP entities without requiring a response.</string>
+        </property>
         <property name="text">
          <string>Message</string>
         </property>
@@ -47,6 +50,9 @@
       </item>
       <item>
        <widget class="QCheckBox" name="ck_presence">
+        <property name="toolTip">
+         <string>&lt;presence&gt; stanza used for status of other clients and components. It's a multi-cast so extensions use it to broadcast own things to contacts, such as capabilities, music choice, or location.</string>
+        </property>
         <property name="text">
          <string>Presence</string>
         </property>
@@ -57,6 +63,9 @@
       </item>
       <item>
        <widget class="QCheckBox" name="ck_iq">
+        <property name="toolTip">
+         <string>&lt;iq&gt; (info/query) stanza used for requesting and modifying information.</string>
+        </property>
         <property name="text">
          <string>IQ</string>
         </property>
@@ -67,11 +76,14 @@
       </item>
       <item>
        <widget class="QCheckBox" name="ck_sm">
+        <property name="toolTip">
+         <string>&lt;a&gt; (ack) and &lt;r&gt; (request ack) stanzas used to acknowledge successful receipt of a stanza.</string>
+        </property>
         <property name="text">
          <string>SM</string>
         </property>
         <property name="checked">
-         <bool>true</bool>
+         <bool>false</bool>
         </property>
        </widget>
       </item>