From e17bf7ed8d01e48100100d4fea02cec478bb22f9 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Ji=C5=99=C3=AD=20Mat=C4=9Bj=C3=A1k?=
 <jiri.matejak@fel.cvut.cz>
Date: Thu, 26 Apr 2018 19:37:27 +0200
Subject: [PATCH] doc, cleaning, no per session data

---
 Makefile                          | 21 ++++++----
 html/index.html                   |  2 +-
 mtps.c => mt_ps.c                 |  3 +-
 mt_rfid.c                         | 68 +++++++++++--------------------
 mt_rfid.h                         | 32 +++++++--------
 mt_server.c                       | 61 +++++++++++++--------------
 mt_server.h                       | 23 +++++++++--
 ev_signal_exit.c => signal_exit.c |  4 +-
 ev_signal_exit.h => signal_exit.h |  1 +
 9 files changed, 104 insertions(+), 111 deletions(-)
 rename mtps.c => mt_ps.c (90%)
 rename ev_signal_exit.c => signal_exit.c (86%)
 rename ev_signal_exit.h => signal_exit.h (80%)

diff --git a/Makefile b/Makefile
index de47755..5c1e71a 100644
--- a/Makefile
+++ b/Makefile
@@ -1,15 +1,20 @@
-all: mt-rfid mt-server mt-ps
+OUTPUT_DIR = build
 
-mt-rfid: $(SOURCE_FILES)
-	$(CC) $(CFLAGS) -DIS_MAIN -o mt_rfid mt_rfid.c ev_signal_exit.c -lev -luFCoder-armhf
+all: mtrfid mtserver mtps
 
-mt-server: mt_server.c
-	$(CC) $(CFLAGS) -DIS_MAIN -o mt-server mt_server.c ev_signal_exit.c -lev -lwebsockets
+mtrfid: mt_rfid.c
+	mkdir -p $(OUTPUT_DIR)
+	$(CC) $(CFLAGS) -DIS_MAIN -o $(OUTPUT_DIR)/mtrfid mt_rfid.c signal_exit.c -lev -luFCoder-armhf
 
-mt-ps: mtps.c mt_rfid.c mt_server.c
-	$(CC) $(CFLAGS) -o mt-ps mtps.c mt_rfid.c mt_server.c ev_signal_exit.c -lev -luFCoder-armhf -lwebsockets
+mtserver: mt_server.c
+	mkdir -p $(OUTPUT_DIR)
+	$(CC) $(CFLAGS) -DIS_MAIN -o $(OUTPUT_DIR)/mtserver mt_server.c signal_exit.c -lev -lwebsockets
+
+mtps: mt_ps.c mt_rfid.c mt_server.c
+	mkdir -p $(OUTPUT_DIR)
+	$(CC) $(CFLAGS) -o $(OUTPUT_DIR)/mtps mt_ps.c mt_rfid.c mt_server.c signal_exit.c -lev -luFCoder-armhf -lwebsockets
 
 .PHONY: clean
 
 clean:
