haplo 2.1.0-java

data/lib/plugin_tool.rb

@@ -0,0 +1,197 @@
+
+def end_on_error(err)
+  puts err
+  exit 1
+end
+
+File.open("#{File.dirname(__FILE__)}/version.txt") do |f|
+  puts "Haplo Plugin Tool (#{f.read.chomp})"
+end
+
+PluginTool.try_load_custom
+
+PluginTool::LocalConfig.load
+
+# Commands not needing server
+LOCAL_ONLY_COMMANDS = {"license-key" => true, "pack" => true, "check" => true}
+
+# Plugin names
+plugin_names = []
+
+# Options for passing to plugin objects
+options = Struct.new(:output, :minimiser, :no_console, :show_system_audit, :args, :force, :server_substring).new
+
+# Parse arguments
+show_help = false
+opts = GetoptLong.new(
+  ['--help', '-h', GetoptLong::NO_ARGUMENT],
+  ['--plugin', '-p', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--server', '-s', GetoptLong::REQUIRED_ARGUMENT],
+  ['--force', GetoptLong::NO_ARGUMENT],
+  ['--output', GetoptLong::REQUIRED_ARGUMENT],
+  ['--no-console', '-n', GetoptLong::NO_ARGUMENT],
+  ['--show-system-audit', GetoptLong::NO_ARGUMENT],
+  ['--minimise', '--minimize', '-m', GetoptLong::NO_ARGUMENT]
+)
+option_output = nil
+opts.each do |opt, argument|
+  case opt
+  when '--help'
+    show_help = true
+  when '--plugin'
+    plugin_names = argument.split(',').map {|n| n.gsub(/[\/\\]+\z/,'')} # remove trailing dir separators
+  when '--server'
+    options.server_substring = argument
+  when '--output'
+    options.output = argument
+  when '--no-console'
+    options.no_console = true
+  when '--show-system-audit'
+    options.show_system_audit = true
+  when '--minimise', '--minimize'
+    options.minimiser = PluginTool::Minimiser.new
+  when '--force'
+    options.force = true
+  end
+end
+# Handle rest of command line -- first arg is the command, the rest are passed on
+PLUGIN_TOOL_COMMAND = (ARGV.shift || 'develop')
+options.args = ARGV
+
+automatic_plugin_exclusion = false
+
+# Help message?
+if show_help || PLUGIN_TOOL_COMMAND == 'help'
+  puts File.open("#{File.dirname(__FILE__)}/usage.txt") { |f| f.read }
+  exit 0
+end
+
+# Plugin names handling
+def find_all_plugins()
+  all_plugins = []
+  Dir.glob("**/plugin.json").each do |p|
+    if p =~ /\A([a-zA-Z0-9_]+)\/plugin\.json\z/
+      all_plugins << $1
+    end
+  end
+  all_plugins
+end
+
+if plugin_names.length == 1 && plugin_names[0] == 'ALL'
+  plugin_names = find_all_plugins()
+  automatic_plugin_exclusion = true
+end
+
+# Some commands don't require a server or plugin to be specified
+case PLUGIN_TOOL_COMMAND
+when 'new'
+  end_on_error "Plugin name not specified, use --plugin option." if plugin_names.empty?
+  end_on_error "Only one plugin name should be specified for new command" if plugin_names.length > 1
+  PluginTool.make_new_plugin(plugin_names.first)
+  exit 0
+when 'auth'
+  PluginTool.cmd_auth options
+  exit 0
+when 'server'
+  PluginTool.cmd_server options
+  exit 0
+end
+
+# Find a plugin if none was specified
+if plugin_names.empty?
+  all_plugins = find_all_plugins()
+  end_on_error "No plugin found" if all_plugins.length == 0
+  if all_plugins.length > 1
+    puts "Too many plugins in the current directory for automatic selection."
+    puts "Use -p plugin_name to specify. Eg:"
+    all_plugins.each do |name|
+      puts "  #{$0} -p #{name}"
+    end
+    exit 1
+  end
+  plugin_names = all_plugins
+end
+
+# Make plugin objects, start them, sort by order the server will load them
+plugins = plugin_names.map do |name|
+  PluginTool::Plugin.new(name, options)
+end
+plugins.each { |p| p.start }
+plugins.sort! do |a,b| 
+  pri_a = a.plugin_load_priority
+  pri_b = b.plugin_load_priority
+  (pri_a == pri_b) ? (a.name <=> b.name) : (pri_a <=> pri_b)
+end
+plugins.each { |p| p.print_banner }
+
+# Custom behaviour for this repo?
+PluginTool.custom_behaviour.start(plugins, PLUGIN_TOOL_COMMAND, options, LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND])
+
+# Special handling for some commands
+case PLUGIN_TOOL_COMMAND
+when 'pack'
+  end_on_error "Output directory not specified, use --output option." unless options.output != nil
+  require "#{File.dirname(__FILE__)}/packing.rb"
+when 'check'
+  PluginTool.check_plugins(plugins)
+  exit 0
+end
+
+# Set up server communications
+unless LOCAL_ONLY_COMMANDS[PLUGIN_TOOL_COMMAND]
+  PluginTool.setup_auth(options)
+  PluginTool.check_for_certificate_file
+
+  PluginTool.custom_behaviour.server_ready(plugins, PLUGIN_TOOL_COMMAND, options)
+
+  if automatic_plugin_exclusion
+    exclusions = PluginTool::LocalConfig.get_list("exclude")
+    plugins = plugins.select do |plugin|
+      if exclusions.include?(plugin.name)
+        puts "NOTICE: Excluded plugin #{plugin.name}"
+        false
+      else
+        true
+      end
+    end
+  end
+
+  plugins.each { |p| p.setup_for_server }
+end
+
+# Run the command
+plugins.each { |p| p.command(PLUGIN_TOOL_COMMAND) }
+
+# It this isn't the long-running develop command, stop now
+if PLUGIN_TOOL_COMMAND != 'develop'
+  exit 0
+end
+
+# Syntax checking in the background
+PluginTool.start_syntax_check
+
+# Notifications support (including console)
+PluginTool.start_notifications(options) unless options.no_console
+
+# Open watcher
+watcher = PluginTool.make_watcher(plugins.map { |p| p.plugin_dir })
+
+# Start plugins
+plugins.each { |p| p.develop_setup }
+
+# Upload changes
+first_run = true
+while(true)
+  puts "Scanning plugin files..."
+  plugins.each { |p| p.develop_scan_and_upload(first_run) }
+  PluginTool::Plugin.do_apply
+  PluginTool.finish_with_connection
+  puts "Waiting for changes..."
+  if first_run
+    puts "  Any changes you make to your local copy of the plugin will be automatically"
+    puts "  uploaded to the server."
+  end
+  first_run = false
+  watcher.wait(3600)
+end
+

