Add JSON-RPC access to directories and server lists.

docs/JSON-RPC.md

@@ -186,6 +186,22 @@ Results:
 | result.clients | array | The client list. See jamulusclient/clientListReceived for the format. |
 
 
+### jamulusclient/pollServerList
+
+Requests server list.
+
+Parameters:
+
+| Name | Type | Description |
+| --- | --- | --- |
+| params.directory | string | URL of directory, e.g. anygenre1.jamulus.io:22124 |
+
+Results:
+
+| Name | Type | Description |
+| --- | --- | --- |
+| result | string | "ok" or "error" if invalid URL |
+
 ### jamulusclient/sendChatText
 
 Sends a chat text message.
@@ -449,6 +465,21 @@ Parameters:
 | params.clients[*].instrumentId | number | The musician’s instrument ID (see CInstPictures::GetTable). |
 
 
+### jamulusclient/serverListReceived
+
+Emitted when the server list is received.
+
+Parameters:
+
+| Name | Type | Description |
+| --- | --- | --- |
+| params.servers | array | The server list. |
+| params.servers[*].url | url | The server's URL. |
+| params.servers[*].name | string | The server’s name. |
+| params.servers[*].countryId | number | The servers’s country ID (see QLocale::Country). |
+| params.servers[*].city | string | The server’s city. |
+
+
 ### jamulusclient/connected
 
 Emitted when the client is connected to the server.

src/client.h

@@ -271,6 +271,10 @@ class CClient : public QObject
         Channel.GetBufErrorRates ( vecErrRates, dLimit, dMaxUpLimit );
     }
 
+    CProtocol * getConnLessProtocol() {
+        return &ConnLessProtocol;
+    }
+
     // settings
     CChannelCoreInfo ChannelInfo;
     QString          strClientName;

src/clientrpc.cpp

@@ -94,11 +94,67 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare
                                             } );
     } );
 
+    /// @rpc_notification jamulusclient/serverListReceived
+    /// @brief Emitted when the server list is received.
+    /// @param {array} params.servers - The server list.
+    /// @param {string} params.servers[*].url - IP Address
+    /// @param {string} params.servers[*].name - Server name
+    /// @param {number} params.servers[*].countryId - Server country code
+    /// @param {string} params.servers[*].city - Server city
+    connect ( pClient->getConnLessProtocol(), &CProtocol::CLServerListReceived, [=] ( CHostAddress /* unused */, CVector<CServerInfo> vecServerInfo ) {
+        QJsonArray arrServerInfo;
+        for ( const auto& serverInfo : vecServerInfo )
+        {
+            QJsonObject objServerInfo{
+                { "url", serverInfo.HostAddr.toString() },
+                { "name", serverInfo.strName },
+                { "countryI", serverInfo.eCountry },
+                { "city", serverInfo.strCity },
+            };
+            arrServerInfo.append ( objServerInfo );
+        }
+        pRpcServer->BroadcastNotification ( "jamulusclient/serverListReceived",
+                                            QJsonObject{
+                                                { "servers", arrServerInfo },
+                                            } );
+    } );
+
     /// @rpc_notification jamulusclient/disconnected
     /// @brief Emitted when the client is disconnected from the server.
     /// @param {object} params - No parameters (empty object).
     connect ( pClient, &CClient::Disconnected, [=]() { pRpcServer->BroadcastNotification ( "jamulusclient/disconnected", QJsonObject{} ); } );
 
+    /// @rpc_method jamulus/pollServerList
+    /// @brief Request list of servers in a directory
+    /// @param {string} params.directory - URL of directory to query, e.g. anygenre1.jamulus.io:22124.
+    /// @result {string} result - "ok" or "error" if bad arguments.
+    pRpcServer->HandleMethod ( "jamulus/pollServerList", [=] ( const QJsonObject& params, QJsonObject& response ) {
+        auto jsonDirectoryIp = params["directory"];
+        if ( !jsonDirectoryIp.isString() )
+        {
+            response["error"] = CRpcServer::CreateJsonRpcError ( CRpcServer::iErrInvalidParams, "Invalid params: directory is not a string" );
+            return;
+        }
+
+        CHostAddress haDirectoryAddress;
+        if ( NetworkUtil().ParseNetworkAddress (
+                jsonDirectoryIp.toString(),
+                haDirectoryAddress,
+                false ) )
+        {
+            // send the request for the server list
+            pClient->CreateCLReqServerListMes( haDirectoryAddress );
+            response["result"] = "ok";
+        }
+        else
+        {
+            response["error"] = CRpcServer::CreateJsonRpcError ( CRpcServer::iErrInvalidParams, "Invalid params: directory is not a valid url" );
+        }
+
+        response["result"] = "ok";
+        Q_UNUSED ( params );
+    } );
+
     /// @rpc_method jamulus/getMode
     /// @brief Returns the current mode, i.e. whether Jamulus is running as a server or client.
     /// @param {object} params - No parameters (empty object).