-	rm -f mt-*
+	rm -rf $(OUTPUT_DIR)
diff --git a/html/index.html b/html/index.html
index e5aa108..ee76379 100644
--- a/html/index.html
+++ b/html/index.html
@@ -5,7 +5,7 @@
 <script>
     var socket = new WebSocket(
         "ws://" + document.domain + ':' + location.port,
-        "dumb-increment-protocol"
+        "merica-terminal-protocol"
     );
 
     function update(id, msg) {
diff --git a/mtps.c b/mt_ps.c
similarity index 90%
rename from mtps.c
rename to mt_ps.c
index 21f3686..bd38ee6 100644
--- a/mtps.c
+++ b/mt_ps.c
@@ -1,6 +1,7 @@
+// merica terminal peripheral server
 #include "mt_rfid.h"
 #include "mt_server.h"
-#include "ev_signal_exit.h"
+#include "signal_exit.h"
 
 int main(int argc, char **argv)
 {
diff --git a/mt_rfid.c b/mt_rfid.c
index 1954b02..5296b3b 100644
--- a/mt_rfid.c
+++ b/mt_rfid.c
@@ -1,11 +1,3 @@
-/**
- * mt_rfid.c
- */
-
-// shit to avoid constant repetition
-#define CONCAT_AGAIN(A,B) A ## B
-#define CONCAT(A,B) CONCAT_AGAIN(A,B)
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -16,7 +8,11 @@
 #include <uFCoder.h>
 
 #include "mt_rfid.h"
-#include "ev_signal_exit.h"
+#include "signal_exit.h"
+
+// shit to avoid constant repetition
+#define CONCAT_AGAIN(A,B) A ## B
+#define CONCAT(A,B) CONCAT_AGAIN(A,B)
 
 static int set_nonblock(int fd)
 {
@@ -68,7 +64,7 @@ static void set_baud_rate(int fd, int br) //TODO add some checking
     tcsetattr(fd, TCSANOW, &options);
 }
 
-static int tty_open(const char *port, int baud_rate)
+static int tty_open(const char *port, int br)
 {
 
     int fd = open(port, O_RDONLY | O_NOCTTY);
@@ -80,9 +76,9 @@ static int tty_open(const char *port, int baud_rate)
     }
 
     set_nonblock(fd);
-    set_rts(fd, 0);
-    set_baud_rate(fd, baud_rate);
-    usleep(1200000); //value by d-logic
+    set_rts(fd, 0);        //disable
+    set_baud_rate(fd, br);
+    usleep(1200000);       //value by d-logic
     tcflush(fd, TCIFLUSH);
 
     return fd;
@@ -90,9 +86,9 @@ static int tty_open(const char *port, int baud_rate)
 
 // really simple JSON helpers
 #define JSON_START()   dprintf(fd,"{")
-#define JSON_NUM(NAME) dprintf(fd,"\"" #NAME "\": %d", NAME)
+#define JSON_NUM(NAME) dprintf(fd,"\"" #NAME "\":%d", NAME) //see the int?
 #define JSON_NEXT()    dprintf(fd,",")
-#define JSON_STR(NAME) dprintf(fd,"\"" #NAME "\": \"%s\"", NAME)
+#define JSON_STR(NAME) dprintf(fd,"\"" #NAME "\":\"%s\"", NAME)
 #define JSON_END()     dprintf(fd,"}\n")
 
 // print complete json
@@ -139,15 +135,18 @@ static void ufr_read(char *uid, int fd)
 #endif
 }
 
+#define UFR_ASYNC_SUFFIX 0 // keep it zero: separates uids, terminates strings
+
 static void ufr_cb(EV_P_ ev_io *w_, int revents)
 {
     ev_io_ufr *w = (ev_io_ufr *)w_;
     char uid;
+
     read(w->w.fd, &uid, 1);
     *(w->uid++) = uid;
 
-    if (uid == ASYNC_SUFFIX) {
-        //*(w->uid - 1) = 0; // no need if ASYNC_SUFFIX is 0
+    if (uid == UFR_ASYNC_SUFFIX) {
+        //*(w->uid - 1) = 0; // no need if UFR_ASYNC_SUFFIX is 0
         w->uid = w->uid_data;
         ufr_read(w->uid, w->fd);
     }
@@ -169,12 +168,12 @@ static int ufr_open(unsigned reader_type, char *port_name,
     fprintf(stderr, "%s\n", GetReaderDescription());
 
     status = SetAsyncCardIdSendConfig(
-                 1,            //enable send
-                 0,            //disable prefix
-                 0,            //prefix
-                 ASYNC_SUFFIX, //suffix
-                 0,            //disable send removed
-                 ASYNC_BAUD_RATE
+                 1,                  //enable send
+                 0,                  //disable prefix
+                 0,                  //prefix
+                 UFR_ASYNC_SUFFIX,   //suffix
+                 0,                  //disable send removed
+                 UFR_ASYNC_BAUD_RATE
              );
     fprintf(stderr, "SetAsyncCardIdSendConfig: %s\n", UFR_Status2String(status));
     if (status != UFR_OK) {
@@ -186,11 +185,11 @@ static int ufr_open(unsigned reader_type, char *port_name,
 
 int mt_rfid_init(mt_rfid_t *self, struct ev_loop *loop, int fd)
 {
-    if (ufr_open(READER_TYPE, PORT_NAME, PORT_INTERFACE) == -1) {
+    if (ufr_open(UFR_READER_TYPE, UFR_PORT_NAME, UFR_PORT_INTERFACE) == -1) {
         return -1;
     }
 
-    int tty = tty_open(PORT_NAME, CONCAT(B, ASYNC_BAUD_RATE));
+    int tty = tty_open(UFR_PORT_NAME, CONCAT(B, UFR_ASYNC_BAUD_RATE));
     if (tty < 0) {
         return -2;
     }
@@ -236,22 +235,3 @@ int main(int argc, char **argv)
     return 0;
 }
 #endif
-
-/* other tty options
-    //Enable the receiver and set local mode...
-    options.c_cflag |= (CLOCAL | CREAD);
-
-    options.c_cflag &= ~PARENB;
-    options.c_cflag &= ~CSTOPB;
-    options.c_cflag &= ~CSIZE;
-    options.c_cflag |= CS8;
-    options.c_cflag &= ~CRTSCTS;
-    options.c_lflag |= (ICANON | ECHO | ECHOE);
-    //Disable XON/XOFF both i/p and o/p
-    options.c_iflag &= ~(IXON | IXOFF | IXANY);
-    //Non Cannon mode
-    options.c_iflag &= ~(ICANON | ECHO | ECHOE | ISIG);
-
-    options.c_oflag |= OPOST;
-*/
-
diff --git a/mt_rfid.h b/mt_rfid.h
index 2c98dd7..7dfa6c9 100644
--- a/mt_rfid.h
+++ b/mt_rfid.h
@@ -1,36 +1,32 @@
-/**
- * mt_rfid.h
- */
-
 #ifndef MT_RFID_H
 #define MT_RFID_H
 
 #include <ev.h>
 
 // reader open parameters, see uFR manual
-#define READER_TYPE    1 // uFR type (1Mbps)
-#define PORT_INTERFACE 1 // serial, auto -> ftdi -> FAIL (some shity drivers missing)
-#define PORT_NAME "/dev/ttyUSB0"
-
-// async uid sending parameters
-#define ASYNC_SUFFIX            0 // keep it zero: + separates uids, + terminates strings
-#define ASYNC_BAUD_RATE   1000000 // 1Mbps, otherwise UFR_COMMUNICATION_BREAK
+#define UFR_READER_TYPE     1       // uFR type (1Mbps)
+#define UFR_PORT_INTERFACE  1       // serial; auto->ftdi->FAIL
+#define UFR_PORT_NAME       "/dev/ttyUSB0" // reader device
+#define UFR_ASYNC_BAUD_RATE 1000000 // 1Mbps, otherwise UFR_COMMUNICATION_BREAK
 
-//#define UFR_BEEP // define this to annoy people
+#define UFR_BEEP // define this to annoy people
 
 typedef struct ev_io_ufr {
-    ev_io w;
-    char uid_data[24]; // this is enough (10 bytes max)
-    char *uid;
-    int fd;
+    ev_io w;           // fd watcher
+    char uid_data[24]; // store uid here (uid is 10 bytes max)
+    char *uid;         // current position in uid_data
+    int fd;            // PORT_NAME file descriptor
 } ev_io_ufr;
 
 typedef struct mt_rfid_t {
-    ev_io_ufr w;
-    int fd;
+    ev_io_ufr w; // reader watcher
+    int fd;      // print JSON output here
 } mt_rfid_t;
 
+// connect to the reader, add self to loop and make it write to fd
 int mt_rfid_init(mt_rfid_t *self, struct ev_loop *loop, int fd);
+
+// disconnect from reader
 void mt_rfid_deinit(mt_rfid_t *self);
 
 #endif
diff --git a/mt_server.c b/mt_server.c
index 76485d7..d294cfa 100644
--- a/mt_server.c
+++ b/mt_server.c
@@ -3,15 +3,13 @@
 #include <string.h>
 
 #include "mt_server.h"
-#include "ev_signal_exit.h"
-
-#define JSON_EMPTY "{\"type\":\"empty\"}"
+#include "signal_exit.h"
 
 static const struct lws_http_mount mount = {
     /* .mount_next */            NULL,         /* linked-list "next" */
-    /* .mountpoint */            "/",          /* mountpoint URL */
-    /* .origin */                "/usr/share/mt-server", /* serve from dir */
-    /* .def */                   "index.html", /* default filename */
+    /* .mountpoint */            HTTP_MOUNTPOINT,
+    /* .origin */                HTTP_ORIGIN,  /* serve from dir */
+    /* .def */                   HTTP_DEFAULT, /* default filename */
     /* .protocol */              NULL,
     /* .cgienv */                NULL,
     /* .extra_mimetypes */       NULL,
@@ -27,19 +25,17 @@ static const struct lws_http_mount mount = {
     /* .basic_auth_login_file */ NULL,
 };
 
-typedef struct per_vhost_data__dumb_increment {
+typedef struct per_vhost_data__merica_terminal {
     struct lws_context *context;
     struct lws_vhost *vhost;
     const struct lws_protocols *protocol;
-} per_vhost_data__dumb_increment;
+} per_vhost_data__merica_terminal;
 
-typedef struct per_session_data__dumb_increment {
-    uint8_t card_type;
-    uint8_t sak;
-    uint8_t uid_size;
-    char *uid;
+/*
+typedef struct per_session_data__merica_terminal {
     int number;
-} per_session_data__dumb_increment;
+} per_session_data__merica_terminal;
+*/
 
 enum protocols {
     PROTOCOL_HTTP = 0, // always first
@@ -52,18 +48,15 @@ static int callback_merica_terminal(struct lws *wsi,
 
 // list of supported protocols and callbacks
 static struct lws_protocols protocols[] = {
-    /* first protocol must always be HTTP handler */
+    // first protocol must always be HTTP handler
     {"http", lws_callback_http_dummy, 0, 0},
     {
-        "dumb-increment-protocol",
+        "merica-terminal-protocol",
         callback_merica_terminal,
-        sizeof(struct per_session_data__dumb_increment),
-        128, /* rx buf size must be >= permessage-deflate rx size
-             * dumb-increment only sends very small packets, so we set
-             * this accordingly.  If your protocol will send bigger
-             * things, adjust this to match */
+        0, //sizeof(struct per_session_data__merica_terminal),
+        MT_PROTOCOL_RX_BUFFER_SIZE
     },
-    {NULL, NULL, 0, 0} /* terminator */
+    {NULL, NULL, 0, 0} // terminator
 };
 
 static int callback_merica_terminal(struct lws *wsi,
@@ -72,10 +65,12 @@ static int callback_merica_terminal(struct lws *wsi,
 {
     struct lws_vhost *vhost = lws_get_vhost(wsi);
     const struct lws_protocols *prot = lws_get_protocol(wsi);
-    per_session_data__dumb_increment *pss =
-        (per_session_data__dumb_increment *)user;
-    per_vhost_data__dumb_increment *vhd =
-        (per_vhost_data__dumb_increment *)
+    /*
+    per_session_data__merica_terminal *pss =
+        (per_session_data__merica_terminal *)user;
+    */
+    per_vhost_data__merica_terminal *vhd =
+        (per_vhost_data__merica_terminal *)
         lws_protocol_vh_priv_get(vhost, prot);
 
     int n, m;
@@ -86,7 +81,7 @@ static int callback_merica_terminal(struct lws *wsi,
         case LWS_CALLBACK_PROTOCOL_INIT:
             vhd = lws_protocol_vh_priv_zalloc(
                       vhost, prot,
-                      sizeof(struct per_vhost_data__dumb_increment)
+                      sizeof(struct per_vhost_data__merica_terminal)
                   );
             vhd->context = lws_get_context(wsi);
             vhd->protocol = prot;
@@ -106,7 +101,7 @@ static int callback_merica_terminal(struct lws *wsi,
             n = strlen(line);
             m = lws_write(wsi, line, n, LWS_WRITE_TEXT);
             if (m < n) {
-                printf("ERROR %d writing to di socket\n", n);
+                fprintf(stderr, "ERROR %d writing to di socket\n", n);
                 return -1;
             }
             break;
@@ -117,7 +112,7 @@ static int callback_merica_terminal(struct lws *wsi,
                 lws_callback_on_writable_all_protocol(lws_get_context(wsi),
                                                       &protocols[PROTOCOL_MERICA_TERMINAL]);
             } else if (strcmp((const char *)in, "close") == 0) {
-                printf("dumb_inc: closing as requested\n");
+                fprintf(stderr, "closing as WebSocket\n");
                 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
                                  (unsigned char *)"seeya", 5);
                 return -1;
@@ -139,7 +134,7 @@ static void fd_cb(EV_P_ ev_io *w_, int revents)
 
     read(w->w.fd, pos, 1);
 
-    if (*pos == '\n') {
+    if (*pos == '\n' || (w->pos - w->text) == INPUT_LINE_LENGTH) {
         *pos = 0;
         w->pos = w->text;
         lws_callback_on_writable_all_protocol(w->context,
@@ -152,7 +147,7 @@ int mt_server_init(mt_server_t *self, struct ev_loop *loop, int fd)
     struct lws_context_creation_info info;
 
     memset(&info, 0, sizeof(info));
-    info.port = 80;
+    info.port = HTTP_PORT;
     info.mounts = &mount;
     info.protocols = protocols;
     info.max_http_header_pool = 1;
@@ -168,7 +163,7 @@ int mt_server_init(mt_server_t *self, struct ev_loop *loop, int fd)
 
     ev_io_ws *w = &(self->fd_watcher);
     w->context = context;
-    w->text = (char *)malloc(512*sizeof(char));
+    w->text = (char *)malloc(INPUT_LINE_LENGTH*sizeof(char));
     if (!w->text) {
         perror("malloc");
         return -1;
@@ -182,7 +177,7 @@ int mt_server_init(mt_server_t *self, struct ev_loop *loop, int fd)
     return lws_ev_initloop(context, loop, 0);
 }
 
-void mt_server_deinit(mt_server_t *self)
+void mt_server_deinit(mt_server_t *self) //TODO wtf
 {
     //free(self->fd_watcher.text);
     //protocols[PROTOCOL_MERICA_TERMINAL].user = NULL;
diff --git a/mt_server.h b/mt_server.h
index 80261ea..dc44290 100644
--- a/mt_server.h
+++ b/mt_server.h
@@ -4,19 +4,34 @@
 #include <ev.h>
 #include <libwebsockets.h>
 
+// set these two according to your data
+// rx buf size must be >= permessage-deflate rx size
+#define MT_PROTOCOL_RX_BUFFER_SIZE 128
+#define INPUT_LINE_LENGTH          512
+
+#define HTTP_PORT 80                       // listen here
+#define HTTP_MOUNTPOINT "/"                // mountpoint URL
+#define HTTP_ORIGIN "/usr/share/mt-server" // where the html files are
+#define HTTP_DEFAULT "index.html"          // default filename
+
+#define JSON_EMPTY "{\"type\":\"empty\"}"  // default message
+
 typedef struct ev_io_ws {
-    ev_io w;
+    ev_io w;                     // input watcher
     struct lws_context *context;
-    char *text;
-    char *pos;
+    char *text;                  // input buffer pointer
+    char *pos;                   // input buffer current position pointer
 } ev_io_ws;
 
 typedef struct mt_server_t {
     struct lws_context *context;
-    ev_io_ws fd_watcher;
+    ev_io_ws fd_watcher;         // input watcher
 } mt_server_t;
 
+// init self, add it to loop and make it read data from fd
 int mt_server_init(mt_server_t *self, struct ev_loop *loop, int fd);
+
+// gett drunc an kil sellf
 void mt_server_deinit(mt_server_t *self);
 
 #endif
diff --git a/ev_signal_exit.c b/signal_exit.c
similarity index 86%
rename from ev_signal_exit.c
rename to signal_exit.c
index 21c33c5..3aabde5 100644
--- a/ev_signal_exit.c
+++ b/signal_exit.c
@@ -1,8 +1,8 @@
 #include <stdlib.h>
 #include <stdio.h>
-#include "ev_signal_exit.h"
+#include "signal_exit.h"
 
-static int sigs[] = { SIGINT, SIGKILL, SIGTERM, SIGSEGV, SIGFPE };
+static int sigs[] = {SIGINT, SIGKILL, SIGTERM, SIGSEGV, SIGFPE};
 static struct ev_signal signals[5];
 
 static void signal_cb(EV_P_ ev_signal *w, int revents)
diff --git a/ev_signal_exit.h b/signal_exit.h
similarity index 80%
rename from ev_signal_exit.h
rename to signal_exit.h
index 4c3e5b7..a3d6478 100644
--- a/ev_signal_exit.h
+++ b/signal_exit.h
@@ -3,6 +3,7 @@
 
 #include <ev.h>
 
+// make loop break on signal
 void set_signal_exit(struct ev_loop *loop);
 
 #endif
-- 
2.39.2