#476 Add support for PlantUML -debugsvek

Author: pepijnve

docs/modules/ROOT/pages/diagram_types/plantuml.adoc

@@ -26,5 +26,12 @@ PlantUML requires Java version 1.8 or higher to be installed.
 |size-limit      |4096            |The maximum dimensions (width and height) of generated diagrams.
 |includedir      |unspecified     |sets a common directory for puml includes (plantuml.include.path)
 |preprocess      |true            |Preprocess PlantUML code before rendering the diagram.
-|options       |unspecified   |a comma separate list of flags that modify the image rendering. Currently only `smetana` is supported which enables the Smetana layout engine.
+|===
+
+== Options
+[cols=">,<",options="header"]
+|===
+|Name          |Description
+|debug         |Emit debug files when generating images.
+|smetana       |Enable the Smetana layout engine.
 |===

lib/asciidoctor-diagram/diagram_processor.rb

@@ -194,17 +194,27 @@ def create_image_block(parent, source, format, converter)
 
           options = converter.collect_options(source)
           result = converter.convert(source, format, options)
-
-          result.force_encoding(params[:encoding])
+          if result.is_a? Hash
+            image = result[:result]
+            extra = result[:extra]
+          else
+            image = result
+            extra = {}
+          end
+          image.force_encoding(params[:encoding])
 
           metadata = source.create_image_metadata
           metadata[:options] = options
 
           allow_image_optimisation = !source.global_opt('nooptimise')
-          result, metadata[:width], metadata[:height] = params[:decoder].post_process_image(result, allow_image_optimisation)
+          image, metadata[:width], metadata[:height] = params[:decoder].post_process_image(image, allow_image_optimisation)
 
           FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
-          File.open(image_file, 'wb') {|f| f.write result}
+          File.open(image_file, 'wb') {|f| f.write image}
+
+          extra.each do |name, data|
+            File.open(image_file + ".#{name}", 'wb') {|f| f.write data}
+          end
 
           if use_cache
             FileUtils.mkdir_p(File.dirname(metadata_file)) unless Dir.exist?(File.dirname(metadata_file))

lib/asciidoctor-diagram/plantuml/converter.rb

@@ -45,6 +45,8 @@ def collect_options(source)
         theme = source.attr('theme', nil)
         options[:theme] = theme if theme
 
+        options[:debug] = true if source.opt('debug')
+
         options
       end
 
@@ -117,6 +119,10 @@ def convert(source, format, options)
           end
         end
 
+        if options[:debug]
+          headers['X-PlantUML-Debug'] = 'true'
+        end
+
         response = Java.send_request(
             :url => '/plantuml',
             :body => code,
@@ -127,7 +133,37 @@ def convert(source, format, options)
           raise Java.create_error("PlantUML image generation failed", response)
         end
 
-        response[:body]
+        if response[:headers]['content-type'] =~ /multipart\/form-data;\s*boundary=(.*)/
+          boundary = $1
+          parts = {}
+
+          multipart_data = StringIO.new(response[:body])
+          while true
+            multipart_data.readline
+            marker = multipart_data.readline
+            if marker.start_with? "--#{boundary}--"
+              break
+            elsif marker.start_with? "--#{boundary}"
+              part = Java.parse_body(multipart_data)
+              if part[:headers]['content-disposition'] =~ /form-data;\s*name="([^"]*)"/
+                if $1 == 'image'
+                  parts[:result] = part[:body]
+                else
+                  parts[:extra] ||= {}
+                  parts[:extra][$1] = part[:body]
+                end
+              else
+                raise "Unexpected multipart content disposition"
+              end
+            else
+              raise "Unexpected multipart boundary"
+            end
+          end
+
+          parts
+        else
+          response[:body]
+        end
       end
     end
 

lib/asciidoctor-diagram/plantuml/plantuml-2.2.1.jar

@@ -58,25 +58,34 @@ def self.parse_response(io)
         resp[:code] = status_line_parts[1].to_i
         resp[:reason] = status_line_parts[2]
 
+        resp.merge! parse_body(io)
+
+        resp
+      end
+
+      def self.parse_body(io)
+        body = {}
+
+        io.set_encoding Encoding::US_ASCII
         headers = {}
         until (header = io.readline(CRLF).strip).empty?
           key, value = header.split ':', 2
-          headers[key] = value.strip
+          headers[key.downcase] = value.strip
         end
 
-        resp[:headers] = headers
+        body[:headers] = headers
 
-        content_length = headers['Content-Length']
+        content_length = headers['content-length']
         if content_length
           io.set_encoding Encoding::BINARY
-          resp[:body] = io.read(content_length.to_i)
+          body[:body] = io.read(content_length.to_i)
         end
 
-        resp
+        body
       end
 
       def self.create_error(prefix_msg, response)
-        content_type = response[:headers]['Content-Type'] || 'text/plain'
+        content_type = response[:headers]['content-type'] || 'text/plain'
         if content_type.start_with? 'application/json'
           json = JSON.parse(response[:body].force_encoding(Encoding::UTF_8))
           ruby_bt = Kernel.caller(2)
@@ -97,7 +106,6 @@ def self.java
         @java_exe
       end
 
-      private
       def self.find_java
         case ::Asciidoctor::Diagram::Platform.os
           when :windows