Control.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.Net;
using System.Net.Sockets;
using System.Text;
using System.Threading;
using SimpleJSON;
using UnityEngine;

namespace CoreLink
{

  public class Control
  {
    public static bool debug;
    public static int timeoutIterations = 100;

    private Credentials credentials;
    private Config config;

    private CorelinkTCP tcp;
    private ControlCallbacks ws;
    private CorelinkUDP udp;

    private IPAddress myIP;

    private uint receiverID;
    private List<SenderStreamParams> senderStreams;
    private List<ReceiverStreamParams> receiverStreams;
    private List<uint> allowedStreams;

    int id = 0;
    public Control() : this(false) { }
    public Control(bool debug)
    {
      senderStreams = new List<SenderStreamParams>();
      receiverStreams = new List<ReceiverStreamParams>();
      allowedStreams = new List<uint>();
      Control.debug = debug;
      receiverID = 0;
    }
    #region [Basic Usage]

    public void connect(Config config)
    {
      this.config = config;

      //tcp = new CorelinkTCP(config);

      Print("Initializing WebSocket Connection");
      ws = new ControlCallbacks(config.controlDomain);
      ConnectToServer();
      int iterations = 0;
      while (!ws.isConnectionOpen() && iterations < timeoutIterations)
      {
        Thread.Sleep(100);
        iterations++;
      }
      if (iterations == timeoutIterations)
      {
        throw new Exception("Timeout error");
      }
    }
    public async void ConnectToServer()
    {
      await ws.connect();
    }

    public bool login(Credentials credentials)
    {
      this.credentials = credentials;
      JSONNode jsonRequest = credentials.ToJSON();
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      this.credentials.Token = jsonResponse["token"].Value;
      myIP = IPAddress.Parse(jsonResponse["IP"].Value).MapToIPv4(); // client's public facing IP address (usually their router)
      int statusCode = jsonResponse["statusCode"].AsInt;
      string message = jsonResponse["message"].Value; // unused for now

      if (statusCode != 0) throw new CorelinkException(statusCode, message);

      return statusCode == 0 ? true : false;
    }


    public uint createSender(SenderStreamParams streamParams)
    {
      JSONNode jsonRequest = streamParams.toJSON();
      jsonRequest["function"] = "sender";
      jsonRequest["IP"] = myIP.ToString();
      jsonRequest["port"] = 0;
      jsonRequest["token"] = this.credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      int statusCode = jsonResponse["statusCode"].AsInt;
      uint.TryParse(jsonResponse["streamID"].Value, out streamParams.streamID);
      int udpPort = jsonResponse["port"].AsInt;
      string MTU = jsonResponse["MTU"].Value; // unused for now
      string message = jsonResponse["message"].Value; // unused for now

      if (statusCode != 0) throw new CorelinkException(statusCode, message);

      if (streamParams.proto.Equals("udp"))
      {
        if (udp == null)
        {
          Print("Attempting to open a UDP port at " + jsonResponse["port"].Value);
          udp = new CorelinkUDP(config.dataIP, udpPort, ref allowedStreams, ref receiverStreams);
        }

      }
      streamParams.port = udpPort;
      senderStreams.Add(streamParams);
      return streamParams.streamID;
    }

    public List<uint> createReceiver(ReceiverStreamParams streamParams)
    {
      if (receiverID != null)
      {
        // Update our current receiverID, not generate a new one
        streamParams.receiverid = receiverID;
      }
      JSONNode jsonRequest = streamParams.toJSON();
      jsonRequest["IP"] = myIP.ToString();
      jsonRequest["port"] = 0;
      jsonRequest["token"] = this.credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      uint.TryParse(jsonResponse["streamID"].Value, out streamParams.streamID);
      if (receiverID == 0)
      {
        receiverID = streamParams.streamID;
      }
      foreach (JSONNode node in jsonResponse["streamList"])
      {
        uint streamID = 0;
        uint.TryParse(node["streamID"].Value, out streamID);
        if (streamID == 0) throw new CorelinkException("Error parsing streamID");
        streamParams.streamIDs.Add(streamID);
        if (!allowedStreams.Contains(streamID))
        {
          allowedStreams.Add(streamID);
        }
      }

      streamParams.port = jsonResponse["port"].AsInt;
      string proto = jsonResponse["proto"].Value;
      string MTU = jsonResponse["MTU"].Value; // unused for now

      if (proto.Equals("udp"))
      {
        if (udp == null)
        {
          Print("Attempting to open a UDP port at " + jsonResponse["port"].Value);
          udp = new CorelinkUDP(config.dataIP, streamParams.port, ref allowedStreams, ref receiverStreams);
        }
        udp.receiverPing(streamParams.streamID);
      }

      receiverStreams.Add(streamParams);
      return streamParams.streamIDs;
    }

