added plugins

2026-04-18 03:16:01 +00:00 · 2021-04-13 16:17:53 +02:00
parent 446e7c139f
commit 4d5cc119f2
115 changed files with 5519 additions and 24 deletions
--- a/plugins/dbgate-plugin-csv/LICENSE
+++ b/plugins/dbgate-plugin-csv/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jan Prochazka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/plugins/dbgate-plugin-csv/README.md
+++ b/plugins/dbgate-plugin-csv/README.md
@@ -0,0 +1,60 @@
+[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://paypal.me/JanProchazkaCz/30eur)
+[![NPM version](https://img.shields.io/npm/v/dbgate-plugin-csv.svg)](https://www.npmjs.com/package/dbgate-plugin-csv)
+
+# dbgate-plugin-csv
+
+CSV import/export plugin for DbGate
+
+## Usage without DbGate
+
+Export from fake object reader into CSV file. Fake object file can be replaced with other reader/writer factory functions, as described in 
+[dbgate-api package](https://www.npmjs.com/package/dbgate-api)
+
+```javascript
+const dbgateApi = require('dbgate-api');
+const dbgatePluginCsv = require("dbgate-plugin-csv");
+
+dbgateApi.registerPlugins(dbgatePluginCsv);
+
+
+async function run() {
+  const reader = await dbgateApi.fakeObjectReader();
+  const writer = await dbgatePluginCsv.shellApi.writer({ fileName: 'myfile1.csv', separator: ';' });
+  await dbgateApi.copyStream(reader, writer);
+  
+  console.log('Finished job script');
+}
+dbgateApi.runScript(run);
+
+
+```
+
+## Factory functions
+
+### shellApi.reader
+Reads CSV file
+```js
+  const dbgatePluginCsv = require("dbgate-plugin-csv");
+  const reader = await dbgatePluginCsv.shellApi.reader({
+    fileName: 'test.csv',
+    encoding: 'utf-8',
+    header: true,
+    delimiter: ',',
+    quoted: false,
+    limitRows: null
+  });
+```
+
+### shellApi.writer
+Writes CSV file
+```js
+  const dbgatePluginCsv = require("dbgate-plugin-csv");
+  const writer = await dbgatePluginCsv.shellApi.writer({
+    fileName: 'test.csv',
+    encoding: 'utf-8',
+    header: true,
+    delimiter: ',',
+    quoted: false
+  });
+```
--- a/plugins/dbgate-plugin-csv/icon.svg
+++ b/plugins/dbgate-plugin-csv/icon.svg
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 384 384" style="enable-background:new 0 0 384 384;" xml:space="preserve">
+<polygon style="fill:#EFEEEE;" points="64,0 64,384 288,384 384,288 384,0 "/>
+<polygon style="fill:#ABABAB;" points="288,288 288,384 384,288 "/>
+<polygon style="fill:#DEDEDD;" points="192,384 288,384 288,288 "/>
+<path style="fill:#448E47;" d="M0,96v112h256V96L0,96L0,96z"/>
+<g>
+	<path style="fill:#FFFFFF;" d="M64.32,130.112c-1.184-2.288-3.344-3.424-6.48-3.424c-1.728,0-3.152,0.464-4.272,1.408
+		c-1.12,0.928-2,2.416-2.64,4.496s-1.088,4.8-1.344,8.176c-0.272,3.36-0.384,7.472-0.384,12.336c0,5.184,0.176,9.376,0.528,12.576
+		c0.336,3.2,0.896,5.664,1.632,7.44s1.664,2.96,2.784,3.552c1.12,0.608,2.416,0.928,3.888,0.928c1.216,0,2.352-0.208,3.408-0.624
+		s1.968-1.248,2.736-2.496c0.784-1.248,1.392-3.008,1.824-5.28c0.448-2.272,0.672-5.264,0.672-8.976H80.48
+		c0,3.696-0.288,7.232-0.864,10.56s-1.664,6.24-3.216,8.736c-1.584,2.48-3.776,4.432-6.624,5.84
+		c-2.848,1.408-6.544,2.128-11.088,2.128c-5.168,0-9.312-0.848-12.368-2.496c-3.072-1.664-5.424-4.064-7.056-7.2
+		s-2.688-6.88-3.168-11.232c-0.464-4.336-0.72-9.152-0.72-14.384c0-5.184,0.256-9.968,0.72-14.352
+		c0.48-4.368,1.552-8.144,3.168-11.28c1.648-3.12,3.984-5.584,7.056-7.344c3.056-1.744,7.2-2.64,12.368-2.64
+		c4.944,0,8.816,0.8,11.664,2.4c2.848,1.6,4.976,3.632,6.368,6.096s2.304,5.12,2.64,7.968c0.352,2.848,0.528,5.52,0.528,8.016H66.08
+		C66.08,136,65.488,132.368,64.32,130.112z"/>
+	<path style="fill:#FFFFFF;" d="M109.072,167.008c0,1.6,0.144,3.056,0.384,4.352c0.272,1.312,0.736,2.416,1.44,3.312
+		c0.704,0.912,1.664,1.616,2.848,2.128c1.168,0.496,2.672,0.768,4.448,0.768c2.128,0,4.016-0.688,5.712-2.064
+		c1.68-1.376,2.544-3.52,2.544-6.384c0-1.536-0.224-2.864-0.624-3.984c-0.416-1.12-1.104-2.128-2.064-3.008
+		c-0.976-0.912-2.24-1.712-3.792-2.448s-3.504-1.488-5.808-2.256c-3.056-1.024-5.712-2.16-7.968-3.376
+		c-2.24-1.2-4.112-2.624-5.616-4.272c-1.504-1.632-2.608-3.52-3.312-5.664c-0.704-2.16-1.056-4.624-1.056-7.456
+		c0-6.784,1.888-11.824,5.664-15.152c3.76-3.328,8.96-4.992,15.552-4.992c3.072,0,5.904,0.336,8.496,1.008s4.832,1.744,6.72,3.264
+		c1.888,1.504,3.36,3.424,4.416,5.744c1.04,2.336,1.584,5.136,1.584,8.4v1.92h-13.232c0-3.264-0.576-5.776-1.712-7.552
+		c-1.152-1.744-3.072-2.64-5.76-2.64c-1.536,0-2.816,0.24-3.84,0.672c-1.008,0.448-1.84,1.04-2.448,1.776s-1.04,1.616-1.264,2.576
+		c-0.24,0.96-0.336,1.952-0.336,2.976c0,2.128,0.448,3.888,1.344,5.328c0.896,1.456,2.816,2.784,5.76,3.984l10.656,4.608
+		c2.624,1.152,4.768,2.352,6.416,3.616c1.664,1.248,3.008,2.592,3.984,4.032c0.992,1.44,1.68,3.008,2.064,4.752
+		c0.384,1.712,0.576,3.648,0.576,5.744c0,7.232-2.096,12.496-6.288,15.792c-4.192,3.296-10.032,4.96-17.52,4.96
+		c-7.808,0-13.392-1.696-16.768-5.088c-3.36-3.392-5.024-8.256-5.024-14.592v-2.784h13.824L109.072,167.008L109.072,167.008z"/>
+	<path style="fill:#FFFFFF;" d="M177.344,168.544h0.304l10.176-50.688h14.32L186.4,186.4h-17.76l-15.728-68.544h14.784
+		L177.344,168.544z"/>
+</g>
+</svg>
--- a/plugins/dbgate-plugin-csv/package.json
+++ b/plugins/dbgate-plugin-csv/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "dbgate-plugin-csv",
+  "main": "dist/backend.js",
+  "version": "1.0.9",
+  "homepage": "https://github.com/dbgate/dbgate-plugin-csv",
+  "description": "CSV import/export plugin for DbGate",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dbgate/dbgate-plugin-csv.git"
+  },
+  "funding": "https://www.paypal.com/paypalme/JanProchazkaCz/30eur",
+  "author": "Jan Prochazka",
+  "license": "GPL",
+  "keywords": [
+    "csv",
+    "import",
+    "export",
+    "dbgate",
+    "dbgateplugin"
+  ],
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build:frontend": "webpack --config webpack-frontend.config",
+    "build:backend": "webpack --config webpack-backend.config.js",
+    "build": "yarn build:frontend && yarn build:backend",
+    "plugin": "yarn build && yarn pack && dbgate-plugin dbgate-plugin-csv",
+    "plugout": "dbgate-plugout dbgate-plugin-csv",
+    "prepublishOnly": "yarn build"
+  },
+  "devDependencies": {
+    "csv": "^5.3.2",
+    "dbgate-plugin-tools": "^1.0.4",
+    "lodash": "^4.17.20",
+    "webpack": "^4.42.0",
+    "webpack-cli": "^3.3.11"
+  }
+}
--- a/plugins/dbgate-plugin-csv/prettier.config.js
+++ b/plugins/dbgate-plugin-csv/prettier.config.js
@@ -0,0 +1,8 @@
+module.exports = {
+  trailingComma: 'es5',
+  tabWidth: 2,
+  semi: true,
+  singleQuote: true,
+  arrowParen: 'avoid',
+  printWidth: 120,
+};
--- a/plugins/dbgate-plugin-csv/src/backend/index.js
+++ b/plugins/dbgate-plugin-csv/src/backend/index.js
@@ -0,0 +1,13 @@
+const reader = require('./reader');
+const writer = require('./writer');
+
+module.exports = {
+  packageName: 'dbgate-plugin-csv',
+  shellApi: {
+    reader,
+    writer,
+  },
+  initialize(dbgateEnv) {
+    reader.initialize(dbgateEnv);
+  },
+};
--- a/plugins/dbgate-plugin-csv/src/backend/reader.js
+++ b/plugins/dbgate-plugin-csv/src/backend/reader.js
@@ -0,0 +1,67 @@
+const zipObject = require('lodash/zipObject');
+const csv = require('csv');
+const fs = require('fs');
+const stream = require('stream');
+
+let dbgateApi;
+class CsvPrepareStream extends stream.Transform {
+  constructor({ header }) {
+    super({ objectMode: true });
+    this.structure = null;
+    this.header = header;
+  }
+  _transform(chunk, encoding, done) {
+    if (this.structure) {
+      this.push(
+        zipObject(
+          this.structure.columns.map((x) => x.columnName),
+          chunk
+        )
+      );
+      done();
+    } else {
+      if (this.header) {
+        this.structure = {
+          __isStreamHeader: true,
+          columns: chunk.map((columnName) => ({ columnName })),
+        };
+        this.push(this.structure);
+      } else {
+        this.structure = {
+          __isStreamHeader: true,
+          columns: chunk.map((value, index) => ({ columnName: `col${index + 1}` })),
+        };
+        this.push(this.structure);
+        this.push(
+          zipObject(
+            this.structure.columns.map((x) => x.columnName),
+            chunk
+          )
+        );
+      }
+      done();
+    }
+  }
+}
+
+async function reader({ fileName, encoding = 'utf-8', header = true, delimiter, limitRows = undefined }) {
+  console.log(`Reading file ${fileName}`);
+  const csvStream = csv.parse({
+    // @ts-ignore
+    delimiter,
+    skip_lines_with_error: true,
+    to_line: limitRows ? limitRows + 1 : undefined,
+  });
+  const downloadedFile = await dbgateApi.download(fileName);
+  const fileStream = fs.createReadStream(downloadedFile, encoding);
+  const csvPrepare = new CsvPrepareStream({ header });
+  fileStream.pipe(csvStream);
+  csvStream.pipe(csvPrepare);
+  return csvPrepare;
+}
+
+reader.initialize = (dbgateEnv) => {
+  dbgateApi = dbgateEnv.dbgateApi;
+};
+
+module.exports = reader;
--- a/plugins/dbgate-plugin-csv/src/backend/writer.js
+++ b/plugins/dbgate-plugin-csv/src/backend/writer.js
@@ -0,0 +1,36 @@
+const csv = require('csv');
+const fs = require('fs');
+const stream = require('stream');
+
+class CsvPrepareStream extends stream.Transform {
+  constructor({ header }) {
+    super({ objectMode: true });
+    this.structure = null;
+    this.header = header;
+  }
+  _transform(chunk, encoding, done) {
+    if (this.structure) {
+      this.push(this.structure.columns.map((col) => chunk[col.columnName]));
+      done();
+    } else {
+      this.structure = chunk;
+      if (this.header) {
+        this.push(chunk.columns.map((x) => x.columnName));
+      }
+      done();
+    }
+  }
+}
+
+async function writer({ fileName, encoding = 'utf-8', header = true, delimiter, quoted }) {
+  console.log(`Writing file ${fileName}`);
+  const csvPrepare = new CsvPrepareStream({ header });
+  const csvStream = csv.stringify({ delimiter, quoted });
+  const fileStream = fs.createWriteStream(fileName, encoding);
+  csvPrepare.pipe(csvStream);
+  csvStream.pipe(fileStream);
+  csvPrepare['finisher'] = fileStream;
+  return csvPrepare;
+}
+
+module.exports = writer;
--- a/plugins/dbgate-plugin-csv/src/frontend/index.js
+++ b/plugins/dbgate-plugin-csv/src/frontend/index.js
@@ -0,0 +1,46 @@
+const fileFormat = {
+  packageName: 'dbgate-plugin-csv',
+  // file format identifier
+  storageType: 'csv',
+  // file extension without leading dot
+  extension: 'csv',
+  // human readable file format name
+  name: 'CSV',
+  // function name from backend, which contains reader factory, postfixed by package name
+  readerFunc: 'reader@dbgate-plugin-csv',
+  // function name from backend, which contains writer factory, postfixed by package name
+  writerFunc: 'writer@dbgate-plugin-csv',
+  // optional list of format arguments, which can be edited from UI
+  args: [
+    {
+      type: 'select',
+      name: 'delimiter',
+      label: 'Delimiter',
+      options: [
+        { name: 'Comma (,)', value: ',' },
+        { name: 'Semicolon (;)', value: ';' },
+        { name: 'Tab', value: '\t' },
+        { name: 'Pipe (|)', value: '|' },
+      ],
+      apiName: 'delimiter',
+    },
+    {
+      type: 'checkbox',
+      name: 'quoted',
+      label: 'Quoted',
+      apiName: 'quoted',
+      direction: 'target',
+    },
+    {
+      type: 'checkbox',
+      name: 'header',
+      label: 'Has header row',
+      apiName: 'header',
+      default: true,
+    },
+  ],
+};
+
+export default {
+  fileFormats: [fileFormat],
+};
--- a/plugins/dbgate-plugin-csv/webpack-backend.config.js
+++ b/plugins/dbgate-plugin-csv/webpack-backend.config.js
@@ -0,0 +1,23 @@
+var webpack = require('webpack');
+var path = require('path');
+
+var config = {
+  context: __dirname + '/src/backend',
+
+  entry: {
+    app: './index.js',
+  },
+  target: 'node',
+  output: {
+    path: path.resolve(__dirname, 'dist'),
+    filename: 'backend.js',
+    libraryTarget: 'commonjs2',
+  },
+
+  // uncomment for disable minimalization
+  //   optimization: {
+  //     minimize: false,
+  //   },
+};
+
+module.exports = config;
--- a/plugins/dbgate-plugin-csv/webpack-frontend.config.js
+++ b/plugins/dbgate-plugin-csv/webpack-frontend.config.js
@@ -0,0 +1,24 @@
+var webpack = require("webpack");
+var path = require("path");
+
+var config = {
+  context: __dirname + "/src/frontend",
+
+  entry: {
+    app: "./index.js",
+  },
+  target: "web",
+  output: {
+    path: path.resolve(__dirname, "dist"),
+    filename: "frontend.js",
+    libraryTarget: "var",
+    library: 'plugin',
+  },
+
+  // uncomment for disable minimalization
+  // optimization: {
+  //   minimize: false,
+  // },
+};
+
+module.exports = config;