add MMCP Development Preview

CMakeLists.txt

@@ -134,9 +134,10 @@ if(DEFINED ENV{MUDLET_VERSION_BUILD} AND NOT $ENV{MUDLET_VERSION_BUILD}
   message(STATUS "Value written to app-build.txt file: $ENV{MUDLET_VERSION_BUILD}-${GIT_SHA1}")
   set(APP_BUILD $ENV{MUDLET_VERSION_BUILD} CACHE STRING "This variable is automatically set during the CMake run and should not be manually altered!" FORCE)
 else()
-  file(WRITE ${CMAKE_SOURCE_DIR}/src/app-build.txt "-dev-${GIT_SHA1}")
-  message(STATUS "Value written to app-build.txt file: -dev-${GIT_SHA1}")
-  set(APP_BUILD "-dev" CACHE STRING "This variable is automatically set during the CMake run and should not be manually altered!" FORCE)
+  # PLACEMARKER: revert "MMCP" back to "dev" in the next three lines before merging this code into the main development branch:
+  file(WRITE ${CMAKE_SOURCE_DIR}/src/app-build.txt "-MMCP-${GIT_SHA1}")
+  message(STATUS "Value written to app-build.txt file: -MMCP-${GIT_SHA1}")
+  set(APP_BUILD "-MMCP" CACHE STRING "This variable is automatically set during the CMake run and should not be manually altered!" FORCE)
   # Core dev team setting things up for a release should comment out the above
   # three lines and uncomment these below - note that the app-build.txt must not
   # contain anything (other than whitespace) for a RELEASE build:

src/CMakeLists.txt

@@ -98,6 +98,9 @@ set(mudlet_SRCS
     LuaInterface.cpp
     main.cpp
     mapInfoContributorManager.cpp
+    MMCPServer.cpp
+    MMCPClient.cpp
+    TLuaInterpreterMMCP.cpp
     mudlet.cpp
     MudletInstanceCoordinator.cpp
     ShortcutsManager.cpp
@@ -262,6 +265,9 @@ set(mudlet_HDRS
     KeyUnit.h
     LuaInterface.h
     mapInfoContributorManager.h
+    MMCP.h
+    MMCPServer.h
+    MMCPClient.h
     mudlet.h
     MudletInstanceCoordinator.h
     post_guard.h

src/Host.cpp

@@ -1,7 +1,7 @@
 /***************************************************************************
  *   Copyright (C) 2008-2013 by Heiko Koehn - KoehnHeiko@googlemail.com    *
  *   Copyright (C) 2014 by Ahmed Charles - acharles@outlook.com            *
- *   Copyright (C) 2015-2023 by Stephen Lyons - slysven@virginmedia.com    *
+ *   Copyright (C) 2015-2024 by Stephen Lyons - slysven@virginmedia.com    *
  *   Copyright (C) 2016 by Ian Adkins - ieadkins@gmail.com                 *
  *   Copyright (C) 2018 by Huadong Qi - novload@outlook.com                *
  *   Copyright (C) 2023 by Lecker Kebap - Leris@mudlet.org                 *
@@ -51,6 +51,8 @@
 #include "dlgProfilePreferences.h"
 #include "dlgIRC.h"
 #include "mudlet.h"
+#include "MMCP.h"
+#include "MMCPServer.h"
 
 #include "pre_guard.h"
 #include <chrono>
@@ -328,7 +330,12 @@ Host::Host(int port, const QString& hostname, const QString& login, const QStrin
 , mSearchOptions(dlgTriggerEditor::SearchOption::SearchOptionNone)
 , mBufferSearchOptions(TConsole::SearchOption::SearchOptionNone)
 , mpDlgIRC(nullptr)
+, mmcpServer(nullptr)
 , mpDlgProfilePreferences(nullptr)
+, mMMCPChatPort(csDefaultMMCPHostPort)
+, mMMCPAutostartServer(false)
+, mMMCPAllowConnectionRequests(false)
+, mMMCPAllowPeekRequests(false)
 , mTutorialForCompactLineAlreadyShown(false)
 , mDisplayFont(QFont(qsl("Bitstream Vera Sans Mono"), 14, QFont::Normal))
 , mLuaInterface(nullptr)
@@ -1633,6 +1640,16 @@ void Host::postIrcMessage(const QString& a, const QString& b, const QString& c)
     raiseEvent(event);
 }
 
+void Host::postChatChannelMessage(const QString& from, const QString& channel, const QString& message)
+{
+    TEvent event {};
+    event.mArgumentList << csMMCPChatSideChannelEvent;
+    event.mArgumentList << from << channel << message;
+    event.mArgumentTypeList << ARGUMENT_TYPE_STRING << ARGUMENT_TYPE_STRING << ARGUMENT_TYPE_STRING << ARGUMENT_TYPE_STRING;
+    raiseEvent(event);
+}
+
+
 void Host::enableTimer(const QString& name)
 {
     mTimerUnit.enableTimer(name);
@@ -2708,6 +2725,53 @@ bool Host::discordUserIdMatch(const QString& userName, const QString& userDiscri
     }
 }
 
+void Host::postMMCPMessage(const QString& a) {
+    TEvent event {};
+    event.mArgumentList << QLatin1String("sysMMCPMessage");
+    event.mArgumentList << a;
+    event.mArgumentTypeList << ARGUMENT_TYPE_STRING << ARGUMENT_TYPE_STRING;
+    raiseEvent(event);
+}
+
+void Host::initMMCPServer() {
+    if (mmcpServer) {
+        return;
+    }
+
+    mmcpServer = new MMCPServer(this);
+}
+
+/**
+ * Get the current chat name from the MMCPServer if it exists, otherwise
+ * read it from our saved profile information
+ * There is also the mMMCPChatname read from the xml package, where should we
+ * use that?
+ */
+QString Host::getMMCPChatName() {
+    return mMMCPChatName;
+}
+
+void Host::setMMCPChatName(const QString& name) {
+    mMMCPChatName = name;
+    emit mmcpChatNameChanged(name);
+}
+
+quint16 Host::getMMCPPort() {
+    return mMMCPChatPort;
+}
+
+bool Host::getMMCPAutoStartServer() {
+    return mMMCPAutostartServer;
+}
+
+bool Host::getMMCPAllowConnectionRequests() {
+    return mMMCPAllowConnectionRequests;
+}
+
+bool Host::getMMCPAllowPeekRequests() {
+    return mMMCPAllowPeekRequests;
+}
+
 QString  Host::getSpellDic()
 {
     if (!mSpellDic.isEmpty()) {

src/Host.h

@@ -68,6 +68,7 @@ class TConsole;
 class TMainConsole;
 class dlgNotepad;
 class TMap;
+class MMCPServer;
 class dlgIRC;
 class dlgPackageManager;
 class dlgModuleManager;
@@ -241,6 +242,8 @@ class Host : public QObject
 
     void incomingStreamProcessor(const QString& paragraph, int line);
     void postIrcMessage(const QString&, const QString&, const QString&);
+    void postMMCPMessage(const QString&);
+    void postChatChannelMessage(const QString&, const QString&, const QString&);
     void enableTimer(const QString&);
     void disableTimer(const QString&);
     void enableTrigger(const QString&);
@@ -325,6 +328,11 @@ class Host : public QObject
     void clearDiscordData();
     void processDiscordMSDP(const QString& variable, QString value);
     bool discordUserIdMatch(const QString& userName, const QString& userDiscriminator) const;
+    QString getMMCPChatName();
+    quint16 getMMCPPort();
+    bool getMMCPAutoStartServer();
+    bool getMMCPAllowConnectionRequests();
+    bool getMMCPAllowPeekRequests();
     void setMmpMapLocation(const QString& data);
     QString getMmpMapLocation() const;
     void setMediaLocationGMCP(const QString& mediaUrl);
@@ -420,6 +428,9 @@ class Host : public QObject
     bool showIdsInEditor() const { return mShowIDsInEditor; }
     void setShowIdsInEditor(const bool isShown) { mShowIDsInEditor = isShown; if (mpEditorDialog) {mpEditorDialog->showIDLabels(isShown);} }
 
+    void initMMCPServer();
+    void setMMCPChatName(const QString&);
+
     cTelnet mTelnet;
     QPointer<TMainConsole> mpConsole;
     dlgPackageManager* mpPackageManager;
@@ -669,6 +680,7 @@ class Host : public QObject
     dlgTriggerEditor::SearchOptions mSearchOptions;
     TConsole::SearchOptions mBufferSearchOptions;
     QPointer<dlgIRC> mpDlgIRC;
+    MMCPServer *mmcpServer;
     QPointer<dlgProfilePreferences> mpDlgProfilePreferences;
     QList<QString> mDockLayoutChanges;
     QList<QPointer<TToolBar>> mToolbarLayoutChanges;
@@ -717,6 +729,7 @@ class Host : public QObject
     void signal_controlCharacterHandlingChanged(const ControlCharacterMode);
     // Tells all command lines to save their history:
     void signal_saveCommandLinesHistory();
+    void mmcpChatNameChanged(const QString&);
 
 private slots:
     void slot_purgeTemps();
@@ -819,6 +832,12 @@ private slots:
     QString mRequiredDiscordUserName;
     QString mRequiredDiscordUserDiscriminator;
 
+    QString mMMCPChatName;
+    quint16 mMMCPChatPort;
+    bool mMMCPAutostartServer;
+    bool mMMCPAllowConnectionRequests;
+    bool mMMCPAllowPeekRequests;
+
     // Handles whether to treat 16M-Colour ANSI SGR codes which only use
     // semi-colons as separator have the initial Colour Space Id parameter
     // (true) or not (false):

src/MMCP.h

@@ -0,0 +1,91 @@
+#ifndef MUDLET_MMCP_H
+#define MUDLET_MMCP_H
+/***************************************************************************
+ *   Copyright (C) 2024 by John McKisson - john.mckisson@gmail.com         *
+ *   Copyright (C) 2024 by Stephen Lyons - slysven@virginmedia.com         *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+#include "pre_guard.h"
+#include <QFlags>
+#include "post_guard.h"
+
+inline static uint16_t csDefaultMMCPHostPort{4050};
+inline static QLatin1String csDefaultMMCPChatName{"Mudlet"};
+inline static QLatin1String csDefaultMMCPGroupName{"<none>"};
+inline static QLatin1String csMMCPChatSideChannelEvent{"sysChatChannelMessage"};
+
+enum MMCPChatCommand {
+    NameChange = 1,
+    RequestConnections = 2,
+    ConnectionList = 3,
+    TextEveryone = 4,
+    TextPersonal = 5,
+    TextGroup = 6,
+    Message = 7,
+    DoNotDisturb = 8,
+    Version = 19,
+    FileStart = 20,
+    FileDeny = 21,
+    FileBlockRequest = 22,
+    FileBlock = 23,
+    FileEnd = 24,
+    FileCancel = 25,
+    PingRequest = 26,
+    PingResponse = 27,
+    PeekConnections = 28,
+    PeekList = 29,
+    Snoop = 30,
+    SnoopData = 31,
+    SnoopColor = 32,
+    SideChannel = 33,
+    ChannelData = 240,
+    End = 255
+};
+Q_DECLARE_FLAGS(MMCPChatCommands, MMCPChatCommand)
+
+namespace AnsiColors {
+constexpr char const* RST = "\x1b[0m";
+constexpr char const* BLD = "\x1b[1m";
+constexpr char const* REV = "\x1b[7m";
+constexpr char const* FBLK = "\x1b[30m";
+constexpr char const* FRED = "\x1b[31m";
+constexpr char const* FGRN = "\x1b[32m";
+constexpr char const* FYEL = "\x1b[33m";
+constexpr char const* FBLU = "\x1b[34m";
+constexpr char const* FMAG = "\x1b[35m";
+constexpr char const* FCYN = "\x1b[36m";
+constexpr char const* FWHT = "\x1b[37m";
+constexpr char const* FBLDGRY = "\x1b[1;30m";
+constexpr char const* FBLDRED = "\x1b[1;31m";
+constexpr char const* FBLDGRN = "\x1b[1;32m";
+constexpr char const* FBLDYEL = "\x1b[1;33m";
+constexpr char const* FBLDBLU = "\x1b[1;34m";
+constexpr char const* FBLDMAG = "\x1b[1;35m";
+constexpr char const* FBLDCYN = "\x1b[1;36m";
+constexpr char const* FBLDWHT = "\x1b[1;37m";
+constexpr char const* BBLK = "\x1b[40m";
+constexpr char const* BRED = "\x1b[41m";
+constexpr char const* BGRN = "\x1b[42m";
+constexpr char const* BYEL = "\x1b[43m";
+constexpr char const* BBLU = "\x1b[44m";
+constexpr char const* BMAG = "\x1b[45m";
+constexpr char const* BCYN = "\x1b[46m";
+constexpr char const* BWHT = "\x1b[47m";
+} // namespace AnsiColors
+
+#endif // MUDLET_MMCP_H