فهرست منبع

:building_construction: add md2htm rpc server

Jeremy Zheng 2 سال پیش
والد
کامیت
d85899d8a8

+ 5 - 0
morus/.gitignore

@@ -0,0 +1,5 @@
+/node_modules/
+/yarn.lock
+
+/dist/
+/config.json

+ 14 - 0
morus/README.md

@@ -0,0 +1,14 @@
+# USAGE
+
+```bash
+# Install dependencies
+yarn install
+
+# For production
+npx webpack --mode=production
+node dist/morus-xxx.js config.json
+
+# For development
+npx webpack --mode=development
+node dist/morus.js config.json
+```

+ 3 - 0
morus/config.json.orig

@@ -0,0 +1,3 @@
+{
+    "port": 9999
+}

+ 15 - 0
morus/morus.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+option java_multiple_files = true;
+option java_package = "com.github.iapt_platform.mint.plugins.morus.v1";
+package mint.morus.v1;
+
+// ----------------------------------------------------------------------------
+service Markdown {
+  rpc ToHtml(MarkdownToHtmlRequest) returns (MarkdownToHtmlResponse) {}
+}
+
+message MarkdownToHtmlRequest {
+  string payload = 1;
+  bool sanitize = 2;
+}
+message MarkdownToHtmlResponse { string payload = 1; }

+ 23 - 0
morus/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "morus",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "@grpc/grpc-js": "^1.9.2",
+    "bufferutil": "^4.0.7",
+    "canvas": "^2.11.2",
+    "dompurify": "^3.0.5",
+    "google-protobuf": "^3.21.2",
+    "jsdom": "^22.1.0",
+    "marked": "^7.0.5",
+    "pino": "^8.15.0",
+    "pino-pretty": "^10.2.0",
+    "utf-8-validate": "^6.0.3"
+  },
+  "devDependencies": {
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4"
+  }
+}

+ 29 - 0
morus/schema.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -e
+
+export PROTOBUF_ROOT=$HOME/.local
+export WORKSPACE=$PWD
+
+# -----------------------------------------------------------------------------
+
+function generate_node() {
+    echo "generate morus code for node"
+    local target=$WORKSPACE/src/protocols
+    if [ -d $target ]
+    then
+        rm -r $target
+    fi
+    mkdir -p $target
+    grpc_tools_node_protoc -I $WORKSPACE \
+        -I $PROTOBUF_ROOT/include/google/protobuf \
+        --js_out=import_style=commonjs,binary:$target \
+        --grpc_out=grpc_js:$target $WORKSPACE/morus.proto
+}
+
+# -----------------------------------------------------------------------------
+generate_node
+# -----------------------------------------------------------------------------
+
+echo 'done.'
+exit 0

+ 11 - 0
morus/src/env.js

@@ -0,0 +1,11 @@
+"use strict";
+
+import {readFileSync} from "fs"
+
+export class Config {
+    constructor(file) {
+        const raw = readFileSync(file);
+        const it = JSON.parse(raw);
+        this.port = it.port;
+    }
+}

+ 25 - 0
morus/src/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+import {Server, ServerCredentials} from '@grpc/grpc-js';
+
+import {Config} from './env';
+import logger from './logger';
+import {MarkdownService} from './protocols/morus_grpc_pb';
+import { to_html } from './services/markdown';
+
+function main() {
+    const args = process.argv;
+    if(args.length !== 3){
+        logger.error(`USAGE: node ${args[1]} CONFIG_FILE`);
+        return;
+    }    
+    const config = new Config("config.json");
+    logger.info(`start gRPC server on http://0.0.0.0:${config.port}`);
+    var server = new Server();
+    server.addService(MarkdownService, {toHtml: to_html});
+    server.bindAsync(`0.0.0.0:${config.port}`, ServerCredentials.createInsecure(), ()=>{
+        server.start();
+    });
+}
+
+main();

+ 8 - 0
morus/src/logger.js

@@ -0,0 +1,8 @@
+"use strict";
+
+import pino from 'pino';
+
+const logger = pino();
+
+
+export default logger;

+ 45 - 0
morus/src/protocols/morus_grpc_pb.js