    public List<uint> subscribe(List<uint> streamIDs)
    {
      if (receiverID == null)
      {
        throw new CorelinkException("ERROR: Need to create a receiver stream before subscribing");
      }
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "subscribe";
      jsonRequest["receiverID"] = receiverID;
      for (int i = 0; i < streamIDs.Count; i++)
      {
        jsonRequest["streamID"][i] = streamIDs[i];
      }
      jsonRequest["token"] = this.credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);

      List<uint> returnedStreamids = new List<uint>();
      for (int i = 0; i < jsonResponse["streamList"].Count; i++)
      {
        uint streamID = 0;
        uint.TryParse(jsonResponse["streamList"][i]["streamID"].Value, out streamID);
        if (streamID == 0) throw new CorelinkException("Error parsing streamID");
        returnedStreamids.Add(streamID);
        allowedStreams.Add(streamID);
      }

      return returnedStreamids;
    }

    public List<uint> unsubscribe(List<string> streamIDs)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "unsubscribe";
      jsonRequest["receiverID"] = receiverStreams[0].streamID;
      jsonRequest["streamID"] = new JSONArray();
      foreach (string w in streamIDs)
      {
        jsonRequest["workspaces"].Add(w);
      }
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<uint> retval = new List<uint>();
      foreach (JSONNode f in jsonResponse["streamList"].AsArray)
      {
        uint ID = 0;
        uint.TryParse(f.Value, out ID);
        if (ID == 0) throw new CorelinkException("Error parsing streamID");
        retval.Add(ID);
      }
      return retval;
    }

    public List<string> disconnect()
    {
      StreamFilter filter = new StreamFilter();
      if (receiverStreams.Count > 0)
      {
        filter.streamIDs.Add(receiverStreams[0].streamID);
      }
      foreach (SenderStreamParams param in senderStreams)
      {
        filter.streamIDs.Add(param.streamID);
      }
      return disconnect(filter);
    }
    public List<string> disconnect(StreamFilter filter)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "disconnect";
      jsonRequest["workspaces"] = new JSONArray();
      foreach (string w in filter.workspaces)
      {
        jsonRequest["workspaces"].Add(w);
      }
      jsonRequest["types"] = new JSONArray();
      foreach (string t in filter.types)
      {
        jsonRequest["types"].Add(t);
      }
      jsonRequest["streamIDs"] = new JSONArray();
      foreach (uint s in filter.streamIDs)
      {
        jsonRequest["streamIDs"].Add(s);
      }
      if (receiverID != null)
      {
        jsonRequest["streamIDs"].Add(receiverID);
      }
      jsonRequest["token"] = this.credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<string> retval = new List<string>();
      foreach (JSONNode f in jsonResponse["streamList"].AsArray)
      {
        retval.Add(f.Value);
      }
      return retval;
    }

    public void exit()
    {
      // TODO: Check if all streamIDs are fetched successfully
      disconnect();
      ws.stopConnection();
      if (udp != null) udp.stopConnection();
    }

    public void send(uint streamID, byte[] header, byte[] data)
    {
      if (udp == null)
      {
        throw new Exception("udp connection not created");
      }
      udp.send(streamID, header, data);
    }

    #endregion

    #region [Workspace Functions]
    public bool addWorkspace(string workspace)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "addWorkspace";
      jsonRequest["workspace"] = workspace;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      int statusCode = jsonResponse["statusCode"].AsInt;
      return statusCode == 0 ? true : false;
    }

    public bool rmWorkspace(string workspace)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "rmWorkspace";
      jsonRequest["workspace"] = workspace;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      int statusCode = jsonResponse["statusCode"].AsInt;
      return statusCode == 0 ? true : false;
    }

    public bool setDefaultWorkspace(string workspace)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "setDefaultWorkspace";
      jsonRequest["workspace"] = workspace;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      int statusCode = jsonResponse["statusCode"].AsInt;
      return statusCode == 0 ? true : false;
    }

    public string getDefaultWorkspace()
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "getDefaultWorkspace";
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      return jsonResponse["workspace"].Value;
    }

    public List<string> listWorkspaces()
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "listWorkspaces";
      jsonRequest["token"] = this.credentials.Token;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<string> retval = new List<string>();
      foreach (JSONNode f in jsonResponse["workspaceList"].AsArray)
      {
        retval.Add(f.Value);
      }
      return retval;
    }

    #endregion

    #region [Function Helpers]

    public List<string> listFunctions()
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "listFunctions";
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<string> retval = new List<string>();
      foreach (JSONNode f in jsonResponse["functionList"].AsArray)
      {
        retval.Add(f.Value);
      }
      return retval;
    }

    public List<string> listServerFunctions()
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "listServerFunctions";
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<string> retval = new List<string>();
      foreach (JSONNode f in jsonResponse["functionList"].AsArray)
      {
        retval.Add(f.Value);
      }
      return retval;
    }

    public string describeFunction(string function)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "describeFunction";
      jsonRequest["functionName"] = function;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      return jsonResponse["description"].Value;

    }

    public string describeServerFunction(string function)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "describeServerFunction";
      jsonRequest["functionName"] = function;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      return jsonResponse["description"].Value;
    }

    #endregion

    #region [Stream Info]

    public JSONArray listStreams(StreamFilter filter)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "listStreams";
      jsonRequest["workspaces"] = new JSONArray();
      foreach (string w in filter.workspaces)
      {
        jsonRequest["workspaces"].Add(w);
      }
      jsonRequest["types"] = new JSONArray();
      foreach (string t in filter.types)
      {
        jsonRequest["types"].Add(t);
      }
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      return jsonResponse["senderList"].AsArray;
    }
    public JSONNode streamInfo(uint streamID)
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "streamInfo";
      jsonRequest["workspaces"] = new JSONArray();
      jsonRequest["streamID"] = streamID;
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      return jsonResponse;

    }

    #endregion

    #region [User Functions]
    public List<string> listUsers()
    {
      JSONNode jsonRequest = JSON.Parse("{}");
      jsonRequest["function"] = "streamInfo";
      jsonRequest["token"] = credentials.Token;
      jsonRequest["ID"] = id;
      string request = jsonRequest.ToString();
      JSONNode jsonResponse = SendAndErrorCheck(request, id++);
      List<string> retval = new List<string>();
      foreach (JSONNode f in jsonResponse["userList"].AsArray)
      {
        retval.Add(f.Value);
      }
      return retval;
    }

    #endregion
    // TODO: keepAlive, password, rmUser, listUsers, addGroup, addUserGroup, rmUserGroup, changeOwner, rmGroup, listGroups, setConfig, expire, 


    #region [Utility]
    JSONNode SendAndErrorCheck(string request, int id)
    {
      Print("Request:\t" + request);
      ws.sendMessage(request);
      string response = ws.getResponse();

      Print("Response: " + response);
      JSONNode jsonResponse = JSON.Parse(response);
      int statusCode = jsonResponse["statusCode"].AsInt;
      int receivedID = jsonResponse["ID"].AsInt;
      string message = jsonResponse["message"].Value;
      if (receivedID != id)
      {
        throw new CorelinkException("Wrong ID");
      }
      if (statusCode != 0) throw new CorelinkException(statusCode, message);
      return jsonResponse;
    }
    public static void Print(string message)
    {
      if (debug) Debug.Log(message);
    }
    #endregion
  }
}