main-virtualmonitor: Make options optional and add reasonable defaults

Allows using krfb-virtualmonitor by itself or with any mixture of options. If no password is provided, the VNC server doesn't start

BUG: 497071

krfb/main-virtualmonitor.cpp

@@ -105,15 +105,39 @@ int main(int argc, char *argv[])
 
     QCommandLineParser parser;
     aboutData.setupCommandLine(&parser);
-    const QCommandLineOption resolutionOption({ QStringLiteral("resolution") }, i18n("Logical resolution of the new monitor"), i18n("resolution"));
+
+    const QCommandLineOption resolutionOption(
+        { QStringLiteral("resolution") },
+        i18n("Logical resolution of the new monitor"),
+        i18n("resolution"),
+        QStringLiteral("1920x1080"));
     parser.addOption(resolutionOption);
-    const QCommandLineOption nameOption({ QStringLiteral("name") }, i18n("Name of the monitor"), i18n("name"));
+
+    const QCommandLineOption nameOption(
+        { QStringLiteral("name") },
+        i18n("Name of the monitor"),
+        i18n("name"),
+        QStringLiteral("Monitor"));
     parser.addOption(nameOption);
-    const QCommandLineOption passwordOption({ QStringLiteral("password") }, i18n("Password for the client to connect to it"), i18n("password"));
+
+    const QCommandLineOption passwordOption(
+        { QStringLiteral("password") },
+        i18n("Password for the client to connect to it"),
+        i18n("password"));
     parser.addOption(passwordOption);
-    const QCommandLineOption scaleOption({ QStringLiteral("scale") }, i18n("The device-pixel-ratio of the device, the scaling factor"), i18n("dpr"), QStringLiteral("1"));
+
+    const QCommandLineOption scaleOption(
+        { QStringLiteral("scale") },
+        i18n("The device-pixel-ratio of the device, the scaling factor"),
+        i18n("dpr"),
+        QStringLiteral("1"));
     parser.addOption(scaleOption);
-    const QCommandLineOption portOption({ QStringLiteral("port") }, i18n("The port we will be listening to"), i18n("number"), QStringLiteral("9999"));
+
+    const QCommandLineOption portOption(
+        { QStringLiteral("port") },
+        i18n("The port we will be listening to"),
+        i18n("number"),
+        QStringLiteral("5900"));
     parser.addOption(portOption);
 
     parser.process(app);
@@ -122,44 +146,26 @@ int main(int argc, char *argv[])
     app.setQuitOnLastWindowClosed(false);
 
     if (!KWindowSystem::isPlatformWayland()) {
-        qCritical() << "Virtual Monitors are only supported on Wayland";
+        qCritical() << "Virtual Monitors are only supported on Wayland.";
         return 1;
     }
-    if (!parser.isSet(nameOption)) {
-        qCritical() << "error: please define --name";
-        return 2;
-    } else {
-        if (!parser.isSet(passwordOption)) {
-            qCritical() << "error: please define --password";
-            return 3;
-        }
-        if (!parser.isSet(resolutionOption)) {
-            qCritical() << "error: please define --resolution";
-            return 4;
-        }
-    }
-    if (!parser.isSet(portOption)) {
-        qCritical() << "error: please define --port";
-        return 5;
-    }
     const QString res = parser.value(resolutionOption);
     const auto resSplit = res.split(QLatin1Char('x'));
-    if (resSplit.size() != 2) {
+    const QSize size = { resSplit[0].toInt(), resSplit[1].toInt() };
-        qCritical() << "error: the resolution should be formatted as WIDTHxHEIGHT (e.g. --resolution 1920x1080)";
+    if (resSplit.size() != 2 || size.isEmpty()) {
-        return 6;
+        qCritical() << "The resolution should be formatted as WIDTHxHEIGHT (e.g. --resolution 1920x1080).";
+        return 2;
     }
 
-
+    RfbServerManager::s_pluginArgs = {
-    if (parser.isSet(nameOption)) {
+        { QStringLiteral("name"), parser.value(nameOption) },
-        RfbServerManager::s_pluginArgs = {
+        { QStringLiteral("resolution"), size },
-            { QStringLiteral("name"), parser.value(nameOption) },
+        { QStringLiteral("scale"), parser.value(scaleOption).toDouble() },
-            { QStringLiteral("resolution"), QSize(resSplit[0].toInt(), resSplit[1].toInt()) },
+    };
-            { QStringLiteral("scale"), parser.value(scaleOption).toDouble() },
-        };
-    }
 
     VirtualMonitorRfbServer server;
     server.setPasswordRequired(true);
+    server.setPasswordSet(!parser.value(passwordOption).isEmpty());
     server.setListeningPort(parser.value(portOption).toInt());
     PendingVirtualMonitorRfbClient::password = parser.value(passwordOption).toUtf8();
 
@@ -168,7 +174,8 @@ int main(int argc, char *argv[])
     sigaddset(&sigs, SIGPIPE);
     sigprocmask(SIG_BLOCK, &sigs, nullptr);
     if (!server.start()) {
-        return 1;
+        qCritical() << "Could not start the VNC server.";
+        return 3;
     }
 
     return app.exec();

krfb/rfbserver.cpp

@@ -20,6 +20,7 @@ struct RfbServer::Private
     QByteArray listeningAddress;
     int listeningPort;
     bool passwordRequired;
+    bool passwordSet;
     rfbScreenInfoPtr screen;
     QPointer<QSocketNotifier> ipv4notifier;
     QPointer<QSocketNotifier> ipv6notifier;
@@ -31,6 +32,7 @@ RfbServer::RfbServer(QObject *parent)
     d->listeningAddress = "0.0.0.0";
     d->listeningPort = 0;
     d->passwordRequired = true;
+    d->passwordSet = false;
     d->screen = nullptr;
 
     RfbServerManager::instance()->registerServer(this);
@@ -61,6 +63,11 @@ bool RfbServer::passwordRequired() const
     return d->passwordRequired;
 }
 
