canvas_exporting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87c0ec1e5a813f6c937e22ed3bb51cf1f25297c3
+  data.tar.gz: c53831121a9dd9ae28e2aa156ad83ebdf81b7311
+SHA512:
+  metadata.gz: 7b23a241c14c8754f7d9fcf461fb7e2428396a42e5d6972f125759541993fb8030eb2578b3f9a78ec881c3833518a658c4d431b4896b741ef6323595fa2cab89
+  data.tar.gz: dcd0e8a762d7bfe781a061b564c400bc3b7e305566c64e3b922613ca3134743c2fa8a1de259c97cff074339fe948500dedff304ade93b888e7b84911c5d71921

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 bastengao
+
+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.

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HighchartsExporting'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+require File.join('rspec', 'core', 'rake_task')
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/canvas_exporting/exporter.rb

@@ -0,0 +1,102 @@
+require 'fileutils'
+require 'tempfile'
+require 'phantomjs'
+
+# references:
+#   http://www.highcharts.com/docs/export-module/export-module-overview
+#   https://github.com/highslide-software/highcharts.com/tree/master/exporting-server/phantomjs
+module CanvasExporting
+  module Exporter
+    def export
+      @infile_tmp_file = infile_file
+
+      type = params[:type] || 'image/png'
+      extension = MIME::Types[type].first.extensions.first
+
+      if params[:outputpath] == nil
+        output_path = tmp_dir
+      else
+        output_path = params[:outputpath]
+      end
+
+      output_path = output_path + '/' if output_path[-1] != '/'
+
+      if params[:filename] == nil
+        filename = 'Chart.' + extension
+      else
+        filename = params[:filename]
+      end
+
+      @output_file = output_path + filename
+
+      scale = params[:scale] || 2
+      width = params[:width]
+      constr = params[:constr] || 'Chart'
+
+      convert_args = convert_args({infile: @infile_tmp_file.path,
+                                   outfile: @output_file,
+                                   scale: scale,
+                                   width: width,
+                                   constr: constr,
+                                   callback: callback_path
+                                  })
+
+      result = ::Phantomjs.run(*convert_args)
+      #puts result if VERBOSE
+
+      # TODO: clean @output_tmp_file
+      @infile_tmp_file.delete
+      @callback_tmp_file.delete if @callback_tmp_file
+
+      if /Error/ =~ result
+        render text: result, status: 500
+      else
+        send_file @output_file, filename: "#{filename}", type: type
+      end
+    end
+
+    protected
+    def tmp_dir
+      Rails.root.join('tmp/canvas_charts').to_s.tap { |f| FileUtils.mkdir_p f }
+    end
+
+    def infile_file
+      tmp_file = nil
+      if params[:options]
+        tmp_file = Tempfile.new(['options', '.json'], tmp_dir)
+        temp_write(tmp_file, params[:options])
+      elsif params[:svg]
+        tmp_file = Tempfile.new(['options', '.svg'], tmp_dir)
+        temp_write(tmp_file, params[:svg])
+      end
+
+      tmp_file
+    end
+
+    def callback_path
+      if params[:callback]
+        @callback_tmp_file = Tempfile.new(['callbacks', '.js'], tmp_dir)
+        temp_write(@callback_tmp_file, params[:callback])
+        @callback_tmp_file.path
+      else
+        nil
+      end
+    end
+
+    def convert_args(args)
+      convert_args = args.reject { |k, v| v.blank? }.to_a.map { |pair| ["-#{pair[0]}", pair[1].to_s] }.flatten
+
+      convert_args.unshift("--web-security=false", convert_js_path)
+    end
+
+    def convert_js_path
+      File.join(ROOT, 'phantomjs/canvas-convert.js').to_s
+    end
+
+    def temp_write(tmp_file, content)
+      File.open(tmp_file.path, 'r+') do |f|
+        f.write content
+      end
+    end
+  end
+end

data/lib/canvas_exporting/version.rb

@@ -0,0 +1,3 @@
+module CanvasExporting
+  VERSION = "0.0.1"
+end

data/lib/canvas_exporting.rb

@@ -0,0 +1,7 @@
+require 'canvas_exporting/version'
+require 'canvas_exporting/exporter'
+
+module CanvasExporting
+  ROOT = File.expand_path("../..", __FILE__)
+  VERBOSE = false
+end

