first cut at Wifi console, missing files

tve · Dec 20, 2015 · 8e48063 · 8e48063
1 parent e5f9db8
commit 8e48063
Show file tree

Hide file tree

Showing 2 changed files with 297 additions and 0 deletions.
diff --git a/libs/network/telnet/jswrap_telnet.c b/libs/network/telnet/jswrap_telnet.c
@@ -0,0 +1,269 @@
+/*
+ * This file is part of Espruino, a JavaScript interpreter for Microcontrollers
+ *
+ * Copyright (C) 2015 Thorsten von Eicken
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * ----------------------------------------------------------------------------
+ * This file is designed to be parsed during the build process
+ *
+ * Contains JavaScript Telnet console
+ * ----------------------------------------------------------------------------
+ */
+#include "jswrap_net.h"
+#include "jswrap_http.h"
+#include "jsvariterator.h"
+#include "jsinteractive.h"
+#include "socketserver.h"
+
+#include "../network.h"
+
+#if defined(ESP8266)
+extern int os_printf_plus(const char *format, ...)  __attribute__((format(printf, 1, 2)));
+#define printf os_printf_plus
+//#elif defined(LINUX)
+//#define printf printf
+#else
+#define printf(X, ...) do{}while(0)
+#endif
+
+#ifdef LINUX
+#define PORT 2323 // avoid needing root permissions
+#else
+#define PORT 23
+#endif
+
+// Forward function declarations
+
+void telnetStart(JsNetwork *net);
+void telnetStop(JsNetwork *net);
+bool telnetAccept(JsNetwork *net);
+bool telnetSendBuf(JsNetwork *net);
+bool telnetRecv(JsNetwork *net);
+
+// Telnet console data structures
+
+#define MODE_OFF 0    // telnet console is off
+#define MODE_ON  1    // telnet console is on
+
+#define TX_CHUNK 1024   // size of chunks read from JS, buffered, and sent on socket
+
+// Data structure for a telnet console server
+typedef struct {
+  int       sock;             // listening server socket, 0=none
+  int       cliSock;          // active client socket, 0=none
+  char      txBuf[TX_CHUNK];  // transmit buffer
+  uint16_t  txBufLen;         // number of chars in tx buffer
+} TelnetServer;
+
+static TelnetServer tnSrv;        // the telnet server, only one right now
+static uint8_t      tnSrvMode;    // current mode for the telnet server
+
+/*JSON{
+  "type"  : "library",
+  "class" : "Telnet"
+}
+This library implements a telnet console for the Espruino interpreter. It requires a network
+connection, e.g. Wifi, and **current is only available on the ESP8266**.
+*/
+
+/*JSON{
+  "type"     : "staticmethod",
+  "class"    : "Telnet",
+  "name"     : "setOptions",
+  "generate" : "jswrap_telnet_setOptions",
+  "params": [
+    [ "options", "JsVar", "Options controlling the telnet console server" ]
+  ]
+}
+*/
+void jswrap_telnet_setOptions(JsVar *jsOptions) {
+  // Make sure jsOptions is an object
+  if (!jsvIsObject(jsOptions)) {
+    jsExceptionHere(JSET_ERROR, "Expecting options object but got %t", jsOptions);
+    return;
+  }
+
+  // Get mode
+  JsVar *jsMode = jsvObjectGetChild(jsOptions, "mode", 0);
+  if (jsvIsString(jsMode)) {
+    if (jsvIsStringEqual(jsMode, "on")) {
+      if (tnSrvMode != MODE_ON) {
+        memset(&tnSrv, 0, sizeof(TelnetServer));
+        tnSrvMode = MODE_ON;
+        JsNetwork net;
+        if (networkGetFromVarIfOnline(&net)) {
+          telnetStart(&net);
+        }
+      }
+    } else if (jsvIsStringEqual(jsMode, "off")) {
+      if (tnSrvMode != MODE_OFF) {
+        JsNetwork net;
+        if (networkGetFromVarIfOnline(&net)) {
+          telnetStop(&net);
+        }
+        tnSrvMode = MODE_OFF;
+      }
+    } else {
+      jsvUnLock(jsMode);
+      jsExceptionHere(JSET_ERROR, "Unknown mode value");
+      return;
+    }
+  }
+  jsvUnLock(jsMode);
+}
+
+/*JSON{
+  "type"     : "init",
+  "class"    : "Telnet",
+  "generate" : "jswrap_telnet_init"
+}
+*/
+void jswrap_telnet_init(void) {
+
+}
+
+/*JSON{
+  "type"     : "kill",
+  "class"    : "Telnet",
+  "generate" : "jswrap_telnet_kill"
+}
+*/
+void jswrap_telnet_kill(void) {
+
+}
+
+/*JSON{
+  "type"     : "idle",
+  "class"    : "Telnet",
+  "generate" : "jswrap_telnet_idle"
+}
+*/
+bool jswrap_telnet_idle(void) {
+  JsNetwork net;
+  if (!networkGetFromVarIfOnline(&net)) return false;
+
+  bool active = false;
+  active |= telnetAccept(&net);
+  active |= telnetRecv(&net);
+  active |= telnetSendBuf(&net);
+  //if (active) printf("tnSrv: idle=%d\n", active);
+
+  networkFree(&net);
+  return active;
+}
+
+//===== Internal functions
+
+// Start the listening socket for the telnet console server.
+void telnetStart(JsNetwork *net) {
+  // create the listening socket
+  printf("tnSrv: creating...\n");
+  int sock = netCreateSocket(net, 0, PORT, NCF_NORMAL, NULL);
+  if (sock == 0) {
+    printf("tnSrv: cannot create listening socket\n");
+    return;
+  }
+  tnSrv.sock = sock;
+  printf("tnSrv: started sock=%d\n", sock);
+}
+
+// Terminate the telnet console
+void telnetStop(JsNetwork *net) {
+  printf("tnSrv: stopped sock=%d\n", tnSrv.sock);
+  if (tnSrv.cliSock != 0) netCloseSocket(net, tnSrv.cliSock);
+  tnSrv.cliSock = 0;
+  if (tnSrv.sock != 0) netCloseSocket(net, tnSrv.sock);
+  tnSrv.sock = 0;
+}
+
+// Attempt to accept a connection, returns true if it did something
+bool telnetAccept(JsNetwork *net) {
+  // we're gonna do a single accept per idle iteration for now
+  if (tnSrv.sock == 0) return false;
+  int sock = netAccept(net, tnSrv.sock);
+  if (sock < 0) return false; // nothing
+
+  // if we already have a client, then disconnect it
+  if (tnSrv.cliSock != 0) {
+    netCloseSocket(net, tnSrv.cliSock);
+  }
+  jsiSetConsoleDevice(EV_TELNET);
+
+  tnSrv.cliSock = sock;
+  printf("tnSrv: accepted console on sock=%d\n", sock);
+  return true;
+}
+
+// Close the connection and release the console device
+void telnetRelease(JsNetwork *net) {
+  if (!(tnSrv.sock && tnSrv.cliSock)) return;
+  printf("tnSrv: released console from sock %d\n", tnSrv.cliSock);
+  netCloseSocket(net, tnSrv.cliSock);
+  tnSrv.cliSock = 0;
+  jsiSetConsoleDevice( DEFAULT_CONSOLE_DEVICE );
+}
+
+// Attempt to send buffer on an established client connection, returns true if it sent something
+bool telnetSendBuf(JsNetwork *net) {
+  if (tnSrv.sock == 0 || tnSrv.cliSock == 0) return false;
+
+  // if we have nothing buffered, that's it
+  if (tnSrv.txBufLen == 0) return false;
+
+  // try to send the tx buffer
+  int sent = netSend(net, tnSrv.cliSock, tnSrv.txBuf, tnSrv.txBufLen);
+  if (sent == tnSrv.txBufLen) {
+    tnSrv.txBufLen = 0;
+  } else if (sent > 0) {
+    // shift remaining chars up in the buffer
+    memmove(tnSrv.txBuf, tnSrv.txBuf+sent, (size_t)(tnSrv.txBufLen-sent));
+    tnSrv.txBufLen -= (uint16_t)sent;
+  } else if (sent < 0) {
+    telnetRelease(net);
+  }
+  if (sent != 0) {
+    //printf("tnSrv: sent sock=%d, %d bytes, %d left\n", tnSrv.sock, sent, tnSrv.txBufLen);
+  }
+  return sent != 0;
+}
+
+void telnetSendChar(char ch) {
+  if (tnSrv.sock == 0 || tnSrv.cliSock == 0) return;
+  if (tnSrv.txBufLen >= TX_CHUNK) {
+    // buffer overflow :-(
+    printf("tnSrv: send overflow!\n");
+    return;
+  }
+  tnSrv.txBuf[tnSrv.txBufLen++] = ch;
+
+  // if the buffer has a bunch of chars then try to send, else it'll happen
+  // at idle time.
+  if (tnSrv.txBufLen < TX_CHUNK/4) return;
+  JsNetwork net;
+  if (!networkGetFromVarIfOnline(&net)) return;
+  telnetSendBuf(&net);
+  networkFree(&net);
+}
+
+// Attempt to receive on an established client connection, returns true if it received something
+bool telnetRecv(JsNetwork *net) {
+  if (tnSrv.sock == 0 || tnSrv.cliSock == 0) return false;
+
+  char buff[256];
+  int r = netRecv(net, tnSrv.cliSock, buff, 256);
+  if (r > 0) {
+    jshPushIOCharEvents(EV_TELNET, buff, r);
+  } else if (r < 0) {
+    telnetRelease(net);
+  }
+  if (r != 0) {
+    //printf("tnSrv: recv sock=%d, %d bytes\n", tnSrv.sock, r);
+  }
+  return r != 0;
+}
+
+
diff --git a/libs/network/telnet/jswrap_telnet.h b/libs/network/telnet/jswrap_telnet.h
@@ -0,0 +1,28 @@
+/*
+ * This file is part of Espruino, a JavaScript interpreter for Microcontrollers
+ *
+ * Copyright (C) 2013 Thorsten von Eicken
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * ----------------------------------------------------------------------------
+ * Contains JavaScript HTTP Functions
+ * ----------------------------------------------------------------------------
+ */
+#ifndef LIBS_NETWORK_TELNET_H_
+#define LIBS_NETWORK_TELNET_H_
+
+#include "jsvar.h"
+
+void jswrap_telnet_setOptions(JsVar *options);
+
+void jswrap_telnet_init(void);
+void jswrap_telnet_kill(void);
+
+// Listen, accept, send, and recv on telnet console connections. Returns true if something
+// was done.
+bool jswrap_telnet_idle(void);
+
+#endif