+bool RfbServer::passwordSet() const
+{
+    return d->passwordSet;
+}
+
 void RfbServer::setListeningAddress(const QByteArray& address)
 {
     d->listeningAddress = address;
@@ -76,6 +83,11 @@ void RfbServer::setPasswordRequired(bool passwordRequired)
     d->passwordRequired = passwordRequired;
 }
 
+void RfbServer::setPasswordSet(bool passwordSet)
+{
+    d->passwordSet = passwordSet;
+}
+
 bool RfbServer::start()
 {
     if (!d->screen) {
@@ -98,42 +110,44 @@ bool RfbServer::start()
         rfbShutdownServer(d->screen, false);
     }
 
-    if (listeningAddress() != "0.0.0.0") {
+    if (passwordSet()) {
-        strncpy(d->screen->thisHost, listeningAddress().constData(), 254);
+        if (listeningAddress() != "0.0.0.0") {
-    }
+            strncpy(d->screen->thisHost, listeningAddress().constData(), 254);
+        }
 
-    if (listeningPort() == 0) {
+        if (listeningPort() == 0) {
-        d->screen->autoPort = 1;
+            d->screen->autoPort = 1;
-    }
+        }
 
-    d->screen->port = listeningPort();
+        d->screen->port = listeningPort();
-    d->screen->ipv6port = listeningPort();
+        d->screen->ipv6port = listeningPort();
 
-    // Disable/Enable password checking
+        // Disable/Enable password checking
-    if (passwordRequired()) {
+        if (passwordRequired()) {
-        d->screen->authPasswdData = (void *)1;
+            d->screen->authPasswdData = (void *)1;
-    } else {
+        } else {
-        d->screen->authPasswdData = (void *)nullptr;
+            d->screen->authPasswdData = (void *)nullptr;
-    }
+        }
 
-    qCDebug(KRFB) << "Starting server. Listen port:" << listeningPort()
+        qCDebug(KRFB) << "Starting server. Listen port:" << listeningPort()
-             << "Listen Address:" << listeningAddress()
+                 << "Listen Address:" << listeningAddress()
-             << "Password enabled:" << passwordRequired();
+                 << "Password enabled:" << passwordRequired();
 
-    rfbInitServer(d->screen);
+        rfbInitServer(d->screen);
 
-    if (!rfbIsActive(d->screen)) {
+        if (!rfbIsActive(d->screen)) {
-        qCDebug(KRFB) << "Failed to start server";
+            qCDebug(KRFB) << "Failed to start server";
-        rfbShutdownServer(d->screen, false);
+            rfbShutdownServer(d->screen, false);
-        return false;
+            return false;
-    };
+        };
 
-    d->ipv4notifier = new QSocketNotifier(d->screen->listenSock, QSocketNotifier::Read, this);
+        d->ipv4notifier = new QSocketNotifier(d->screen->listenSock, QSocketNotifier::Read, this);
-    connect(d->ipv4notifier, &QSocketNotifier::activated, this, &RfbServer::onListenSocketActivated);
+        connect(d->ipv4notifier, &QSocketNotifier::activated, this, &RfbServer::onListenSocketActivated);
-    if (d->screen->listen6Sock > 0) {
+        if (d->screen->listen6Sock > 0) {
-        // we're also listening on additional IPv6 socket, get events from there
+            // we're also listening on additional IPv6 socket, get events from there
-        d->ipv6notifier = new QSocketNotifier(d->screen->listen6Sock, QSocketNotifier::Read, this);
+            d->ipv6notifier = new QSocketNotifier(d->screen->listen6Sock, QSocketNotifier::Read, this);
-        connect(d->ipv6notifier, &QSocketNotifier::activated, this, &RfbServer::onListenSocketActivated);
+            connect(d->ipv6notifier, &QSocketNotifier::activated, this, &RfbServer::onListenSocketActivated);
+        }
     }
 
     if (QX11Info::isPlatformX11()) {

krfb/rfbserver.h

@@ -23,10 +23,12 @@ public:
     QByteArray listeningAddress() const;
     int listeningPort() const;
     bool passwordRequired() const;
+    bool passwordSet() const;
 
     void setListeningAddress(const QByteArray & address);
     void setListeningPort(int port);
     void setPasswordRequired(bool passwordRequired);
+    void setPasswordSet(bool passwordSet);
 
 public Q_SLOTS:
     virtual bool start();