data/phantomjs/callback.js

@@ -0,0 +1 @@
+var dummy = 0;

data/phantomjs/canvas-convert.js

@@ -0,0 +1,290 @@
+
+(function () {
+	"use strict";
+
+	var config = {
+			/* define locations of mandatory javascript files.
+			 */
+			files: {
+				JQUERY: 'jquery.1.9.1.min.js',
+				/* JQUERY: 'jquery.js', */
+				CANVAS: 'canvasjs.js',
+				CANVAS_EXPORT: 'excanvas.js'
+			},
+			TIMEOUT: 5000 /* 5 seconds timout for loading images */
+		},
+		mapCLArguments,
+		render,
+		startServer = false,
+		args,
+		pick,
+		SVG_DOCTYPE = '<?xml version=\"1.0" standalone=\"no\"?><!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">',
+		dpiCorrection = 1.4,
+		system = require('system'),
+		fs = require('fs'),
+		serverMode = false;
+
+	pick = function () {
+		var args = arguments, i, arg, length = args.length;
+		for (i = 0; i < length; i += 1) {
+			arg = args[i];
+			if (arg !== undefined && arg !== null && arg !== 'null' && arg != '0') {
+				return arg;
+			}
+		}
+	};
+
+	mapCLArguments = function () {
+		var map = {},
+			i,
+			key;
+
+		if (system.args.length < 1) {
+			console.log('Commandline Usage: canvas-convert.js -infile URL -outfile filename -scale 2.5 -width 300 -constr Chart -callback callback.js');
+			console.log(', or run PhantomJS as server: canvas-convert.js -host 127.0.0.1 -port 1234');
+		}
+
+		for (i = 0; i < system.args.length; i += 1) {
+			if (system.args[i].charAt(0) === '-') {
+				key = system.args[i].substr(1, i.length);
+				if (key === 'infile' || key === 'callback' || key === 'dataoptions' || key === 'globaloptions' || key === 'customcode') {
+					// get string from file
+					try {
+						map[key] = fs.read(system.args[i + 1]).replace(/^\s+/, '');
+					} catch (e) {
+						console.log('Error: cannot find file, ' + system.args[i + 1]);
+						phantom.exit();
+					}
+				} else {
+					map[key] = system.args[i + 1];
+				}
+			}
+		}
+		return map;
+	};
+
+	render = function (params, exitCallback) {
+
+		var page = require('webpage').create(),
+			messages = {},
+			scaleAndClipPage,
+			loadChart,
+			createChart,
+			input,
+			constr,
+			callback,
+			width,
+			output,
+			outType,
+			timer,
+			renderSVG,
+			convert,
+			exit,
+			interval,
+            counter,
+            imagesLoaded = false;
+
+		messages.optionsParsed = 'Canvas.options.parsed';
+		messages.callbackParsed = 'Canvas.cb.parsed';
+
+		window.optionsParsed = false;
+		window.callbackParsed = false;
+
+		page.onConsoleMessage = function (msg) {
+			console.log(msg);
+
+			/*
+			 * Ugly hack, but only way to get messages out of the 'page.evaluate()'
+			 * sandbox. If any, please contribute with improvements on this!
+			 */
+
+			/* to check options or callback are properly parsed */
+			if (msg === messages.optionsParsed) {
+				window.optionsParsed = true;
+			}
+
+			if (msg === messages.callbackParsed) {
+				window.callbackParsed = true;
+			}
+		};
+
+		page.onAlert = function (msg) {
+			console.log(msg);
+		};
+
+
+		exit = function (result) {
+			if (serverMode) {
+				//Calling page.close(), may stop the increasing heap allocation
+				page.close();
+			}
+			exitCallback(result);
+		};
+
+		loadChart = function( string_in, outputType ) {
+
+			try {
+
+				var container, htmlout;
+
+				$(document.body).css('margin', '0px');
+
+				$(document.body).css('backgroundColor', 'white');
+
+				container = $('<div>').appendTo(document.body);
+				container.attr('id', 'chartContainer' );
+				// var sizing = 'width: ' + width + 'px;';
+				// $container.attr('style', sizing );
+				//console.log(" json_in: " + JSON.parse(json_in) );
+				var json_in = JSON.parse(string_in);
+				//json_in = JSON.parse(json_in);
+				json_in["animationEnabled"] = false;
+
+				//console.log ("just before canvas rendering");
+
+				var chartTest = new CanvasJS.Chart("chartContainer", json_in );
+				console.log ("complete the object create");
+
+				var rs = chartTest.render();
+				console.log ("completed the rendering");
+
+				var htmlout = $('.canvasjs-chart-canvas')[0];
+				//var imageData = htmlout.toDataURL(outType, 0.92 );
+				var imageData = htmlout.toDataURL('image/'+outputType, 0.92 );
+			} catch (e) {
+				console.log('ERROR: Cannot create CanvasJS object.');
+				console.log('Error message: ' + e.number + " - " + e.message)
+				return { html: "<p>Error output</p>" };
+			}
+			return {
+				html: imageData
+			};
+		};
+
+
+		if (params.length < 1) {
+			exit("Error: Insufficient parameters");
+		} else {
+			input = params.infile;
+			output = params.outfile;
+			console.log("input: " + input);
+			console.log("output: " + output);
+
+			if (output !== undefined) {
+				outType = pick(output.split('.').pop(),'png');
+			} else {
+				outType = pick(params.type,'png');
+			}
+
+			constr = pick(params.constr, 'Chart');
+			callback = params.callback;
+			width = params.width;
+
+			if (input === undefined || input.length === 0) {
+				exit('Error: Insuficient or wrong parameters for rendering');
+			}
+
+			page.open('about:blank', function (status) {
+				var svg,
+					globalOptions = params.globaloptions,
+					dataOptions = params.dataoptions,
+					customCode = 'function customCode(options) {\n' + params.customcode + '}\n',
+					jsfile;
+
+				// load necessary libraries
+				for (jsfile in config.files) {
+					if (config.files.hasOwnProperty(jsfile)) {
+						page.injectJs(config.files[jsfile]);
+						//console.log("injecting: " + config.files[jsfile] );
+					}
+				}
+
+				var rs = page.evaluate(loadChart, input, outType );
+
+				try {
+					var result = rs["html"].split(",")
+					var result_blob = window.atob(result[1])
+					var imageFile = fs.open(params.outfile, "wb");
+					imageFile.write(result_blob);
+					imageFile.close();
+				} catch (e) {
+					console.log("error evaluating document object. error: " + e.message);
+				}
+
+				// return the tmp file name and path to the calling process
+				exit(params.outfile)
+
+			});
+		}
+	};
+
+	startServer = function (host, port) {
+		var server = require('webserver').create();
+
+		server.listen(host + ':' + port,
+			function (request, response) {
+				var jsonStr = request.postRaw || request.post,
+					params,
+					msg;
+				try {
+					params = JSON.parse(jsonStr);
+					if (params.status) {
+						// for server health validation
+						response.statusCode = 200;
+						response.write('OK');
+						response.close();
+					} else {
+						render(params, function (result) {
+							response.statusCode = 200;
+							response.write(result);
+							response.close();
+						});
+					}
+				} catch (e) {
+					msg = "Failed rendering: \n" + e;
+					response.statusCode = 500;
+					response.setHeader('Content-Type', 'text/plain');
+					response.setHeader('Content-Length', msg.length);
+					response.write(msg);
+					response.close();
+				}
+			}); // end server.listen
+
+		// switch to serverMode
+		serverMode = true;
+
+		console.log("OK, PhantomJS is ready.");
+	};
+
+	args = mapCLArguments();
+
+	//console.log("made it past the args mapper")
+	//console.log("arguments: " + JSON.stringify(args));
+	// set tmpDir, for output temporary files.
+	if (args.tmpdir === undefined) {
+		config.tmpDir = fs.workingDirectory + '/tmp';
+	} else {
+		config.tmpDir = args.tmpdir;
+	}
+
+	// exists tmpDir and is it writable?
+	if (!fs.exists(config.tmpDir)) {
+		try{
+			fs.makeDirectory(config.tmpDir);
+		} catch (e) {
+			console.log('ERROR: Cannot create temp directory for ' + config.tmpDir);
+		}
+	}
+
+
+	if (args.host !== undefined && args.port !== undefined) {
+		startServer(args.host, args.port);
+	} else {
+		// presume commandline usage
+		//console.log("calling the renderer");
+		render(args, function (msg) {
+			console.log(msg);
+			phantom.exit();
+		});
+	}
+}());