data/lib/run.rb

@@ -0,0 +1,67 @@
+
+# Make sure we use a JRuby which has been tested
+PLUGIN_TOOL_JRUBY_REQUIREMENT = '9.0.4.0'
+PLUGIN_TOOL_JAVA_REQUIREMENT = '1.8'
+PLUGIN_TOOL_JAVA_REQUIREMENT_READABLE = "at least Java 8"
+
+unless defined? JRUBY_VERSION
+  puts "haplo-plugin can only run under JRuby"
+  exit 1
+end
+
+require 'rubygems'
+
+unless Gem::Dependency.new('', '>= '+PLUGIN_TOOL_JRUBY_REQUIREMENT).match?('', JRUBY_VERSION)
+  puts "haplo-plugin requires JRuby #{PLUGIN_TOOL_JRUBY_REQUIREMENT} or later, you have #{JRUBY_VERSION}"
+  exit 1
+end
+
+require 'java'
+
+unless Gem::Dependency.new('', '>= '+PLUGIN_TOOL_JAVA_REQUIREMENT).match?('', java.lang.System.getProperty("java.version").gsub(/[^0-9\.].+?\z/,''))
+  puts "haplo-plugin requires #{PLUGIN_TOOL_JAVA_REQUIREMENT_READABLE}"
+  exit 1
+end
+
+require 'digest/sha1'
+require 'net/http'
+require 'net/https'
+require 'getoptlong'
+require 'fileutils'
+require 'thread'
+
+gem 'json'
+require 'json'
+
+PLUGIN_TOOL_ROOT_DIR = File.expand_path(File.dirname(__FILE__)+'/..')
+
+JS_JAR = "#{PLUGIN_TOOL_ROOT_DIR}/lib/js.jar"
+unless File.exists? JS_JAR
+  puts "Can't find JavaScript interpreter .jar file"
+  exit 1
+end
+require JS_JAR
+
+TEMPLATES_JAR = "#{PLUGIN_TOOL_ROOT_DIR}/lib/haplo-templates.jar"
+unless File.exists? TEMPLATES_JAR
+  puts "Can't find Haplo Templates .jar file"
+  exit 1
+end
+require TEMPLATES_JAR
+
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/hmac.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/local_config.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/manifest.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/auth.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/server.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/schema_requirements.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/syntax_checking.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/notifications.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/plugin.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/new_plugin.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/misc.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/watchers.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/minimise.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/check.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/custom.rb"
+require "#{PLUGIN_TOOL_ROOT_DIR}/lib/plugin_tool.rb"

