Merge remote-tracking branch 'nrekretep/master'

Author: dy93

README.md

@@ -1,12 +1,58 @@
-**GitBook PlantUml Plugin**
-==============
-* inspire by [romanlytkin/gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml)
-* use [bitjourney/plantuml-service](https://github.com/bitjourney/plantuml-service)
-to support plantuml, so you do not need java run time on your host machine.
-
-**How to use it:**
---------------
-```$ npm install gitbook-plugin-plantuml-cloud```
-
-***Additional requirements:***
-NO
+# GitBook PlantUml Plugin
+
+* inspired by [romanlytkin/gitbook-plantuml](https://github.com/romanlytkin/gitbook-plantuml)
+
+The plugin now supports two APIs for generating PlantUML diagrams:
+* [bitjourney/plantuml-service](https://github.com/bitjourney/plantuml-service)
+* [PlantUML Server](http://www.plantuml.com/plantuml/)
+
+
+## Installation
+
+* Add the plugin to your book.json
+
+```js
+{
+ "plugins": ["plantuml-cloud"]
+}
+```
+
+* Install the plugin to you gitbook 
+
+```$ gitbook install```
+
+* No additional steps required
+
+## Configuration
+
+* If you do not add a plugin configuration to your book.json, then the following defaults will be used:
+
+| Configuration option | Description | Default | 
+| -------------------- | ----------- | ------- |
+| umlPath | Path to a directory where the generated images for the diagrams will be cached. | "assets/images/uml" | 
+| type | Determines the type of the server side API | "plantuml-service" | 
+| host | Host for the diagramming service | "plantuml-service.herokuapp.com" | 
+| protocol | https or http | "https" | 
+| path | URL Fragment which will be appended to the host part | "/svg/" | 
+| blockRegex | Regular expression to select the diagramming text blocks. | ^```uml((.*\n)+?)?```$ |
+
+* If want to use the PlantUML Server API the following changes need to be made to the plugin configuration in your book.json:
+
+```js
+{
+ "plugins": ["plantuml-cloud"],
+ "pluginsConfig": {
+ "plantuml-cloud": {
+ "protocol": "http",
+ "type": "plantuml-server",
+ "host": "www.plantuml.com",
+ "path": "/plantuml/svg/"
+ }
+ }
+}
+```
+
+> The PlantUML Server API on plantuml.com expects the diagram text blocks in a special encoding. [Look here for more information.](http://plantuml.com/pte)
+> To make this encoding work in this plugin it was necessary to include some code for the deflate operations. [Look here for more information.](https://github.com/johan/js-deflate)
+
+* [ ] Make the plugin work with nodejs zlib deflate implementation and remove the duplicated deflate code.

index.js

@@ -1,30 +1,71 @@
 var fs = require('fs');
-var re = /^```uml((.*\n)+?)?```$/img;
 var crypto = require('crypto');
 var path = require('path');
 var https = require('https');
+var http = require('http');
 var qs = require('querystring');
+var zlib = require('zlib');
+
+var plantUml = require('./plantuml_encode');
+
+var options = {
+"umlPath": "assets/images/uml",
+"type": "plantuml-service",
+"host": "plantuml-service.herokuapp.com",
+"protocol": "https",
+"path": "/svg/",
+"blockRegex": "^```uml((.*[\r\n])+?)?```$"
+}
 
 require('shelljs/global');
 
+
+function plantumlServerEscape(block) {
+
+ //UTF8
+ var compressedUml = unescape(encodeURIComponent(block));
+ compressedUml = plantUml.encode64(plantUml.zip_deflate(compressedUml, 9));
+ return compressedUml;
+}
+
 module.exports = {
 hooks: {
 "init": function () {
 var output = this.output;
-var umlPath = output.resolve('assets/images/uml');
-
+var config = this.config.values.pluginsConfig["plantuml-cloud"];
+if(config.umlPath != undefined) {
+options.umlPath = config.umlPath;
+}
+if(config.type != undefined) {
+options.type = config.type;
+}
+if(config.host != undefined) {
+options.host = config.host;
+}
+if(config.protocol != undefined) {
+options.protocol = config.protocol;
+}
+if(config.path != undefined) {
+options.path = config.path;
+}
+if(config.blockRegex != undefined) {
+options.blockRegex = config.blockRegex;
+}
+var umlPath = output.resolve(options.umlPath);
 mkdir('-p', umlPath);
 },
 "page:before": function (page) {
 var output = this.output;
 var content = page.content;
 
 var umls = [];
+var re = new RegExp(options.blockRegex, 'img');
+
 while ((match = re.exec(content))) {
 var rawBlock = match[0];
 var umlBlock = match[1];
 var md5 = crypto.createHash('md5').update(umlBlock).digest('hex');
-var svgPath = path.join('assets', 'images', 'uml', md5 + '.svg');
+var svgPath = path.join(options.umlPath, md5 + '.svg');
 umls.push({
 rawBlock: match[0],
 umlBlock: match[1],
@@ -39,9 +80,20 @@ module.exports = {
 return output.hasFile(uml.svgPath).then(exists => {
 if (!exists) {
 return new Promise((resolve, reject) => {
-https.request({
-host: 'plantuml-service.herokuapp.com',
-path: '/svg/' + qs.escape(uml.umlBlock)
+
+var client = http;
+if(options.protocol == "https"){
+client = https;
+} 
+
+var path = options.path + qs.escape(uml.umlBlock); 
+if(options.type == "plantuml-server") {
+path = options.path + plantumlServerEscape(uml.umlBlock); 
+}
+
+client.request({
+host: options.host,
+path: path
 }, (res) => {
 var ws = fs.createWriteStream(output.resolve(uml.svgPath));
 res.pipe(ws);
@@ -58,4 +110,4 @@ module.exports = {
 "page": function (page) { return page; },
 "page:after": function (page) { return page; }
 }
-};
+};