@@ -0,0 +1,45 @@
+// GENERATED CODE -- DO NOT EDIT!
+
+'use strict';
+var grpc = require('@grpc/grpc-js');
+var morus_pb = require('./morus_pb.js');
+
+function serialize_mint_morus_v1_MarkdownToHtmlRequest(arg) {
+  if (!(arg instanceof morus_pb.MarkdownToHtmlRequest)) {
+    throw new Error('Expected argument of type mint.morus.v1.MarkdownToHtmlRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_mint_morus_v1_MarkdownToHtmlRequest(buffer_arg) {
+  return morus_pb.MarkdownToHtmlRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_mint_morus_v1_MarkdownToHtmlResponse(arg) {
+  if (!(arg instanceof morus_pb.MarkdownToHtmlResponse)) {
+    throw new Error('Expected argument of type mint.morus.v1.MarkdownToHtmlResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_mint_morus_v1_MarkdownToHtmlResponse(buffer_arg) {
+  return morus_pb.MarkdownToHtmlResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+
+// ----------------------------------------------------------------------------
+var MarkdownService = exports.MarkdownService = {
+  toHtml: {
+    path: '/mint.morus.v1.Markdown/ToHtml',
+    requestStream: false,
+    responseStream: false,
+    requestType: morus_pb.MarkdownToHtmlRequest,
+    responseType: morus_pb.MarkdownToHtmlResponse,
+    requestSerialize: serialize_mint_morus_v1_MarkdownToHtmlRequest,
+    requestDeserialize: deserialize_mint_morus_v1_MarkdownToHtmlRequest,
+    responseSerialize: serialize_mint_morus_v1_MarkdownToHtmlResponse,
+    responseDeserialize: deserialize_mint_morus_v1_MarkdownToHtmlResponse,
+  },
+};
+
+exports.MarkdownClient = grpc.makeGenericClientConstructor(MarkdownService);

+ 358 - 0
morus/src/protocols/morus_pb.js

@@ -0,0 +1,358 @@
+// source: morus.proto
+/**
+ * @fileoverview
+ * @enhanceable
+ * @suppress {missingRequire} reports error on implicit type usages.
+ * @suppress {messageConventions} JS Compiler reports an error if a variable or
+ *     field starts with 'MSG_' and isn't a translatable message.
+ * @public
+ */
+// GENERATED CODE -- DO NOT EDIT!
+/* eslint-disable */
+// @ts-nocheck
+
+var jspb = require('google-protobuf');
+var goog = jspb;
+var global = (function() {
+  if (this) { return this; }
+  if (typeof window !== 'undefined') { return window; }
+  if (typeof global !== 'undefined') { return global; }
+  if (typeof self !== 'undefined') { return self; }
+  return Function('return this')();
+}.call(null));
+
+goog.exportSymbol('proto.mint.morus.v1.MarkdownToHtmlRequest', null, global);
+goog.exportSymbol('proto.mint.morus.v1.MarkdownToHtmlResponse', null, global);
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.mint.morus.v1.MarkdownToHtmlRequest, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.mint.morus.v1.MarkdownToHtmlRequest.displayName = 'proto.mint.morus.v1.MarkdownToHtmlRequest';
+}
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.mint.morus.v1.MarkdownToHtmlResponse, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.mint.morus.v1.MarkdownToHtmlResponse.displayName = 'proto.mint.morus.v1.MarkdownToHtmlResponse';
+}
+
+
+
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.toObject = function(opt_includeInstance) {
+  return proto.mint.morus.v1.MarkdownToHtmlRequest.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlRequest} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    payload: jspb.Message.getFieldWithDefault(msg, 1, ""),
+    sanitize: jspb.Message.getBooleanFieldWithDefault(msg, 2, false)
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlRequest}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.mint.morus.v1.MarkdownToHtmlRequest;
+  return proto.mint.morus.v1.MarkdownToHtmlRequest.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlRequest} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlRequest}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setPayload(value);
+      break;
+    case 2:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setSanitize(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.mint.morus.v1.MarkdownToHtmlRequest.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlRequest} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getPayload();
+  if (f.length > 0) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+  f = message.getSanitize();
+  if (f) {
+    writer.writeBool(
+      2,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string payload = 1;
+ * @return {string}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.getPayload = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlRequest} returns this
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.setPayload = function(value) {
+  return jspb.Message.setProto3StringField(this, 1, value);
+};
+
+
+/**
+ * optional bool sanitize = 2;
+ * @return {boolean}
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.getSanitize = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 2, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlRequest} returns this
+ */
+proto.mint.morus.v1.MarkdownToHtmlRequest.prototype.setSanitize = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 2, value);
+};
+
+
+
+
+
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.prototype.toObject = function(opt_includeInstance) {
+  return proto.mint.morus.v1.MarkdownToHtmlResponse.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlResponse} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    payload: jspb.Message.getFieldWithDefault(msg, 1, "")
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlResponse}
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.mint.morus.v1.MarkdownToHtmlResponse;
+  return proto.mint.morus.v1.MarkdownToHtmlResponse.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlResponse} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlResponse}
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setPayload(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.mint.morus.v1.MarkdownToHtmlResponse.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.mint.morus.v1.MarkdownToHtmlResponse} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getPayload();
+  if (f.length > 0) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string payload = 1;
+ * @return {string}
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.prototype.getPayload = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.mint.morus.v1.MarkdownToHtmlResponse} returns this
+ */
+proto.mint.morus.v1.MarkdownToHtmlResponse.prototype.setPayload = function(value) {
+  return jspb.Message.setProto3StringField(this, 1, value);
+};
+
+
+goog.object.extend(exports, proto.mint.morus.v1);

+ 22 - 0
morus/src/services/markdown.js

@@ -0,0 +1,22 @@
+"use strict";
+
+import createDOMPurify from 'dompurify';
+import {JSDOM} from 'jsdom';
+import {parse as parse_markdown} from 'marked';
+
+import {MarkdownToHtmlResponse} from '../protocols/morus_pb';
+
+export const to_html = (call, callback) => {
+    const request = call.request.getPayload();
+    const html = parse_markdown(request);
+    var reply = new MarkdownToHtmlResponse();
+    if(call.request.sanitize){
+        const window = new JSDOM('').window;
+        const purify = createDOMPurify(window);    
+        const clean = purify.sanitize(html); 
+        reply.setPayload(clean);
+    }else{
+        reply.setPayload(html);
+    }
+    callback(null, reply);
+}

+ 12 - 0
morus/third.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+yarn add @grpc/grpc-js google-protobuf \
+    marked dompurify jsdom canvas bufferutil utf-8-validate \
+    pino pino-pretty
+
+yarn add --dev webpack webpack-cli
+
+echo 'done.'
+exit 0

+ 13 - 0
morus/webpack.config.js

@@ -0,0 +1,13 @@
+const path = require('path');
+
+module.exports = (env, argv) =>{
+ return {
+    entry: './src/index.js',
+    output: {
+      path: path.resolve(__dirname, 'dist'),
+      filename: argv.mode === 'production' ? 'morus.[contenthash].bundle.js' : 'morus.js',
+    },
+    target: 'node',
+    externals : { canvas: {} }
+  };
+};