data/lib/schema_requirements.rb

@@ -0,0 +1,63 @@
+
+module PluginTool
+
+  class SchemaRequirements
+    IGNORE_LINE = /\A\s*(\#.+)?\z/m # comment or blank line
+    OBJECT_FORMAT = /\A(OPTIONAL )?(?<kind>\S+)\s+(?<code>[a-zA-Z0-9_:-]+)\s*(as\s+(?<name>[a-zA-Z0-9_]+))?\s*\z/m
+
+    SCHEMA_LOCALS = {
+      "type" => "T",
+      "attribute" => "A",
+      "aliased-attribute" => "AA",
+      "qualifier" => "Q",
+      "label" => "Label",
+      "group" => "Group"
+    }
+
+    def initialize(filename)
+      # Define the special attributes by default
+      @schema_names = {"A" => {
+        "Parent" => true,
+        "Type" => true,
+        "Title" => true
+      }}
+      return unless File.exist?(filename)
+      File.open(filename) do |file|
+        file.each do |line|
+          if (line !~ IGNORE_LINE) && (match = OBJECT_FORMAT.match(line))
+            kind = SCHEMA_LOCALS[match[:kind]] || 'UNUSED'
+            @schema_names[kind] ||= {}
+            name = match[:name]
+            if name && !name.empty?
+              @schema_names[kind][name] = true
+            end
+          end
+        end
+      end
+      @schema_names.delete('UNUSED')
+    end
+
+    def locals
+      @schema_names.keys.dup
+    end
+
+    FIND_USE_REGEXP = Regexp.new("\\b(#{SCHEMA_LOCALS.values.join('|')})\\.([a-zA-Z0-9]+)\\b")
+
+    def report_usage(js)
+      report = []
+      js.split(/\r?\n/).each_with_index do |line, index|
+        line.scan(FIND_USE_REGEXP) do
+          kind = $1
+          name = $2
+          lookup = @schema_names[kind]
+          unless lookup && lookup.has_key?(name)
+            report << "line #{index+1}: Schema name #{kind}.#{name} isn't declared in requirements.schema\n\n"
+          end
+        end
+      end
+      report.empty? ? nil : report.join
+    end
+  end
+
+end
+

data/lib/server.rb

@@ -0,0 +1,143 @@
+
+module PluginTool
+
+  def self.set_server(hostname, port, key)
+    @@server_hostname = hostname
+    @@server_port = port
+    @@server_key = key
+  end
+
+  def self.get_server_hostname
+    @@server_hostname
+  end
+
+  def self.check_for_certificate_file
+    @@server_ca = nil
+    hostname_parts = (@@server_hostname || '').split('.')
+    search_list = (0..hostname_parts.length).map do |n|
+      filename = "server"
+      search_parts = hostname_parts[n..hostname_parts.length]
+      filename << '.' unless search_parts.empty?
+      filename << search_parts.join('.')
+      filename << ".crt"
+    end
+    @@server_ca = search_list.find { |f| File.file?(f) }
+    if @@server_ca
+      puts "NOTICE: Using alternative CAs for SSL from #{@@server_ca}"
+    else
+      # Use build in certificate bundle
+      @@server_ca = "#{File.dirname(__FILE__)}/CertificateBundle.pem"
+    end
+  end
+
+  def self.make_http_connection
+    http = Net::HTTP.new(@@server_hostname, @@server_port)
+    ssl_ca = OpenSSL::X509::Store.new
+    unless ssl_ca.respond_to? :add_file
+      puts
+      puts "jruby-openssl gem is not installed or bouncy castle crypto not available on CLASSPATH."
+      puts "See installation instructions."
+      puts
+      exit 1
+    end
+    ssl_ca.add_file(@@server_ca)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.cert_store = ssl_ca
+    http.start
+    http
+  end
+
+  @@http = nil
+  def self.get_http
+    @@http ||= make_http_connection
+  end
+  
+  def self.finish_with_connection
+    if @@http != nil
+      @@http.finish
+      @@http = nil
+    end
+  end
+
+  def self.setup_request(req)
+    req['User-Agent'] = 'plugin-tool'
+    req['X-ONEIS-Key'] = @@server_key if @@server_key
+  end
+
+  def self.get(path)
+    http = get_http
+    request = Net::HTTP::Get.new(path)
+    setup_request(request)
+    http.request(request).body
+  end
+  
+  def self.get_with_json_response(path)
+    report_errors_from_server(JSON.parse(get(path)))
+  end
+  
+  def self.post(path, params = nil, files = nil)
+    http = get_http
+    request = Net::HTTP::Post.new(path)
+    setup_request(request)
+    if files == nil
+      request.set_form_data(params) if params != nil
+    else
+      boundary = "----------XnJLe9ZIbbGUYtzPQJ16u1"
+      request["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+      body = ''
+      if params != nil
+        params.each do |key,value|
+        body << <<-EOF
+--#{boundary}\r
+Content-Disposition: form-data; name="#{key}"\r
+\r
+#{value}\r
+EOF
+        end
+      end
+      files.each do |key,info|
+        pathname, data = info
+        body << <<-EOF
+--#{boundary}\r
+Content-Disposition: form-data; name="#{key}"; filename="#{pathname}"\r
+Content-Type: application/octet-stream\r
+Content-Length: #{data.length}\r
+\r
+#{data}\r
+EOF
+      end
+      body << "--#{boundary}--\r"
+      request.body = body
+    end
+    http.request(request).body
+  end
+
+  def self.post_with_json_response(path, params = nil, files = nil)
+    report_errors_from_server(JSON.parse(post(path, params, files)))
+  end
+  
+  def self.report_errors_from_server(r)
+    unless r.kind_of? Hash
+      r = {
+        "result" => 'error',
+        "protocol_error" => true,
+        "message" => "Unknown error. Either the server is not enabled for development, or the credentials in #{SERVER_INFO} are not valid."
+      }
+    end
+    if r["result"] != 'success' && r.has_key?("message")
+      puts "\n\n**************************************************************"
+      puts "                   ERROR REPORTED BY SERVER"
+      puts "**************************************************************\n\n"
+      puts r["message"]
+      puts "\n**************************************************************\n\n"
+      beep
+    end
+    r
+  end
+
+  def self.get_application_info
+    @@server_application_info ||= JSON.parse(get("/api/development-plugin-loader/application-info"))
+  end
+
+end